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}.
Short-lived widget JWT minted server-side via POST /v1/tokens. Scoped to one application (and optionally one domain).
In: header
Path Parameters
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/connections/string/removal"{ "connection_id": "string", "domain": "string", "provider": "string", "provider_name": "string", "connected_via": "string", "access": "kept", "access_detail": "string", "record_removal": "automatic", "default_choice": "remove", "reauthorize": { "methods": [ "sign_in" ], "provider": "string", "flow": "string", "regions": [ "string" ] }, "records_in_use_elsewhere": true, "records": [ { "type": "string", "host": "string", "name": "string", "value": "string", "ttl": 0, "priority": 0, "change": "created", "action": "delete", "prior": [ { "type": "string", "value": "string", "ttl": 0, "priority": 0 } ], "prior_source": "provider", "note": "string" } ], "manual_steps": [ "string" ], "notes": [ "string" ], "teardown": [ "string" ], "removal_started_at": "2019-08-24T14:15:22Z", "removed": true, "removed_at": "2019-08-24T14:15:22Z", "result": { "choice": "remove", "outcome": "removed", "via": "string", "removed": [ { "type": "string", "name": "string", "value": "string", "note": "string" } ], "restored": [ { "type": "string", "name": "string", "value": "string", "note": "string" } ], "left_in_place": [ { "type": "string", "name": "string", "value": "string", "note": "string" } ], "failed": [ { "type": "string", "name": "string", "value": "string", "note": "string" } ], "manual_steps": [ "string" ] }}{ "code": "string", "title": "string", "details": "string"}{ "code": "string", "title": "string", "details": "string"}{ "code": "string", "title": "string", "details": "string"}