Connections

Supply the connection's desired DNS record set

Replaces the connection's desired record set with one the INTEGRATOR authored, for records that cannot be derived from the domain; the motivating case is Amazon SES email verification, whose three Easy-DKIM CNAMEs are minted per domain by SES. The supplied set then behaves exactly like ours: the OAuth rail writes it with the customer's provider credential, the widget renders it for manual setup, and the propagation poller verifies it before the connection goes live.

Server-to-server only (API key): a widget JWT lives in a browser and may not choose the records we write into a customer's zone. Hosts are relative to the connection (@, _dmarc, sel._domainkey) and must resolve inside its zone. The Domain Connect rail refuses a connection carrying a supplied set, because that rail applies OUR published templates at the provider, so it cannot write records it did not author.

put/connections/{id}/records

Request

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

Path parameters

idstring required

Request body

Example request

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

Response

The connection's new desired record set

connection_idstring required
records_source'integrator' required

Example response

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

Changes

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