API referenceConnections
Create a domain connection (idempotent per app + domain)
Starts connecting domain under the calling application and returns the connection plus its authoritative desired record set. Idempotent: if the app already has a non-failed connection for the domain, that existing connection is replayed with 200.
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
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/connections" \ -H "Content-Type: application/json" \ -d '{ "domain": "string" }'{ "id": "string", "application_id": "string", "domain": "string", "host": "string", "provider_id": "string", "setup_type": "automatic", "status": "pending", "created_at": "2019-08-24T14:15:22Z", "records": [ { "type": "CNAME", "host": "string", "value": "string", "ttl": 3600, "priority": 0, "applied": true } ]}{ "id": "string", "application_id": "string", "domain": "string", "host": "string", "provider_id": "string", "setup_type": "automatic", "status": "pending", "created_at": "2019-08-24T14:15:22Z", "records": [ { "type": "CNAME", "host": "string", "value": "string", "ttl": 3600, "priority": 0, "applied": true } ]}{ "code": "string", "title": "string", "details": "string"}{ "code": "string", "title": "string", "details": "string"}