Workflows

Cancel Single Workflow

Cancels a single workflow. Only a workflow that hasn't finished yet (pending, queued, or in-progress) is canceled. When a workflow is canceled, its status changes to canceled.

The endpoint returns 200 with the workflow ID even when the workflow wasn't canceled. For example, it returns 200 when the workflow had already finished or can't be found in your organization. To confirm that the workflow was canceled, use Get Single Workflow Details and check its status.

To cancel several workflows in one request, use Cancel Workflows, which also returns how many workflows were canceled.

This endpoint doesn't take a request body.

post/v1/workflow/workflows/{workflowId}/cancel

Request

  • Base URL
    https://api.tetrascience.com
  • URL
    https://api.tetrascience.com/v1/workflow/workflows/{workflowId}/cancel
  • Auth
    API key in header ts-auth-token and API key in header x-org-slug

Path parameters

workflowIdstring uuid required

The ID of the workflow to cancel.

Response

The request completed. The response doesn't show whether the workflow was canceled.

workflowIdstring uuid required

The workflow ID from the request.

Example response

{
  "workflowId": "ea3e0f87-4ba2-4a10-83f3-db30760fd652"
}

Changes

No recorded changes to this operation across all 1 revision of this API.