List DNS records
Returns stored DNS records for the single supported active zone of a domain belonging to the token’s Space. Use the returned nextCursor unchanged to continue.
/api/v1/domains/{domain}/recordsWorkspace 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 dns: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
domainstringRequiredRegistered domain in lowercase ASCII or punycode.
Query parameters
limitintegerOptionalMaximum number of DNS records to return. Minimum: 1. Maximum: 100.
cursorstring (uuid)OptionalThe nextCursor from the previous page.
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)OptionalServer-generated ID to include in a support request.
200
DNS records page.
Response headers
RateLimit-LimitintegerOptionalPer-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-RemainingintegerOptionalRequests 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-ResetintegerOptionalUnix timestamp in seconds when the reported gateway quota resets. Present when the request reaches the authenticated gateway. Minimum: 0.
application/json
recordsarray of objectRequiredNo field description supplied.
paginationobjectRequiredNo field description supplied.
400
Invalid domain, pagination, or query parameter.
application/json
statusCodeintegerRequiredMinimum: 400. Maximum: 599.
statusMessagestringOptionalA safe explanation suitable for display.
dataobjectRequiredNo field description supplied.
401
Developer token is missing, expired, revoked, or invalid.
Response headers
WWW-AuthenticatestringOptionalBearer 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 dns:read or the domain is restricted.
application/json
Uses the same response body schema as HTTP 400.
404
The domain is unavailable in the token’s Space.
application/json
Uses the same response body schema as HTTP 400.
409
The domain lacks one supported active DNS zone.
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-LimitintegerOptionalPer-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-RemainingintegerOptionalRequests 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-ResetintegerOptionalUnix timestamp in seconds when the reported gateway quota resets. Present when the request reaches the authenticated gateway. Minimum: 0.
Retry-AfterintegerOptionalSeconds 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 DNS data is temporarily unavailable.
application/json
Uses the same response body schema as HTTP 400.
Was this helpful?