v46

latestOpenAPI 3.0.0raw.githubusercontent.com2026-07-174421106.5 KB
PlaybookRuns

Update a playbook run

patch/plugins/playbooks/api/v0/runs/{id}

Path parameters

idstring required
Example:mx3xyzdojfgyfdx8sc8of1gdme

ID of the playbook run to retrieve.

Request body

namestring

The new name of the playbook run. Must not be empty.

summarystring

The new summary of the playbook run. Can be empty to clear the summary.

Example request

{
  "name": "Updated Server Down Incident",
  "summary": "## Incident Summary\n\nResolved the server outage."
}

Response

Playbook run successfully updated.