# Elastic data stream API

**Canonical:** https://apis.io/apis/elastic/elastic-data-stream-api/  
**Provider:** Elastic — https://apis.io/providers/elastic/  
**Base URL:** https://api.elastic-cloud.com  
**Documentation:** https://www.elastic.co/docs/api/doc/elasticsearch

Elastic data stream API is one of 50 APIs that [Elastic](https://apis.io/providers/elastic/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 1 JSON Schema definition. Tagged areas include Datastream. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 1 JSON Schema.

The data stream APIs enable you to create and manage data streams and data stream lifecycles. A data stream lets you store append-only time series data across multiple indices while giving you a single named resource for requests. Data streams are well-suited for logs, events, metrics, and other continuously generated data.

## Operations (21)

| Method | Path | Summary |
|---|---|---|
| GET | `/_data_stream/{name}` | Get data streams |
| PUT | `/_data_stream/{name}` | Create a data stream |
| DELETE | `/_data_stream/{name}` | Delete data streams |
| GET | `/_data_stream/_stats` | Get data stream stats |
| GET | `/_data_stream/{name}/_stats` | Get data stream stats |
| GET | `/_data_stream/{name}/_lifecycle` | Get data stream lifecycles |
| PUT | `/_data_stream/{name}/_lifecycle` | Update data stream lifecycles |
| GET | `/_data_stream/{name}/_options` | Get data stream options |
| PUT | `/_data_stream/{name}/_options` | Update data stream options |
| DELETE | `/_data_stream/{name}/_options` | Delete data stream options |
| POST | `/{index}/_downsample/{target_index}` | Downsample an index |
| GET | `/{index}/_lifecycle/explain` | Get the status for a data stream lifecycle |
| GET | `/_lifecycle/stats` | Get data stream lifecycle stats |
| GET | `/_data_stream` | Get data streams |
| GET | `/_data_stream/{name}/_mappings` | Get data stream mappings |
| PUT | `/_data_stream/{name}/_mappings` | Update data stream mappings |
| GET | `/_data_stream/{name}/_settings` | Get data stream settings |
| PUT | `/_data_stream/{name}/_settings` | Update data stream settings |
| POST | `/_data_stream/_migrate/{name}` | Convert an index alias to a data stream |
| POST | `/_data_stream/_modify` | Update data streams |
| POST | `/_data_stream/_promote/{name}` | Promote a data stream |

## Machine-readable artifacts (5)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/elastic/refs/heads/main/openapi/elastic-data-stream-api-openapi.yml
- **Documentation** — https://www.elastic.co/docs/api/doc/elasticsearch
- **Documentation** — https://www.elastic.co/docs/api/doc/kibana
- **Documentation** — https://www.elastic.co/docs/api/doc/cloud
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/elastic/refs/heads/main/json-schema/elastic-saved-object-schema.json

## Other Elastic APIs (12)

- [Elastic Account API](https://apis.io/apis/elastic/elastic-account-api/)
- [Elastic Cluster API](https://apis.io/apis/elastic/elastic-cluster-api/)
- [Elastic Deployments API](https://apis.io/apis/elastic/elastic-deployments-api/)
- [Elastic Documents API](https://apis.io/apis/elastic/elastic-documents-api/)
- [Elastic Indices API](https://apis.io/apis/elastic/elastic-indices-api/)
- [Elastic Search API](https://apis.io/apis/elastic/elastic-search-api/)
- [Elastic Security API](https://apis.io/apis/elastic/elastic-security-api/)
- [Elastic Spaces API](https://apis.io/apis/elastic/elastic-spaces-api/)
- [Elastic Status API](https://apis.io/apis/elastic/elastic-status-api/)
- [Elastic TrafficFilters API](https://apis.io/apis/elastic/elastic-trafficfilters-api/)
- [Elastic Analytics API](https://apis.io/apis/elastic/elastic-analytics-api/)
- [Elastic Cat API](https://apis.io/apis/elastic/elastic-cat-api/)

## Tags

Datastream

---

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