Run a workflow
Base URL
https://{kibana_url}
Auth
Execute a workflow by its ID with the provided inputs. The workflow must be enabled and have a valid definition. Returns an execution ID that can be used to monitor progress.
Privileges
workflowsManagement:execute
Expand all
space_id
string optional
An identifier for the space. If space_id is not provided in the URL, the default space is used. Refer to Spaces for more information.
id
string · max length: 255 required
Workflow ID
A required header to protect against CSRF attacks
{
}
inputs
map string to object required
Key-value inputs for the workflow execution.
metadata
map string to object
Optional metadata for the execution.
200
Indicates a successful response
application/json
Thank you for your feedback.
Base URL
https://{kibana_url}
Examples
Request
Console
1 / 2 languages
‹
›
Example request to execute a workflow with inputs
Show more
1
2
3
4
5
6
POST kbn://api/workflows/workflow/{id}/run
{
"inputs": {
"message": "hello from the API"
}
}
1
2
3
4
5
6
7
8
9
10
curl \
-X POST "${KIBANA_URL}/api/workflows/workflow/{id}/run" \
-H "Authorization: ApiKey ${API_KEY}" \
-H "kbn-xsrf: true" \
-H "Content-Type: application/json" \
-d '{
"inputs": {
"message": "hello from the API"
}
}'
Response
Example response returning the execution ID
Show more
1
2
3
{
"workflowExecutionId": "exec-a1b2c3d4-e5f6-7890"
}