Sign in

Archive workflow

<Info>This API is in beta. Endpoints, fields, and behavior may still change, so avoid depending on it in production.</Info>

Archives a workflow so it stops running.

Archiving cancels its schedule, stops it responding to its trigger, and removes its file from the app's code. The workflow and its run history are kept, and Restore workflow brings it back.

Archiving frees the workflow's name, so another workflow can take it while this one is archived. That is what makes a later restore fail with a 409.

This endpoint is limited to 20 requests per minute.

delete/api/apps/{app_id}/workflows/{workflow_id}

Path parameters

app_idstring required

ID of the app whose workflows you want to work with.

ID of the app whose workflows you want to work with.

workflow_idstring required

ID of the workflow, as returned in id by List workflows.

ID of the workflow, as returned in id by List workflows.

Response

The workflow is archived.

statusstring required

Always archived.

workflow_idstring required

ID of the workflow that was archived.

Example response

{
  "status": "archived",
  "workflow_id": "68b1c0d4e7b91d003c45a1f2"
}

Changes