Write the domain's records with a kept key
Write the domain's records with a kept key: CustomDomain™ API reference in the provider accounts group. Covers parameters, request body and responses.
Writes the connection's records with one of the kept keys GET /connections/{id}/saved-access answers for it (account_id), and links the key to the domain, so later repairs and the removal use it. A key offered with ready: false takes the domain's zone into its scope once the write worked (provider_account.domain_added in the audit log). An account the resolver does not answer for this domain and caller is 409 saved_access_not_usable, and so is a key at another provider than the one a live or propagating domain's DNS is at, or a key whose scope does not hold such a domain yet (such a domain is linked without a write, and a scope widens only after a write). A write that fails links nothing and leaves the key's scope as it was, and records the failure on the domain (its error_code and error_message): 502 saved_access_write_failed, with the provider's words. A domain kept by an end user's own sign in key is left as it is (409).
Authorization
apiKey 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
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/connections/string:use-saved-access" \ -H "Content-Type: application/json" \ -d '{ "account_id": "string" }'{ "result": { "domain": "string", "connection_id": "string", "status": "connected", "message": "string" }, "account": { "id": "string", "kind": "api_key", "provider": "string", "provider_name": "string", "label": "string", "access": "continuous", "scope": "all", "domains": [ "string" ], "credential_held": true, "status": "active", "last_error": "string", "created_by": "string", "last_used_at": "2019-08-24T14:15:22Z", "expires_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "connections": [ { "id": "string", "application_id": "string", "domain": "string", "status": "string" } ], "uses": [ "string" ], "can_manage": true, "application_id": "string", "origin": "browser_agent", "agent_key": { "name": "string", "scopes": [ "string" ], "account": "string", "session_id": "string", "verified_at": "2019-08-24T14:15:22Z", "expires_at": "2019-08-24T14:15:22Z", "notice": "d30", "reconnect_reason": "expiring", "reconnect_sent_at": "2019-08-24T14:15:22Z", "renewed_at": "2019-08-24T14:15:22Z", "old_key": "revoke_by_hand", "revoke_url": "http://example.com", "rights": [ "transfer" ] }, "owner_kind": "workspace", "end_user_ref": "string", "account_ref": "string" }}{ "code": "string", "title": "string", "details": "string"}{ "code": "string", "title": "string", "details": "string"}{ "code": "string", "title": "string", "details": "string"}{ "code": "string", "title": "string", "details": "string"}{ "code": "string", "title": "string", "details": "string"}{ "code": "string", "title": "string", "details": "string"}