Test a workflow

Base URL: https://{kibana_url}

POST /api/workflows/test
POST /s/{space_id}/api/workflows/test

Auth

Execute a workflow in test mode without requiring it to be saved or enabled. Provide either a workflow ID to test a saved workflow, a YAML definition to test an unsaved draft, or both to test a modified version of an existing workflow.

Required privileges

Privileges workflowsManagement:execute

Path parameters

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.

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 test execution.
workflowId string: ID of an existing workflow to test.
workflowYaml string: YAML definition to test.

Response

200

Indicates a successful response

application/json

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST kbn://api/workflows/test
{
  "workflowId": "workflow-a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "inputs": { "message": "test message" }
}

curl Shell

curl \
  -X POST "${KIBANA_URL}/api/workflows/test" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "kbn-xsrf: true" \
  -H "Content-Type: application/json" \
  -d '{
    "workflowId": "workflow-a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "inputs": { "message": "test message" }
  }'

Response

No example

Request Console 1 / 2 languages

Example request to test a saved workflow by its ID

Console Kibana Dev Tools

POST kbn:/api/workflows/test
{
  "inputs": {
    "message": "test message"
  },
  "workflowId": "workflow-a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

Generated from the API spec

curl Shell

curl \
  -X POST "${KIBANA_URL}/api/workflows/test" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "kbn-xsrf: true" \
  -H "Content-Type: application/json" \
  -d '{
    "inputs": {
      "message": "test message"
    },
    "workflowId": "workflow-a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }'

Generated from the API spec

Response

Example response returning the test execution ID

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

Request Console 1 / 2 languages

Example request to test an unsaved workflow YAML draft

Console Kibana Dev Tools

POST kbn:/api/workflows/test
{
  "inputs": {
    "message": "test message"
  },
  "workflowYaml": "name: Example definition\nenabled: true\ndescription: This is a workflow example\ntriggers:\n  - type: manual\ninputs:\n  - name: message\n    type: string\n    default: \u0022hello world\u0022\nsteps:\n  - name: hello_world_step\n    type: console\n    with:\n      message: \u0022{{ inputs.message }}\u0022\n"
}

Generated from the API spec

curl Shell

curl \
  -X POST "${KIBANA_URL}/api/workflows/test" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "kbn-xsrf: true" \
  -H "Content-Type: application/json" \
  -d '{
    "inputs": {
      "message": "test message"
    },
    "workflowYaml": "name: Example definition\nenabled: true\ndescription: This is a workflow example\ntriggers:\n  - type: manual\ninputs:\n  - name: message\n    type: string\n    default: \u0022hello world\u0022\nsteps:\n  - name: hello_world_step\n    type: console\n    with:\n      message: \u0022{{ inputs.message }}\u0022\n"
  }'

Generated from the API spec

Response

Example response returning the test execution ID

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

Required privileges

Path parameters

Header parameters

Request body { }

Response

Request body