Test a workflow step

Base URL: https://{kibana_url}

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

Auth

Execute a single step from a workflow definition in test mode.

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

contextOverride map string to object required: Context overrides for the step execution.
executionContext map string to object: Execution context for the step execution.
stepId string required: ID of the step to test.
workflowId string: ID of the workflow containing the step.
workflowYaml string required: YAML definition of the workflow containing the step.

Response

200

Indicates a successful response

application/json

View as Markdown

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST kbn://api/workflows/step/test
{
  "stepId": "hello_world_step",
  "workflowId": "workflow-a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "workflowYaml": "name: Example definition\nenabled: true\ntriggers:\n  - type: manual\ninputs:\n  - name: message\n    type: string\n    default: \"hello world\"\nsteps:\n  - name: hello_world_step\n    type: console\n    with:\n      message: \"{{ inputs.message }}\"",
  "contextOverride": { "inputs": { "message": "override message" } }
}

curl Shell

curl \
  -X POST "${KIBANA_URL}/api/workflows/step/test" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "kbn-xsrf: true" \
  -H "Content-Type: application/json" \
  -d '{
    "stepId": "hello_world_step",
    "workflowId": "workflow-a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "workflowYaml": "name: Example definition\nenabled: true\ntriggers:\n  - type: manual\ninputs:\n  - name: message\n    type: string\n    default: \"hello world\"\nsteps:\n  - name: hello_world_step\n    type: console\n    with:\n      message: \"{{ inputs.message }}\"",
    "contextOverride": { "inputs": { "message": "override message" } }
  }'

Response

No example

Request Console 1 / 2 languages

Example request to test a single workflow step

Console Kibana Dev Tools

POST kbn:/api/workflows/step/test
{
  "contextOverride": {
    "inputs": {
      "message": "override message"
    }
  },
  "stepId": "hello_world_step",
  "workflowId": "workflow-a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "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/step/test" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "kbn-xsrf: true" \
  -H "Content-Type: application/json" \
  -d '{
    "contextOverride": {
      "inputs": {
        "message": "override message"
      }
    },
    "stepId": "hello_world_step",
    "workflowId": "workflow-a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "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 step test execution ID

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

Required privileges

Path parameters

Header parameters

Request body { }

Response

Request body