API Reference

Get execution

Reads one execution, its ordered stages, and any normalized onboarding outcome. The bearer principal must hold the workflows:<name> entitlement corresponding to that execution; the operation is valid in every execution state and does not mutate it.

GET/v1/executions/{id}

Reads one execution, its ordered stages, and any normalized onboarding outcome. The bearer principal must hold the workflows: entitlement corresponding to that execution; the operation is valid in every execution state and does not mutate it.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Execution ID.

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/executions/string"
{  "cancellationRequestedAt": "string",  "createdAt": "string",  "currentStage": "string",  "executionId": "string",  "finishedAt": "string",  "principalId": "string",  "status": "canceled",  "workflow": "string",  "inputJson": null,  "outcome": {    "assistance": {      "reasons": [        {          "action": "string",          "audience": "platform",          "code": "string",          "message": "string",          "resources": [            "string"          ]        }      ],      "required": true    },    "certificate": {      "arn": "string",      "id": "string",      "primaryDomain": "string",      "state": "created"    },    "cleanup": {      "action": "string",      "certificateArn": "string",      "remainingAttachments": [        "string"      ],      "state": "completed"    },    "distributions": {      "kirby": {        "id": "string",        "state": "created"      },      "nginx": {        "id": "string",        "state": "created"      }    },    "domain": {      "name": "string",      "state": "registered"    },    "executionId": "string",    "googleMaps": {      "keys": [        {          "displayName": "string",          "state": "updated"        }      ],      "outcome": "updated",      "remainingRootDomains": 0    },    "status": "string",    "workflowRunId": "string",    "zendesk": {      "intendedAction": "string",      "state": "updated",      "ticketId": "string"    }  },  "stages": [    {      "errorJson": null,      "executionId": "string",      "finishedAt": "string",      "id": "string",      "outputJson": null,      "stageName": "string",      "startedAt": "string",      "status": "failed"    }  ]}

List executions GET

Read-only execution search for an authenticated principal. Results are limited to workflows for which the caller has workflows:<name> entitlement, then filtered by workflow, status, requesting principal, and limit; no execution state is changed.

Cancel non-terminal execution POST

Requires the workflows:<name> entitlement for the execution and mutates only cancelable, non-terminal work. Lambda updates record a cancellation request, while other workflows cancel their run and execution; add-subdomain cannot be canceled after Route 53 has accepted its change.