Validate a playbook definition | CloudRaker documentation

Lints the playbook, optionally with a draft overlay merged over the stored document (same fields as update). Always 200 with { data: { issues } } — each issue carries severity: error | warning; warnings never block activation. Authorization: organization administrators only.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

playbookIdstringRequired

Request

A draft overlay merged over the stored playbook before linting.

namestringOptional1-200 characters

descriptionstringOptional<=5000 characters

spaceTypeslist of stringsOptional

taskslist of objectsOptional

modelstring or nullOptional<=200 characters

actionslist of objectsOptional

Response

Validation issues (possibly empty).

dataobject

$	curl -X POST https://api.cloudraker.com/playbooks/playbookId/validate \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{}'

1	{
2	"data": {
3	"issues": [
4	{
5	"path": "tasks[2].executor",
6	"message": "Executor must be either 'agent' or 'human'.",
7	"severity": "error"
8	}
9	]
10	}
11	}