API Reference

Trigger add-domain

Registers a root/apex domain by finding or creating its Route 53 hosted zone and, when needed, updating GoDaddy nameservers. Send a bare apex domain such as example.com in domainString, without a protocol, path, wildcard, or leading www; the request schema otherwise passes the string through unchanged. Required permission: workflows:add-domain. A new request is accepted for asynchronous Workflow SDK execution; use the returned execution ID with GET /v1/executions/{id} to track it.

POST/v1/workflows/add-domain

Registers a root/apex domain by finding or creating its Route 53 hosted zone and, when needed, updating GoDaddy nameservers. Send a bare apex domain such as example.com in domainString, without a protocol, path, wildcard, or leading www; the request schema otherwise passes the string through unchanged. Required permission: workflows:add-domain. A new request is accepted for asynchronous Workflow SDK execution; use the returned execution ID with GET /v1/executions/{id} to track it.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Header Parameters

Idempotency-Key*string

Client-generated key used to make workflow trigger retries safe.

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

application/json

application/json

curl -X POST "https://example.com/v1/workflows/add-domain" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "domainString": "example.com"  }'
{  "estimatedDurationSeconds": 0,  "executionId": "string",  "links": {    "cancel": "string",    "events": "string",    "self": "string"  },  "stages": [    "string"  ],  "status": "canceled",  "workflow": "string",  "workflowRunId": "string"}