TEtetrascience
Workflows

Cancel Workflows

Cancels one or more workflows by ID. Only workflows that haven't finished yet (pending, queued, or in-progress) are canceled.

Workflows that have already finished (completed, failed, or canceled), that can't be found in your organization, or that can't be canceled are skipped and don't return an error. To see how many workflows were actually canceled, check the cancelledCount value in the response.

When a workflow is canceled, its status changes to canceled.

post/v1/workflow/cancel

Request

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

Request body

workflowIdsstring[] required

The IDs of the workflows to cancel. You can include between 1 and 1,000 workflow IDs in each request.

Example request

{
  "workflowIds": [
    "ea3e0f87-4ba2-4a10-83f3-db30760fd652",
    "6b1f2c3d-8e4a-4b5c-9d6e-7f8a9b0c1d2e"
  ]
}

Response

The request completed. The response shows how many of the requested workflows were canceled.

cancelledCountinteger required

The number of workflows that were canceled. Workflows that had already finished, couldn't be found, or couldn't be canceled aren't counted.

Example response

{
  "cancelledCount": 2
}

Changes

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