CIcircleci
Workflow

Cancel a workflow

Cancels a running workflow.

post/workflow/{id}/cancel

Request

  • Base URL
    https://circleci.com/api/v2
  • URL
    https://circleci.com/api/v2/workflow/{id}/cancel
  • Auth
    • API key in header Circle-Token
    • or HTTP bearer
    • or HTTP basic
    • or API key in query parameter circle-token

Path parameters

idstring uuid required

The unique ID of the workflow.

Response

A confirmation message.

messagestring required

A human-readable message

Changes

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