Developers
Domains3

Retrieve a domain

GET/account/domains/{domain_id}

Retrieves the account's custom domain by its public ID.

An account has at most one custom domain, and its ID is fixed for the account. Use the ID returned by the list operation. Any other ID returns 404 Not Found.

Authorization

AuthorizationBearer <token>

Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.

In: header

Path Parameters

domain_id*string

Public ID of the domain, prefixed with dom_.

Header Parameters

X-Client-Request-Id?string

Optional client-generated identifier of the request, up to 64 characters from [A-Za-z0-9._-]. Echoed back in the response and recorded in the request log; it never replaces the server-generated X-Request-Id.

Lengthlength <= 64

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/account/domains/string"
{  "data": {    "dns": {      "name": "string",      "target": "string",      "type": "CNAME"    },    "hostname": "string",    "id": "string",    "object": "domain",    "processing": true,    "status": "not_configured",    "updated_at": "2019-08-24T14:15:22Z",    "verifiable": true  }}

List domains GET

Lists the custom domains configured for the account. An account has at most one custom domain, so the collection contains zero or one item. Domain status reflects the last state recorded by Cademí and is not checked live. Requires the `domains.read` permission.

Retrieve a domain certificate GET

Returns the TLS certificate status of the account's custom domain. The status reflects the last state recorded by Cademí and is not checked live with the certificate provider.