Skip to main content
POST
/
api
/
v1
/
playbooks
Save playbook
curl --request POST \
  --url http://localhost:3000/api/v1/playbooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "mission": {},
  "parameters": [
    {
      "name": "<string>",
      "description": "<string>",
      "type": "string",
      "required": true,
      "default": "<string>",
      "enum": [
        "<string>"
      ]
    }
  ]
}
'
{
  "ok": true,
  "data": null
}

Authorizations

Authorization
string
header
required

API key passed as a Bearer token. Configure via the apiKeys field in polpo.json or the POLPO_API_KEY environment variable.

Body

application/json
name
string
required

Playbook name (kebab-case)

description
string
required

Human-readable description

mission
object
required

Mission playbook body with {{placeholder}} syntax

parameters
object[]

Response

Playbook created

ok
boolean
required
data
unknown