Connections

Write a connection's records through the customer's provider (BYO token, used once)

Rail B (API-token apply). The scoped provider credential is used once to write the records and is never stored. The connection advances to propagating; the poller promotes it to live once the records appear in public DNS.

A widget JWT applies to its own application's connections (a domain-bound token to its own domain only). An API key applies to a connection of any application in its tenant; a member's key needs a role that operates apps (not viewer).

post/connections/{id}/apply

Request

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

Path parameters

idstring required

Request body

providerstring

DNS provider id; defaults to the detected provider.

zonestring

DNS zone the credential manages; defaults to the connection domain.

Example request

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

Response

Applied

Example response

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

Changes

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