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

Get domain security audit status

Polls the current state of a domain audit identified by a Developer API receipt from the token’s Space. This operation returns queue status and timestamps. Find the report and evidence in the Dashio portal.

GET/api/v1/domains/{domain}/security-audits/{auditId}

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

This operation uses 1 credit 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

domainstringRequired

Registered domain in lowercase ASCII or punycode.

Example"example.com"
auditIdstring (uuid)Required

Audit ID returned by the request operation.

Example"5714db63-7bba-4bf4-a46f-2f92e155d69a"

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

Current audit status.

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

auditobjectRequired

No field description supplied.

400

Invalid domain or audit ID.

application/json

statusCodeintegerRequired

Minimum: 400. Maximum: 599.

statusMessagestringOptional

A safe explanation suitable for display.

dataobjectRequired

No field description supplied.

401

Developer token is missing or invalid.

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.

403

The token lacks the required permission or current Space access changed.

application/json

Uses the same response body schema as HTTP 400.

404

The audit is unavailable for this domain and Space, or the Developer receipt expired.

application/json

Uses the same response body schema as HTTP 400.

429

The token or Space request budget is 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 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 API or audit state is temporarily unavailable.

application/json

Uses the same response body schema as HTTP 400.

Was this helpful?