Playbooks

Reorder a playbook's checks

Set the order of the playbook's checks. Provide the check IDs in the desired order.

Requires a user-scoped key with write access to the playbook. Org-scoped keys cannot reorder checks.

post/playbooks/{id}/checks/reorder

Request

Base URL
https://app.gc.ai/api/external/v1
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/gc-ai/apis/gc-ai-external-api/docs/playbooks/:id/checks/reorder/post.ts
A function with typed inputs. Its response is checked against the schema.

idstring uuid required

Playbook ID from GET /playbooks.

check_idsstring[] required

All check IDs of the playbook in the desired order. Checks omitted from the list keep their existing order relative to one another.

Checks reordered

reorderedboolean required

Always true on success

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