Workflow aliases

Deactivate an alias

Changed on

Marks the alias inactive and tears down its running triggers (best effort).

post/workflows/definitions/{id}/aliases/{alias}/deactivate

Request

  • Base URL
    https://api.nullplatform.com
  • URL
    https://api.nullplatform.com/workflows/definitions/{id}/aliases/{alias}/deactivate
  • Auth
    HTTP bearer

Path parameters

idstring required

Workflow reference: a server-minted id (wf_...) or the workflow's client-chosen key (lowercase slug, unique per organization).

aliasstring required

The alias name. latest is reserved and auto-maintained.

Response

The deactivation outcome.

deactivatedTriggersstring[]
deactivateErrorstring

Present when trigger teardown failed.

Example response

{
  "alias": {
    "workflowId": "wf_ifWBbWfpug0n",
    "name": "live",
    "revision": 3
  }
}

Changes