API Reference

Trigger add-subdomain

Plans and applies Route 53 records for labels relative to rootDomain, pausing for approval before replacing existing records. The request schema trims and lowercases DNS names, removes a final dot, and deduplicates labels; values such as blog and offers.eu are relative labels, not full names under the root. Required permission: workflows:add-subdomain. 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-subdomain

Plans and applies Route 53 records for labels relative to rootDomain, pausing for approval before replacing existing records. The request schema trims and lowercases DNS names, removes a final dot, and deduplicates labels; values such as blog and offers.eu are relative labels, not full names under the root. Required permission: workflows:add-subdomain. 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-subdomain" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "rootDomain": "example.com",    "subdomains": [      "blog",      "offers.eu"    ]  }'
{  "estimatedDurationSeconds": 0,  "executionId": "string",  "links": {    "cancel": "string",    "events": "string",    "self": "string"  },  "stages": [    "string"  ],  "status": "canceled",  "workflow": "string",  "workflowRunId": "string"}

Trigger add-domain POST

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.

Trigger update-lambda-version POST

Plans and updates the selected Lambda@Edge fleet to a positive integer version in the requested environment. The strict request schema applies the dry-run default and rejects unsupported target/environment pairs. Required permission: workflows:update-lambda-version. A new request is accepted for asynchronous Workflow SDK execution; use the returned execution ID with GET /v1/executions/{id} to track it. Fleet and provider work continues durably after this request is accepted; stable asynchronous failures are reported on the execution and its events. Request cancellation at /v1/executions/{id}/cancel, retry unfinished work at /v1/executions/{id}/resume, and restore receipt-backed changes at /v1/executions/{id}/rollback.