v1

latestOpenAPI 3.0.12026-07-265879107.5 KB

Workflows

Execute a playbook

Starts execution of the specified playbook. By default, the execution runs asynchronously and returns the execution ID immediately. Use the run_sync parameter to wait for the execution to complete and return the output directly. Note: When running synchronously, the request will block until the playbook completes or times out.

post/workspace/{ws_id}/playbooks/{id}/execute

Path parameters

idstring required

The ID of the playbook to execute

ws_idstring required

The ID of the workspace containing the playbook

Query parameters

run_syncboolean

When set to true, runs the playbook synchronously and returns the execution output instead of the execution ID. The request blocks until the workflow completes or times out

timeoutinteger

The number of seconds to wait for completion when running synchronously. Only applicable when run_sync is true

Request body

eventobject

The data that is used on an event-based workflow

input_valuesobject

Input parameters that will be used by the workflow

past_exec_refstring

The ID of a previous execution, used when rerunning

runnerstring

The runner group that will run the workflow

trigger_typestring

The type of the trigger of the workflow

Response

Execution ID when running asynchronously, or playbook output when running synchronously

execution_idstring

The ID of the created execution

Example response

{
  "execution_id": "a22f642a-f4fc-4c66-b978-6f1d1008e6ae"
}