Skip to main content
POST
/
api
/
v1
/
templates
/
{name}
/
run
Run playbook
curl --request POST \
  --url http://localhost:3890/api/v1/templates/{name}/run \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "params": {}
}'
{
  "ok": true,
  "data": {
    "tasks": 123,
    "group": "<string>",
    "mission": null,
    "warnings": [
      "<string>"
    ]
  }
}

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.

Path Parameters

​
name
string
required

Body

application/json
​
params
object

Response

Playbook executed

​
ok
boolean
required
​
data
object
required