Workflows

Cancel a workflow run

Cancel an in-progress workflow run. By default, waits for the current node to finish before concluding the run as CANCELLED. Use <code>force=true</code> to immediately fail all running nodes.<br></br><br></br> To learn more about workflows, see the documentation.

post/v1/workflows/runs/{identifier}/cancel

Request

  • Base URL: https://api.port.io
  • URL: https://api.port.io/v1/workflows/runs/{identifier}/cancel
  • Auth: API key in header Authorization

Path parameters

identifierstring required

The unique identifier of the workflow run to cancel.

Query parameters

forceboolean

When true, immediately fails all running nodes instead of waiting for them to complete.

Response

Default Response

okboolean required

Changes

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