Run a workflow

Base URL: https://{kibana_url}

POST /api/workflows/workflow/{id}/run

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.

Required privileges

Privileges workflowsManagement:execute

Path parameters

id string · max length: 255 required: Workflow ID

Header parameters

kbn-xsrf string required: A required header to protect against CSRF attacks

Request body

inputs map string to object required: Key-value inputs for the workflow execution.
metadata map string to object: Optional metadata for the execution.

Response

200

Indicates a successful response

application/json

View as Markdown

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Example request to execute a workflow with inputs

Console Kibana Dev Tools

POST kbn://api/workflows/workflow/{id}/run
{
  "inputs": {
    "message": "hello from the API"
  }
}

curl Shell

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

{
  "workflowExecutionId": "exec-a1b2c3d4-e5f6-7890"
}

Required privileges

Path parameters

Header parameters

Request body { }

Response

Request body