Create a workflow

Base URL: https://{kibana_url}

POST /api/workflows/workflow

Create a new workflow from a YAML definition. The YAML is validated and parsed before the workflow is saved. An optional custom ID can be provided.

Required authorization

Authentication

Api key

Authorization: <value>

These APIs use key-based authentication. You must create an API key and use the encoded value in the request header. For example: Authorization: ApiKey base64AccessApiKey

Basic

Authorization: Basic <credentials>

Header parameters

Request body

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/workflow
{
  "yaml": "name: Example definition\nenabled: true\ndescription: This is a workflow example\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 }}\"\n"
}

curl Shell

curl \
  -X POST "${KIBANA_URL}/api/workflows/workflow" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "kbn-xsrf: true" \
  -H "Content-Type: application/json" \
  -d '{
    "yaml": "name: Example definition\nenabled: true\ndescription: This is a workflow example\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 }}\"\n"
  }'

Request Console 1 / 2 languages

Example request for creating a workflow from a YAML definition

Console Kibana Dev Tools

POST kbn:/api/workflows/workflow
{
  "yaml": "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/workflow" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "kbn-xsrf: true" \
  -H "Content-Type: application/json" \
  -d '{
    "yaml": "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 created workflow

{
  "createdAt": "2025-11-20T10:30:00.000Z",
  "createdBy": "elastic",
  "definition": {
    "description": "This is a workflow example",
    "enabled": true,
    "inputs": [
      {
        "default": "hello world",
        "name": "message",
        "type": "string"
      }
    ],
    "name": "Example definition",
    "steps": [
      {
        "name": "hello_world_step",
        "type": "console",
        "with": {
          "message": "{{ inputs.message }}"
        }
      }
    ],
    "triggers": [
      {
        "type": "manual"
      }
    ]
  },
  "description": "This is a workflow example",
  "enabled": true,
  "id": "workflow-a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "lastUpdatedAt": "2025-11-20T10:30:00.000Z",
  "lastUpdatedBy": "elastic",
  "name": "Example definition",
  "valid": true,
  "yaml": "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"
}

Request Console 1 / 2 languages

Example request for creating a workflow with a custom ID

Console Kibana Dev Tools

POST kbn:/api/workflows/workflow
{
  "id": "workflow-a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "yaml": "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/workflow" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "kbn-xsrf: true" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "workflow-a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "yaml": "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 created workflow

{
  "createdAt": "2025-11-20T10:30:00.000Z",
  "createdBy": "elastic",
  "definition": {
    "description": "This is a workflow example",
    "enabled": true,
    "inputs": [
      {
        "default": "hello world",
        "name": "message",
        "type": "string"
      }
    ],
    "name": "Example definition",
    "steps": [
      {
        "name": "hello_world_step",
        "type": "console",
        "with": {
          "message": "{{ inputs.message }}"
        }
      }
    ],
    "triggers": [
      {
        "type": "manual"
      }
    ]
  },
  "description": "This is a workflow example",
  "enabled": true,
  "id": "workflow-a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "lastUpdatedAt": "2025-11-20T10:30:00.000Z",
  "lastUpdatedBy": "elastic",
  "name": "Example definition",
  "valid": true,
  "yaml": "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"
}

Required authorization

Authentication

Header parameters

Request body { }

Response

Request body