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

Apply a Compliance backup import

Imports missing record IDs at the current workspace revision. A conflicting saved record prevents the import. Repeating an applied backup returns an idempotent receipt. Importing or linking files requires compliance:evidence:write. New file imports allow up to 20 files and 4 MB of file bytes. Creating an approved Trust Center disclosure requires the Portal. The JSON request is limited to 8 MB.

POST/api/v1/compliance/import

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:imports:write. Scopes are independent.

Conditional token scope compliance:evidence:write. Required when the import uploads or adds a link to an attachment.

This operation uses 12 credits from a shared budget of 60 credits per token and 300 per Space each UTC minute. The compliance bulk group shares 15 requests per token and 40 per Space each UTC hour.

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.

Set DASHIO_REQUEST_JSON to the path of a prepared JSON request. The examples send that file as written.

Authentication

Dashio developer token (HTTP Bearer) API authentication guide

Download the complete schema as OpenAPI JSON or OpenAPI YAML.

Path parameters

None documented.

Query parameters

None documented.

Header parameters

None documented.

Request body

application/json · Required

backupobjectRequired

No field description supplied.

revisionintegerRequired

Minimum: 0. Maximum: 9007199254740991.

Responses

Headers on every response

X-Request-Idstring (uuid)Optional

Server-generated ID to include in a support request.

200

Audited import receipt. The response does not contain workspace records.

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

revisionintegerRequired

Minimum: 0. Maximum: 9007199254740991.

alreadyImportedbooleanRequired

True if this backup was previously applied to the same Space.

400

The JSON envelope, backup data, revision, or query parameters are invalid.

application/json

statusCodeintegerRequired

Minimum: 400. Maximum: 599.

statusMessagestringOptional

A safe explanation suitable for display.

dataobjectRequired

No field description supplied.

401

A valid Developer Bearer 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

An active Compliance subscription or eligible grant is required.

application/json

Uses the same response body schema as HTTP 400.

403

Current Space access, required token scopes and applicable plan limits are required.

application/json

Uses the same response body schema as HTTP 400.

404

Compliance is unavailable.

application/json

Uses the same response body schema as HTTP 400.

408

The request body did not arrive before its deadline.

application/json

Uses the same response body schema as HTTP 400.

409

The workspace revision changed or the import contains conflicting record IDs.

application/json

Uses the same response body schema as HTTP 400.

413

The request or workspace exceeds the operation’s backup limits.

application/json

Uses the same response body schema as HTTP 400.

415

The request must use an application/json content type.

application/json

Uses the same response body schema as HTTP 400.

422

This backup exceeds API file import limits or would create an approved Trust Center disclosure. Use the Compliance Portal to restore it.

application/json

Uses the same response body schema as HTTP 400.

429

The token or Space request limit has been reached. 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 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 backup operation or its required audit could not be confirmed. Retry after a short delay.

application/json

Uses the same response body schema as HTTP 400.

Was this helpful?