Developer Compliance1.0.0-beta.1

Preview a Compliance backup import

Validates a portable version 1 backup and compares it with the token’s Space. Returns counts, the current revision, merge conflicts and any contents requiring Portal restoration. The JSON request is limited to 8 MB.

POST/api/v1/compliance/import/preview

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:preview. 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.

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.

Request & response examples

Copy an example in your preferred language.

request.sh

: "${DASHIO_API_TOKEN:?Set DASHIO_API_TOKEN before running this example}"
: "${DASHIO_REQUEST_JSON:?Set DASHIO_REQUEST_JSON before running this example}"

curl --fail-with-body --include --silent --show-error --connect-timeout 10 --max-time 30 \
  --request POST 'https://app.dashio.net/api/v1/compliance/import/preview' \
  --header "Authorization: Bearer $DASHIO_API_TOKEN" \
  --header 'Content-Type: application/json' \
  --data-binary @"$DASHIO_REQUEST_JSON"

Replace URL parameters, credentials, and schema placeholders before running. No request is sent by this page.

Schema-generated example; not a captured response.

{
  "counts": {
    "compliance:contacts": 0,
    "compliance:controls": 0,
    "compliance:evidence": 0,
    "compliance:statements-of-applicability": 0,
    "compliance:questionnaires": 0,
    "compliance:questionnaire-answers": 0,
    "compliance:risks": 0,
    "compliance:suppliers": 0,
    "compliance:incidents": 0,
    "compliance:training": 0,
    "compliance:training-courses": 0,
    "compliance:training-policies": 0,
    "compliance:trust:certifications": 0,
    "compliance:trust:documents": 0,
    "compliance:trust:subprocessors": 0,
    "compliance:trust:access-requests": 0
  },
  "pausedSchedules": 0,
  "conflicts": 0,
  "revision": 0,
  "commitSupported": false,
  "commitBlockers": [
    "attachment-limit"
  ],
  "additionalRequiredScopes": [
    "compliance:evidence:write"
  ]
}

Run examples on a trusted server. Configure the environment variables and replace URL or schema placeholders. For a write, reuse its saved idempotency key only when retrying the identical request.

Responses

Headers on every response

X-Request-Idstring (uuid)Optional: Server-generated ID to include in a support request.

200

Read-only preview. No records or attachment content are returned.

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

countsobjectRequired: No field description supplied.
pausedSchedulesintegerRequired: Number of non-manual supplier schedules in the backup. Newly imported schedules stay paused. Minimum: 0. Maximum: 2000.
conflictsintegerRequired: Number of incoming IDs that differ from saved records. Minimum: 0.
revisionintegerRequired: Minimum: 0. Maximum: 9007199254740991.
commitSupportedbooleanRequired: True when the contents are eligible for Developer import. Revision, conflicts and plan limits still apply.
commitBlockersarray of stringRequired: Content that requires the Compliance Portal to restore. Maximum items: 2.
additionalRequiredScopesarray of stringRequired: Additional permission required to commit this backup when it adds or links a file. Maximum items: 1.

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.