playbooks

List Playbook Runs

Changed on

List execution runs for a playbook.

Requires the sequences:read scope on the API key.

get/v1/playbooks/{playbook_id}/runs

Request

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

Path parameters

playbook_idstring uuid required

ID of the playbook.

Query parameters

pageinteger
sizeinteger
status'PENDING' | 'RUNNING' | 'SUCCEEDED' | 'FAILED' | 'REJECTED' | 'CANCELLED'

Filter runs by execution status.

Response

Successful Response

total_countinteger required

Total number of records matching the query.

total_pagesinteger required

Total number of pages.

has_moreboolean required

Whether more pages remain after the current one.

Changes

  • 4c947c3f2e11Revision changes
    • warning

      added the new CANCELLED enum value to the // response property for the response status

    • info

      added the enum value CANCELLED to the property anyOf[subschema #1: PlaybookRunStatus]/ of the query request parameter status

  • 80f4fd40b75eRevision changes
    • info

      endpoint added