# Elastic Stack (ELK Stack) Workflows API

**Canonical:** https://apis.io/apis/elk-stack/elk-stack-workflows-api/  
**Provider:** Elastic Stack (ELK Stack) — https://apis.io/providers/elk-stack/  
**Base URL:** https://{elasticsearch_endpoint}  
**Documentation:** https://www.elastic.co/docs/api/doc/elasticsearch/

Elastic Stack (ELK Stack) Workflows API is one of 132 APIs that [Elastic Stack (ELK Stack)](https://apis.io/providers/elk-stack/) publishes on the [APIs.io](https://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 an API reference.

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.

## Operations (31)

| Method | Path | Summary |
|---|---|---|
| DELETE | `/api/workflows` | Bulk delete workflows |
| GET | `/api/workflows` | Get workflows |
| POST | `/api/workflows` | Bulk create workflows |
| GET | `/api/workflows/aggs` | Get workflow aggregations |
| GET | `/api/workflows/connectors` | Get available connectors |
| GET | `/api/workflows/executions/{executionId}` | Get a workflow execution |
| POST | `/api/workflows/executions/{executionId}/cancel` | Cancel a workflow execution |
| GET | `/api/workflows/executions/{executionId}/children` | Get child executions |
| GET | `/api/workflows/executions/{executionId}/logs` | Get execution logs |
| POST | `/api/workflows/executions/{executionId}/resume` | Resume a workflow execution |
| GET | `/api/workflows/executions/{executionId}/step/{stepExecutionId}` | Get a step execution |
| GET | `/api/workflows/executions/{executionId}/steps/{stepId}/resume/external` | Resume a workflow execution from an external link |
| POST | `/api/workflows/executions/{executionId}/steps/{stepId}/resume/external` | Submit external input for a paused workflow execution |
| GET | `/api/workflows/executions/{executionId}/steps/{stepId}/resume/external/form` | Get the external input form for a paused workflow execution |
| POST | `/api/workflows/export` | Export workflows |
| PUT | `/api/workflows/managed/workflow/{id}` | Update a managed workflow |
| POST | `/api/workflows/mget` | Get workflows by IDs |
| GET | `/api/workflows/schema` | Get workflow JSON schema |
| GET | `/api/workflows/stats` | Get workflow statistics |
| POST | `/api/workflows/step/test` | Test a workflow step |
| POST | `/api/workflows/test` | Test a workflow |
| POST | `/api/workflows/workflow` | Create a workflow |
| DELETE | `/api/workflows/workflow/{id}` | Delete a workflow |
| GET | `/api/workflows/workflow/{id}` | Get a workflow |
| PUT | `/api/workflows/workflow/{id}` | Update a workflow |
| POST | `/api/workflows/workflow/{id}/clone` | Clone a workflow |
| POST | `/api/workflows/workflow/{id}/run` | Run a workflow |
| GET | `/api/workflows/workflow/{workflowId}/executions` | Get workflow executions |
| POST | `/api/workflows/workflow/{workflowId}/executions/cancel` | Cancel all active workflow executions |
| GET | `/api/workflows/workflow/{workflowId}/executions/steps` | Get workflow step executions |
| GET | `/api/workflows/workflow/executions` | Search workflow executions |

## Machine-readable artifacts (8)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/elk-stack/refs/heads/main/openapi/elk-stack-workflows-api-openapi.yml
- **Documentation** — https://www.elastic.co/docs/reference/elasticsearch
- **APIReference** — https://www.elastic.co/docs/api/doc/elasticsearch/
- **SourceCode** — https://github.com/elastic/elasticsearch-specification
- **Documentation** — https://www.elastic.co/docs/reference/kibana
- **APIReference** — https://www.elastic.co/docs/api/doc/kibana/
- **SourceCode** — https://github.com/elastic/kibana
- **ToolCrosswalk** — https://raw.githubusercontent.com/api-evangelist/elk-stack/refs/heads/main/mcp/elk-stack-tool-crosswalk.yml

## Other Elastic Stack (ELK Stack) APIs (12)

- [Elastic Cloud API](https://apis.io/apis/elk-stack/elastic-cloud-api/)
- [Elastic Stack (ELK Stack) Accounts API](https://apis.io/apis/elk-stack/elk-stack-accounts-api/)
- [Elastic Stack (ELK Stack) Actions API](https://apis.io/apis/elk-stack/elk-stack-actions-api/)
- [Elastic Stack (ELK Stack) agent builder API](https://apis.io/apis/elk-stack/elk-stack-agent-builder-api/)
- [Elastic Stack (ELK Stack) Alerting API](https://apis.io/apis/elk-stack/elk-stack-alerting-api/)
- [Elastic Stack (ELK Stack) Alerting V2 API](https://apis.io/apis/elk-stack/elk-stack-alerting-v2-api/)
- [Elastic Stack (ELK Stack) Analytics API](https://apis.io/apis/elk-stack/elk-stack-analytics-api/)
- [Elastic Stack (ELK Stack) APM agent configuration API](https://apis.io/apis/elk-stack/elk-stack-apm-agent-configuration-api/)
- [Elastic Stack (ELK Stack) APM agent keys API](https://apis.io/apis/elk-stack/elk-stack-apm-agent-keys-api/)
- [Elastic Stack (ELK Stack) APM annotations API](https://apis.io/apis/elk-stack/elk-stack-apm-annotations-api/)
- [Elastic Stack (ELK Stack) APM server schema API](https://apis.io/apis/elk-stack/elk-stack-apm-server-schema-api/)
- [Elastic Stack (ELK Stack) APM sourcemaps API](https://apis.io/apis/elk-stack/elk-stack-apm-sourcemaps-api/)

## Tags

Workflows

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/elk-stack/elk-stack-workflows-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/elk-stack/.
