Connections

Remove a domain, optionally authorizing the record removal once with a key

The same removal as DELETE /connections/{id} with a body. Send credential (a DNS provider API key) to authorize removing the records once when we did not keep the access that added them; it is used for this removal and never stored. The zone must show at least one of our records with that key, or the outcome lists the manual steps (the key may belong to another account). Answers 200 with the outcome; an end user's widget token must be bound as for DELETE /connections/{id}.

A delegated agent token needs domains:disconnect and must send confirm, as for DELETE /connections/{id}.

post/connections/{id}:disconnect

Request

  • Base URL: https://api.customdomain.ai/v1
  • URL: https://api.customdomain.ai/v1/connections/{id}:disconnect
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://api.customdomain.ai/oauth/agent/authorize, token URL https://api.customdomain.ai/oauth/agent/token, scopes: domains:disconnect)

Path parameters

idstring required

Query parameters

confirmstring
Example:shop.acme.com

Required of a delegated agent token: the domain it is removing, as written on the connection (case, scheme, path and a trailing dot do not matter). Without it the answer is 400 confirmation_required; with another domain, 409 confirmation_mismatch. Nothing is removed either way. Other credentials ignore it.

Request body

records'remove' | 'keep'
providerstring

DNS provider id; defaults to the connection's provider.

zonestring

The DNS zone; found from the key when omitted.

Response

Removed; what happened to the records

connection_idstring required
domainstring required
disconnectedboolean required
serving'stopped' required
certificate'removed' | 'kept' | 'none' required
monitoring'stopped' required

Changes

No recorded changes to this operation across all 1 revision of this API.