Custom Domain
API referenceConnections

Begin the OAuth-into-DNS-provider authorization for a connection

POST
/connections/{id}/oauth:start

Rail C (flagship). Returns the provider authorize URL (PKCE S256 + HMAC-signed single-use state). The widget opens it in a popup; the provider redirects back to /v1/connect/oauth/callback, which writes the connection's records with the one-time access token and never persists it.

Authorization

widgetJWT
AuthorizationBearer <token>

Short-lived widget JWT minted server-side via POST /v1/tokens. Scoped to one application (and optionally one domain).

In: header

Path Parameters

id*string

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

curl -X POST "https://example.com/connections/string/oauth:start" \  -H "Content-Type: application/json" \  -d '{    "return_origin": "string"  }'
{  "authorize_url": "http://example.com"}
{  "code": "string",  "title": "string",  "details": "string"}
{  "code": "string",  "title": "string",  "details": "string"}
{  "code": "string",  "title": "string",  "details": "string"}
{  "code": "string",  "title": "string",  "details": "string"}