CustomDomain™ docs
Nameservers

The connection's latest nameserver migration

The connection's latest nameserver migration: CustomDomain™ API reference in the nameservers group. Covers parameters, request body, responses and error codes.

GET
/connections/{id}/nameservers

The newest nameserver migration started for the connection's domain: its state, the old and new nameservers, what the registry lists now, what it waits on (waiting_for) and what a person does next (next_step). Poll it while the state is not active, failed or rolled_back. 404 when no migration was started for this connection. Authorized like the other connection routes: an API key within the tenant, or a widget token of the connection's own application. A delegated agent token needs domains:read.

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

curl -X GET "https://example.com/connections/string/nameservers"
{  "id": "string",  "connection_id": "string",  "zone": "string",  "state": "pending",  "path": "api",  "target": "managed",  "dns_host": "string",  "provider": "string",  "registrar": {    "name": "string",    "provider": "string",    "iana_id": 0,    "url": "string",    "source": "rdap"  },  "old_dns_host": "string",  "old_nameservers": [    "string"  ],  "new_nameservers": [    "string"  ],  "observed_nameservers": [    "string"  ],  "waiting_for": "zone_ready",  "next_step": "string",  "failure_code": "zone_copy_failed",  "failure_detail": "string",  "records_copied": 0,  "email_records": 0,  "email_kinds": [    "mx"  ],  "copy_source": "api",  "copy_warnings": [    "string"  ],  "copy_reviewed_at": "2019-08-24T14:15:22Z",  "ds_present": true,  "ds_removed_at": "2019-08-24T14:15:22Z",  "ds_cleared_at": "2019-08-24T14:15:22Z",  "can_rollback": true,  "rollback_path": "api",  "rollback_targets": [    "previous"  ],  "rollback_default": "previous",  "rollback_target": "previous",  "rollback_set_at": "2019-08-24T14:15:22Z",  "old_dns_serves": true,  "consent": {    "id": "string",    "version": "string",    "at": "2019-08-24T14:15:22Z"  },  "actor": "end_user",  "created_at": "2019-08-24T14:15:22Z",  "set_at": "2019-08-24T14:15:22Z",  "active_at": "2019-08-24T14:15:22Z",  "failed_at": "2019-08-24T14:15:22Z",  "rolled_back_at": "2019-08-24T14:15:22Z",  "drifted_at": "2019-08-24T14:15:22Z",  "checked_at": "2019-08-24T14:15:22Z",  "next_check_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}
{  "code": "string",  "title": "string",  "details": "string"}
{  "code": "string",  "title": "string",  "details": "string"}
{  "code": "string",  "title": "string",  "details": "string"}
{  "code": "string",  "title": "string",  "details": "string"}