Playbooks

Cancel a playbook run

Cancel a run that is still pending, running, or paused. A run that has already reached a terminal state, or finishes between the check and the write, returns 409 invalid_state.

post/playbooks/{id}/runs/{runId}/cancel

Request

  • Base URL: https://next.frase.io/api/v1
  • URL: https://next.frase.io/api/v1/playbooks/{id}/runs/{runId}/cancel
  • Auth: API key in header X-API-KEY

Path parameters

idstring uuid required

Playbook ID

runIdstring uuid required

Run ID

Response

Run cancelled

request_idstring

Changes

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