playbooks

Pause Playbook

Changed on

Pause an active playbook, suspending automated runs.

Requires the sequences:write scope on the API key.

post/v1/playbooks/{playbook_id}/pause

Request

  • Base URL: https://api.topo.io
  • URL: https://api.topo.io/v1/playbooks/{playbook_id}/pause
  • Auth: HTTP bearer

Path parameters

playbook_idstring uuid required

ID of the playbook.

Response

Successful Response

playbook_idstring uuid required

Playbook whose status changed.

previous_status'DRAFT' | 'ENABLED' | 'PAUSED' required
new_status'DRAFT' | 'ENABLED' | 'PAUSED' required

Changes