Connections

Re-apply a managed connection's desired records (async one-click, no re-consent)

Managed mode only. Recomputes the connection's authoritative desired record set and writes any drift through the provider's async one-click API using the stored, encrypted grant (the provider API base pinned at onboarding), or, for a connection managed through a provider sign-in, through the provider's DNS API with the kept credential (a refresh token is rotated first when the access token has expired); the end user does not re-consent. On success the connection is re-verified and connection.records.updated is emitted. A failure emits connection.reapply.failed; if the provider reports the grant was revoked (401 kill-switch, or a refused refresh token) the grant is cleared and the connection is flagged for re-consent (a sign-in grant leaves error_code oauth_reconnect_needed).

A domain kept by a continuous provider account (and no kept grant) is re-applied with the account's key: the records CustomDomain™ wrote for the domain are written back and the receipt says via: provider_account. A domain whose records CustomDomain™ did not write is refused with 409, since re-applying would write records nobody put there. The same webhooks are sent.

A delegated agent token needs domains:connect.

post/connections/{id}:reapply

Request

  • Base URL: https://api.customdomain.ai/v1
  • URL: https://api.customdomain.ai/v1/connections/{id}:reapply
  • 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:connect)

Path parameters

idstring required

Response

Re-applied (records updated). NOTE: this is a re-apply RECEIPT, not a connection object; it carries connection_id rather than the connection's own id, and none of the other connection fields. Fetch GET /connections/{id} if you need the connection itself.

connection_idstring required

The connection the re-apply ran against (the {id} path parameter).

reappliedboolean required

Always true on a 200: the provider accepted the write for every template in the grant's bundle. Failures are reported as 409 (not managed / grant revoked), 422 (a provider account's key or write refused), 503 (managed rail unavailable) or 500, never as reapplied: false.

via'provider_account'

provider_account when a continuous provider account's key wrote the records; omitted for a kept grant or a zone CustomDomain™ hosts.

Example response

{
  "records": [
    {
      "type": "CNAME"
    }
  ]
}

Changes

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