Runbooks API

Manage runbooks and their versions, reviews and tags.

Base path: /api/v1/runbooks · Permission resource: runbooks. All requests require authentication.

Important

Most deployments are now Wiki-backed. When Wiki-backed runbooks are enabled (the default), the template-shaped endpoints below return 410 Gone and point you to the Wiki API: list runbooks with GET /api/v1/wiki/pages?entity_type=runbook, and create/edit them by writing Wiki sections. The tag endpoints remain available either way. Use this page to recognise the endpoints; prefer the Wiki API for new integrations.

Tag endpoints (always available)

Method	Path	Purpose	Permission
POST	`/runbooks/tags`	Create a tag	`runbooks:create`
GET	`/runbooks/tags`	List tags	`runbooks:read`

A tag has { name, description, color }.

Template endpoints (legacy / non-Wiki deployments)

These are the original template endpoints. On Wiki-backed deployments they return 410.

Method	Path	Purpose	Permission
POST	`/runbooks/`	Create a template	`runbooks:create`
GET	`/runbooks/`	List templates	`runbooks:read`
GET	`/runbooks/{id}`	Get a template	`runbooks:read`
PUT	`/runbooks/{id}`	Update a template	`runbooks:update`
DELETE	`/runbooks/{id}`	Delete a template	`runbooks:delete`
POST	`/runbooks/{id}/rollback`	Roll back	`runbooks:update`
POST	`/runbooks/{id}/versions`	Create a version	`runbooks:update`
GET	`/runbooks/{id}/versions`	List versions	`runbooks:read`
GET	`/runbooks/{id}/versions/compare`	Compare two versions	`runbooks:read`
GET	`/runbooks/{id}/versions/{vid}`	Get a version	`runbooks:read`
POST	`/runbooks/{id}/versions/{vid}/publish`	Publish a version	`runbooks:update`
POST	`/runbooks/{id}/versions/{vid}/reviews`	Add a review	`runbooks:create`
GET	`/runbooks/{id}/versions/{vid}/reviews`	List reviews	`runbooks:read`
GET	`/runbooks/{id}/versions/{vid}/reviews/summary`	Review summary	`runbooks:read`
GET	`/runbooks/{id}/executions`	Execution history	`runbooks:read`

Request shapes

Create template: { type, name, description, visibility, content, execution_schema?, tag_names[] }. type is one of runbook, playbook, persona, analytic_rule.
Create version: { content, change_summary, execution_schema? }.
Add review: { rating, review }.

Recommended: use the Wiki API

For Wiki-backed deployments, treat a runbook as a Wiki page of type runbook (or playbook, persona, analytic_rule):

# List runbooks
curl -s "http://localhost:8000/api/v1/wiki/pages?entity_type=runbook" \
  -H "Authorization: Bearer $CLOUDPEEK_TOKEN"

# Create/update a runbook by writing a section
curl -s -X PUT "http://localhost:8000/api/v1/wiki/pages/runbook/phishing-response/sections/Steps" \
  -H "Authorization: Bearer $CLOUDPEEK_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "body": "1. Confirm the sender…", "summary": "Initial phishing runbook" }'

See the Wiki API for the full set of page/section operations.

Runbooks & Playbooks: the concepts and UI.
Wiki API: where runbooks live now.