PlaybookRuns

Update a playbook run's status

post/plugins/playbooks/api/v0/runs/{id}/status

Path parameters

idstring required
Example:1igmynxs77ywmcbwbsujzktter

ID of the playbook run to update.

Request body

messagestring required

The status update message.

remindernumber

The number of seconds until the system will send a reminder to the owner to update the status. No reminder will be scheduled if reminder is 0 or omitted.

Example request

{
  "message": "Starting to investigate.",
  "reminder": 600
}

Response

Playbook run updated.

Changes

Changed in 2 of the 47 revisions of this API.2