v13

latestOpenAPI 3.1.0Apache 2.0raw.githubusercontent.com2026-08-015232292.9 KB
Workflows

Undeploy Workflow

Take the workflow offline. API execution stops and schedules, webhooks, and other deployment side effects are removed. Deployment versions are retained, so the workflow can be deployed again later. Requires admin permission on the workflow's workspace. Returns 404 when the workflow does not exist or you do not have access to it.

delete/api/v1/workflows/{id}/deploy

Path parameters

idstring required
Example:3b1f7c92-8d4e-4a6b-9c0d-5e2f8a714b36

The unique workflow identifier.

Response

Workflow undeployed successfully.

Example response

{
  "data": {
    "id": "3b1f7c92-8d4e-4a6b-9c0d-5e2f8a714b36",
    "isDeployed": true,
    "deployedAt": "2026-06-12T10:30:00Z",
    "version": 4
  },
  "limits": {
    "workflowExecutionRateLimit": {
      "sync": {
        "requestsPerMinute": 60,
        "maxBurst": 10,
        "remaining": 59,
        "resetAt": "2025-06-20T14:16:00Z"
      },
      "async": {
        "requestsPerMinute": 60,
        "maxBurst": 10,
        "remaining": 59,
        "resetAt": "2025-06-20T14:16:00Z"
      }
    },
    "usage": {
      "currentPeriodCost": 1.25,
      "limit": 50,
      "plan": "pro"
    }
  }
}