v1

latestOpenAPI 3.0.12026-07-265879107.5 KB

Workflows

Edit playbook metadata

Updates the name, description, tags, and runner of the playbook with the given ID. Updating the runner requires the ViewAction permission on RunnerObject.

put/workspace/{ws_id}/playbooks/{id}/edit

Path parameters

ws_idstring required

Workspace ID

idstring required

The ID of the playbook to edit

Request body

activeboolean

analyst_copilot_workflowboolean

custom_timeoutinteger

descstring

iconstring

is_requestboolean

max_concurrency_levelinteger

namestring

notification_emailsstring

playbook_to_run_on_errorstring

preferred_engine_versionstring

The preferred workflow engine version

runnerstring

step_transition_limitinteger

tagsstring[]

Response

Updated playbook metadata