# Elastic Stack (ELK Stack) Deployments API

**Canonical:** https://apis.io/apis/elk-stack/elk-stack-deployments-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) Deployments 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 Deployment. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

The Deployments API from Elastic Stack (ELK Stack) — 58 operation(s) for deployments.

## Operations (60 of 72)

| Method | Path | Summary |
|---|---|---|
| GET | `/deployments` | List Deployments |
| POST | `/deployments` | Create Deployment |
| POST | `/deployments/_resync` | Resynchronize Deployments |
| POST | `/deployments/_search` | Search Deployments |
| POST | `/deployments/eligible-remote-clusters` | Get eligible remote clusters |
| GET | `/deployments/{deployment_id}` | Get Deployment |
| PUT | `/deployments/{deployment_id}` | Update Deployment |
| DELETE | `/deployments/{deployment_id}` | Delete Deployment |
| POST | `/deployments/{deployment_id}/_restore` | Restores a shutdown Deployment |
| POST | `/deployments/{deployment_id}/_resync` | Resynchronize Deployment |
| POST | `/deployments/{deployment_id}/_shutdown` | Shuts down Deployment |
| GET | `/deployments/{deployment_id}/apm/{ref_id}` | Get Deployment APM Resource Info |
| POST | `/deployments/{deployment_id}/apm/{ref_id}/_reset-token` | Reset the secret token for an APM resource. |
| GET | `/deployments/{deployment_id}/appsearch/{ref_id}` | Get Deployment App Search Resource Info |
| GET | `/deployments/{deployment_id}/appsearch/{ref_id}/read_only_mode` | Set AppSearch read-only status |
| PUT | `/deployments/{deployment_id}/appsearch/{ref_id}/read_only_mode` | Set AppSearch read-only status |
| GET | `/deployments/{deployment_id}/certificate-authority` | Get certificate authority |
| GET | `/deployments/{deployment_id}/elasticsearch/{ref_id}` | Get Deployment Elasticsearch Resource Info |
| POST | `/deployments/{deployment_id}/elasticsearch/{ref_id}/_enable-ccr` | Migrate Elasticsearch and associated Kibana resources to enable CCR |
| POST | `/deployments/{deployment_id}/elasticsearch/{ref_id}/_enable-ilm` | Migrate Elasticsearch resource to use ILM |
| POST | `/deployments/{deployment_id}/elasticsearch/{ref_id}/_enable-slm` | Migrate Elasticsearch resource to use SLM |
| POST | `/deployments/{deployment_id}/elasticsearch/{ref_id}/_reset-password` | Reset 'elastic' user password |
| POST | `/deployments/{deployment_id}/elasticsearch/{ref_id}/_restart` | Restart Deployment Elasticsearch Resource |
| POST | `/deployments/{deployment_id}/elasticsearch/{ref_id}/_shutdown` | Shutdown Deployment Elasticsearch Resource |
| POST | `/deployments/{deployment_id}/elasticsearch/{ref_id}/eligible-remote-clusters` | Get eligible remote clusters |
| POST | `/deployments/{deployment_id}/elasticsearch/{ref_id}/instances/{instance_ids}/_move` | Move Elasticsearch resource instances |
| GET | `/deployments/{deployment_id}/elasticsearch/{ref_id}/keystore` | Get the items in the Elasticsearch resource keystore |
| PATCH | `/deployments/{deployment_id}/elasticsearch/{ref_id}/keystore` | Add or remove items from the Elasticsearch resource keystore |
| GET | `/deployments/{deployment_id}/elasticsearch/{ref_id}/remote-clusters` | Get certificate based remote clusters |
| PUT | `/deployments/{deployment_id}/elasticsearch/{ref_id}/remote-clusters` | Set certificate based remote clusters |
| GET | `/deployments/{deployment_id}/elasticsearch/{ref_id}/snapshot/repository` | List the attached snapshot repositories |
| POST | `/deployments/{deployment_id}/elasticsearch/{ref_id}/snapshot/repository` | Create a snapshot repository for Elasticsearch resource |
| DELETE | `/deployments/{deployment_id}/elasticsearch/{ref_id}/snapshot/repository/{repository_name}` | Remove the attached snapshot repository |
| GET | `/deployments/{deployment_id}/elasticsearch/{ref_id}/tiers` | Get Elasticsearch tiers |
| PATCH | `/deployments/{deployment_id}/elasticsearch/{ref_id}/tiers` | Update Elasticsearch tiers |
| GET | `/deployments/{deployment_id}/enterprise_search/{ref_id}` | Get Deployment Enterprise Search Resource Info |
| GET | `/deployments/{deployment_id}/heap_dumps` | Get details about heap dumps for a Deployment |
| GET | `/deployments/{deployment_id}/integrations_server/{ref_id}` | Get Deployment Integrations Server Resource Info |
| GET | `/deployments/{deployment_id}/kibana/{ref_id}` | Get Deployment Kibana Resource Info |
| GET | `/deployments/{deployment_id}/migrate_template` | Build request to migrate deployment to a different template |
| GET | `/deployments/{deployment_id}/tags` | Get the tags for a Deployment |
| PUT | `/deployments/{deployment_id}/tags` | Set the tags for a Deployment |
| POST | `/deployments/{deployment_id}/upgrade` | Upgrade a Deployment to a new Elastic Stack version |
| GET | `/deployments/{deployment_id}/upgrade_assistant/status` | Get Deployment upgrade assistant status |
| POST | `/deployments/{deployment_id}/{resource_kind}/{ref_id}/_restore` | Restores a shutdown resource |
| GET | `/deployments/{deployment_id}/{resource_kind}/{ref_id}/activity/{attempt_id}` | Get plan activity |
| POST | `/deployments/{deployment_id}/{resource_kind}/{ref_id}/diagnostics/_capture` | Capture diagnostics for an Elasticsearch or Kibana resource |
| POST | `/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/_start` | Start all instances |
| POST | `/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/_stop` | Stop all instances |
| POST | `/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/maintenance-mode/_start` | Start maintenance mode (all instances) |
| POST | `/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/maintenance-mode/_stop` | Stop maintenance mode (all instances) |
| PUT | `/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/overrides` | Set size overrides |
| POST | `/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_ids}/_start` | Start instances |
| POST | `/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_ids}/_stop` | Stop instances |
| POST | `/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_ids}/maintenance-mode/_start` | Start maintenance mode |
| POST | `/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_ids}/maintenance-mode/_stop` | Stop maintenance mode |
| PUT | `/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_ids}/overrides` | Set size overrides |
| POST | `/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_id}/heap_dump/_capture` | Capture a new on-demand heap dump for the given instance |
| GET | `/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_id}/heap_dump/_download` | Download the given instance's heap dump |
| POST | `/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_id}/thread_dump/_capture` | Capture a new thread dump for the given instance |

…and 12 more operations. They are listed in full on the page.

## Machine-readable artifacts (8)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/elk-stack/refs/heads/main/openapi/elk-stack-deployments-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

Deployment

---

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