Connect Domain
Connect flow

Overview

The create → verify → live pipeline and where each API call fits.

Connecting a domain is a pipeline of API calls layered on top of the connection state machine:

  1. Create a connection — POST /v1/connections starts the process: it returns the desired DNS records and (unless a delegated credential auto-writes them) an ownership challenge.
  2. Verify ownership — the customer publishes the ownership TXT record; POST /v1/connections/{id}/verify confirms it (or the background worker does, automatically).
  3. Go live — POST /v1/connections/{id}/records:check reports per-record propagation and flips the connection to live once everything resolves, which is also when the edge issues the TLS certificate on the next handshake.
  4. Offboard — DELETE /v1/connections/{id} soft-deletes the connection when the customer disconnects their domain.

For the fastest path through all four steps with real curl commands, see the Quickstart. To let customers drive this flow themselves in a UI, see The widget SDK.

Widget tokens

Minting short-lived JWTs via POST /v1/tokens for one connect flow.

Create a connection

POST /v1/connections — idempotency, setup_type, and record overrides.