CustomDomain Docs
ReferenceAPI referenceProvider accounts

The domains the account's key can reach

The domains the account's key can reach: CustomDomain™ API reference in the provider accounts group. Covers parameters, request body, responses and error codes.

POST
/provider-accounts/{id}/zones

Lists the provider's domains with the kept key. listed is false for a provider that cannot list them. A refused key flags the account needs_reconnect. It takes an admin, an owner or the member who connected the account (can_manage), as connecting domains with it does; anyone else gets 403. A one time account past its hour answers 409, and its key is deleted then if the hourly cleanup has not deleted it yet. A key an end user's secure sign-in made in the widget answers 403: it never lists the domains of the end user's account. The list is one read of the workspace's hourly budget of reach checks: once it is spent the call answers 429 reach_quota with Retry-After and asks the provider nothing.

AuthorizationBearer <token>

Long-lived tenant API key, cd_live_… (production) or cd_test_… (staging, development), stored hashed. Keys created before the switch to cd_ start with sk_live_… / sk_test_… and are still accepted. Scoped to the owning application's tenant.

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/provider-accounts/string/zones"
{  "zones": [    "string"  ],  "listed": true,  "message": "string"}
{  "code": "account_not_verifiable",  "title": "string",  "details": "string",  "challenge": {    "value": "string",    "bits": 1,    "expires_at": "2019-08-24T14:15:22Z"  }}
{  "code": "account_not_verifiable",  "title": "string",  "details": "string",  "challenge": {    "value": "string",    "bits": 1,    "expires_at": "2019-08-24T14:15:22Z"  }}
{  "code": "account_not_verifiable",  "title": "string",  "details": "string",  "challenge": {    "value": "string",    "bits": 1,    "expires_at": "2019-08-24T14:15:22Z"  }}
{  "code": "account_not_verifiable",  "title": "string",  "details": "string",  "challenge": {    "value": "string",    "bits": 1,    "expires_at": "2019-08-24T14:15:22Z"  }}
Empty
{  "code": "reach_quota",  "title": "Too many checks at DNS providers this hour.",  "details": "this workspace has made as many checks of its keys at DNS providers as it may in an hour; nothing was changed, try again in about 40 minutes"}
{  "code": "account_not_verifiable",  "title": "string",  "details": "string",  "challenge": {    "value": "string",    "bits": 1,    "expires_at": "2019-08-24T14:15:22Z"  }}