Create a Compliance control
Creates a saved control at the supplied workspace revision and returns a change receipt. Requires an active Compliance entitlement. A successful create advances the revision and records a Space audit event.
/api/v1/compliance/controlsWorkspace automation for approved Dashio products. Each token is scoped to one Space and independently granted operations. Requests spend shared minute credits, and selected operation groups also share hourly quotas.
Required token scope is compliance:controls:write. Scopes are independent.
This operation uses 3 credits from a shared budget of 60 credits per token and 300 per Space each UTC minute.
Run these examples on a trusted server with DASHIO_API_TOKEN configured. Use a private terminal when inspecting response data. Examples send one request with a bounded timeout and do not retry automatically.
Authentication
Dashio developer token (HTTP Bearer) API authentication guide
Path parameters
None documented.
Query parameters
None documented.
Header parameters
None documented.
Request body
application/json · Required
revisionintegerRequiredMinimum: 0. Maximum: 9007199254740991.
recordIdstringRequiredMinimum length: 2. Maximum length: 30. Pattern: ^[A-Z][A-Z0-9-]{1,29}$.
titlestringRequiredMinimum length: 1. Maximum length: 512.
descriptionstringRequiredMinimum length: 1. Maximum length: 8000.
ownerContactIdstringRequiredMinimum length: 1. Maximum length: 180.
frameworksarray of stringRequiredMinimum items: 1. Maximum items: 4.
statusstringRequiredAllowed values: "On track", "In review", "Needs attention".
dueDatestring (date)RequiredNo field description supplied.
Responses
Headers on every response
X-Request-Idstring (uuid)OptionalServer-generated ID to include in a support request.
201
Record change receipt and resulting workspace revision.
Response headers
RateLimit-LimitintegerOptionalPer-token capacity in the reported gateway window, expressed in requests of this operation. A shared Space budget also applies. Present when the request reaches the authenticated gateway. Minimum: 1.
RateLimit-RemainingintegerOptionalRequests of this operation remaining under the current token, Space and applicable operation-group quotas. Present when the request reaches the authenticated gateway. Minimum: 0.
RateLimit-ResetintegerOptionalUnix timestamp in seconds when the reported gateway quota resets. Present when the request reaches the authenticated gateway. Minimum: 0.
application/json
recordIdstringRequiredStable ID of the affected record.
revisionintegerRequiredMinimum: 0. Maximum: 9007199254740991.
changedbooleanRequiredWhether the workspace changed.
400
The record ID, revision, fields, or references are invalid.
application/json
statusCodeintegerRequiredMinimum: 400. Maximum: 599.
statusMessagestringOptionalA safe explanation suitable for display.
dataobjectRequiredNo field description supplied.
401
A valid developer token is required.
Response headers
WWW-AuthenticatestringOptionalBearer authentication challenge. A rejected token can include the invalid_token error.
application/json
Uses the same response body schema as HTTP 400.
402
The Space needs an active Compliance entitlement.
application/json
Uses the same response body schema as HTTP 400.
403
The token lacks the required scope or current Space access.
application/json
Uses the same response body schema as HTTP 400.
408
The request body did not arrive within the time limit.
application/json
Uses the same response body schema as HTTP 400.
409
The revision is stale, the record ID is in use, or a record limit was reached.
application/json
Uses the same response body schema as HTTP 400.
413
The request body exceeds 65,536 bytes.
application/json
Uses the same response body schema as HTTP 400.
429
The request budget was exhausted. Edge traffic limits can also return 429.
Response headers
RateLimit-LimitintegerOptionalPer-token capacity in the reported gateway window, expressed in requests of this operation. A shared Space budget also applies. Present when the request reaches the authenticated gateway. Minimum: 1.
RateLimit-RemainingintegerOptionalRequests of this operation remaining under the current token, Space and applicable operation-group quotas. Present when the request reaches the authenticated gateway. Minimum: 0.
RateLimit-ResetintegerOptionalUnix timestamp in seconds when the reported gateway quota resets. Present when the request reaches the authenticated gateway. Minimum: 0.
Retry-AfterintegerOptionalSeconds to wait before retrying, when the limiting policy supplies a retry time. Minimum: 1.
application/json
Uses the same response body schema as HTTP 400.
503
The change could not be confirmed. Read the current record before retrying.
application/json
Uses the same response body schema as HTTP 400.
Was this helpful?