Skip to main content
Developer Compliance1.0.0-beta.1

Update a Compliance risk

Sets the status or treatment of one saved risk in the token’s Space. Use the revision from a current risk page. A successful change advances the workspace revision and records a Space audit event. An unchanged request at the current revision returns changed=false.

PATCH/api/v1/compliance/risks/{riskId}

Workspace 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:risks: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

riskIdstringRequired

Stable saved risk ID, URL-encoded as one path segment.

Query parameters

None documented.

Header parameters

None documented.

Request body

application/json · Required

Provide at least one of these field sets (status or treatment).

revisionintegerRequired

Minimum: 0. Maximum: 9007199254740991.

statusstringOptional

Allowed values: "Open", "In progress", "In review", "Monitoring", "Resolved".

treatmentstringOptional

Allowed values: "Mitigate", "Transfer", "Accept", "Avoid".

Responses

Headers on every response

X-Request-Idstring (uuid)Optional

Server-generated ID to include in a support request.

200

Risk change receipt and its resulting workspace revision.

Response headers

RateLimit-LimitintegerOptional

Per-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-RemainingintegerOptional

Requests 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-ResetintegerOptional

Unix timestamp in seconds when the reported gateway quota resets. Present when the request reaches the authenticated gateway. Minimum: 0.

application/json

riskIdstringRequired

Stable saved risk ID.

revisionintegerRequired

Minimum: 0. Maximum: 9007199254740991.

changedbooleanRequired

Whether the requested status or treatment changed.

400

The risk ID, revision or change is invalid, or an unexpected query parameter was supplied.

application/json

statusCodeintegerRequired

Minimum: 400. Maximum: 599.

statusMessagestringOptional

A safe explanation suitable for display.

dataobjectRequired

No field description supplied.

401

A valid developer token is required.

Response headers

WWW-AuthenticatestringOptional

Bearer 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 write scope or current Space access.

application/json

Uses the same response body schema as HTTP 400.

404

The risk was not found in the token’s Space or Compliance is unavailable.

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 or the workspace revision limit was reached.

application/json

Uses the same response body schema as HTTP 400.

413

The request body exceeds 4,096 bytes.

application/json

Uses the same response body schema as HTTP 400.

415

The request body must be JSON.

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-LimitintegerOptional

Per-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-RemainingintegerOptional

Requests 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-ResetintegerOptional

Unix timestamp in seconds when the reported gateway quota resets. Present when the request reaches the authenticated gateway. Minimum: 0.

Retry-AfterintegerOptional

Seconds until the request can be retried. Minimum: 0.

application/json

Uses the same response body schema as HTTP 400.

503

The change could not be confirmed. Read the current risk before retrying.

application/json

Uses the same response body schema as HTTP 400.

Was this helpful?