Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Kibana workflows API

Workflows enable you to automate multi-step processes directly in Kibana. Define sequences of steps in YAML to transform data insights into automated actions and outcomes, without needing external automation tools.Use the workflows APIs to create, manage, and run workflows programmatically. You can also search, export, import, and monitor workflow executions.

Kibana workflows API is one of 60 APIs that Kibana publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include workflows. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 26 operations across 22 paths. It is described by OpenAPI 3.0.3.

Requests are made against a single base URL, https://{kibana_url}.

26 operations 22 paths 0 schemas 2 DELETE12 GET11 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
Base URL
https://localhost:5601/api
Authentication
API Key, HTTP Basic
Contact
Kibana Team
Resource Areas
1

Authentication & Security 2

Kibana workflows API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (apiKeyAuth). It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

  • apiKeyAuth — 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 base64A…

Paths & Operations 26

Across 22 paths, the API surfaces 26 operations — 2 DELETE, 12 GET, 11 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

workflows 26

Workflows enable you to automate multi-step processes directly in Kibana. Define sequences of steps in YAML to transform data insights into automated actions and outcomes, without…

DELETE
/api/workflows
Bulk delete workflows
delete-workflows 2 params body → 200
GET
/api/workflows
Get workflows
get-workflows 6 params → 200
POST
/api/workflows
Bulk create workflows
post-workflows 2 params body → 200
GET
/api/workflows/aggs
Get workflow aggregations
get-workflows-aggs 1 param → 200
GET
/api/workflows/connectors
Get available connectors
get-workflows-connectors → 200
GET
/api/workflows/executions/{executionId}
Get a workflow execution
get-workflows-executions-executionid 3 params → 200
POST
/api/workflows/executions/{executionId}/cancel
Cancel a workflow execution
post-workflows-executions-executionid-cancel 2 params → 200
GET
/api/workflows/executions/{executionId}/children
Get child executions
get-workflows-executions-executionid-children 1 param → 200
GET
/api/workflows/executions/{executionId}/logs
Get execution logs
get-workflows-executions-executionid-logs 6 params → 200
POST
/api/workflows/executions/{executionId}/resume
Resume a workflow execution
post-workflows-executions-executionid-resume 2 params body → 200
GET
/api/workflows/executions/{executionId}/step/{stepExecutionId}
Get a step execution
get-workflows-executions-executionid-step-stepexecutionid 2 params → 200
POST
/api/workflows/export
Export workflows
post-workflows-export 1 param body → 200
POST
/api/workflows/mget
Get workflows by IDs
post-workflows-mget 1 param body → 200
GET
/api/workflows/schema
Get workflow JSON schema
get-workflows-schema 1 param → 200
GET
/api/workflows/stats
Get workflow statistics
get-workflows-stats → 200
POST
/api/workflows/step/test
Test a workflow step
post-workflows-step-test 1 param body → 200
POST
/api/workflows/test
Test a workflow
post-workflows-test 1 param body → 200
POST
/api/workflows/workflow
Create a workflow
post-workflows-workflow 1 param body → 200
DELETE
/api/workflows/workflow/{id}
Delete a workflow
delete-workflows-workflow-id 3 params → 200
GET
/api/workflows/workflow/{id}
Get a workflow
get-workflows-workflow-id 1 param → 200
PUT
/api/workflows/workflow/{id}
Update a workflow
put-workflows-workflow-id 2 params body → 200
POST
/api/workflows/workflow/{id}/clone
Clone a workflow
post-workflows-workflow-id-clone 2 params → 200
POST
/api/workflows/workflow/{id}/run
Run a workflow
post-workflows-workflow-id-run 2 params body → 200
GET
/api/workflows/workflow/{workflowId}/executions
Get workflow executions
get-workflows-workflow-workflowid-executions 7 params → 200
POST
/api/workflows/workflow/{workflowId}/executions/cancel
Cancel all active workflow executions
post-workflows-workflow-workflowid-executions-cancel 2 params → 200
GET
/api/workflows/workflow/{workflowId}/executions/steps
Get workflow step executions
get-workflows-workflow-workflowid-executions-steps 6 params → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kibana-workflows-api-openapi.yml Raw ↑

Other APIs Kibana publishes across the network.

Kibana Actions API
Kibana agent builder API
Kibana alerting API
Kibana APM agent configuration API
Kibana APM agent keys API
Kibana APM annotations API
Kibana APM server schema API
Kibana APM sourcemaps API
Kibana cases API
Kibana connectors API
Kibana Data streams API
Kibana data views API