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

Download a portable Compliance backup

Downloads the version 1 workspace backup. Private file bodies are embedded as data URLs. The export allows 8 MB of JSON, up to 24 attachment references, and 4 MB of file bytes. A current token and durable audit entry are required before the backup is returned.

GET/api/v1/compliance/backup

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:backups:read. Scopes are independent.

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.

Examples write successful response bytes to standard output. Redirect the output to a private file and verify the HTTP status before using it.

Authentication

Dashio developer token (HTTP Bearer) API authentication guide

Path parameters

None documented.

Query parameters

None documented.

Header parameters

None documented.

Request body

No content type declared

No request body schema is documented.

Responses

Headers on every response

X-Request-Idstring (uuid)Optional

Server-generated ID to include in a support request.

200

The audited portable backup.

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.

Content-DispositionstringRequired

Attachment filename for the portable JSON backup.

application/json

schemaVersionintegerRequired

Required value: 1.

exportedAtstring (date-time)Required

No field description supplied.

collectionsobjectRequired

No field description supplied.

400

The operation does not accept query parameters.

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.

409

The workspace revision changed while the backup was prepared. Retry to download the current version.

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.

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?