Connections

What removing a domain would do with its DNS records

Read-only. Lists the records we added, what each one did to its name when we wrote it (created, added to a shared set, replaced, merged) and what it held before when we know, what a removal would do with each, whether that can happen automatically, needs one more sign-in or key, or only by hand, and the exact manual steps. Show it before asking the person to confirm. While a removal runs, removal_started_at is set. Once the domain is removed, it answers removed: true with result, what the removal did, to the callers that could have removed it: read this, not the connection's 404, to learn the outcome. An end user's widget token must be bound as for DELETE /connections/{id}.

get/connections/{id}/removal

Request

  • Base URL: https://api.customdomain.ai/v1
  • URL: https://api.customdomain.ai/v1/connections/{id}/removal
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

idstring required

Response

The removal plan, or the outcome of a finished removal

connection_idstring required
domainstring required
providerstring
provider_namestring
connected_viastring required

The rail that wrote the records (see Connection.write_rail), manual when none did, or unknown_api for an older connection written through a provider API.

access'kept' | 'one_time' | 'none' required

What access we hold now.

access_detailstring
record_removal'automatic' | 'partial' | 'reauthorize' | 'manual' | 'in_use' | 'not_needed' required

What choosing remove can do: automatic with the access we kept; partial (some automatically, the rest by hand: a Domain Connect revert cannot restore a replaced value, and the Route 53 access role cannot delete); reauthorize (one more sign-in or key, see reauthorize); manual (only by hand, see manual_steps); in_use (another connection still serves the domain, so the records stay); not_needed (nothing was added).

default_choice'remove' | 'keep' required

The choice to offer first: remove when it can run without the person (automatic or partial), keep otherwise. A DELETE without a records choice keeps its original behaviour instead (see DELETE /connections/{id}).

records_in_use_elsewhereboolean required
manual_stepsstring[] required

The exact steps to remove the records by hand, in order.

notesstring[]
teardownstring[] required

What always happens, whatever the choice.

removal_started_atstring date-time

Set while a removal of the domain is running.

removedboolean

True once the domain is removed: the connection is gone and result is what the removal did with its records.

removed_atstring date-time

Changes

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