Elastic Stack

Elastic Stack (ELK Stack) Deployments API

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

GitHub OpenAPI

Operations 72

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 #
POST /deployments/{deployment_id}/{resource_kind}/{ref_id}/metadata/raw Set a Deployment's resource metadata #
PATCH /deployments/{deployment_id}/{resource_kind}/{ref_id}/metadata/raw Patch a Deployment's resource metadata #
DELETE /deployments/{deployment_id}/{resource_kind}/{ref_id}/plan/pending Cancel resource pending plan #
GET /deployments/{deployment_id}/{resource_kind}/{ref_id}/proxy/{proxy_path} Proxy HTTP GET request #
POST /deployments/{deployment_id}/{resource_kind}/{ref_id}/proxy/{proxy_path} Proxy HTTP POST request #
PUT /deployments/{deployment_id}/{resource_kind}/{ref_id}/proxy/{proxy_path} Proxy HTTP PUT request #
DELETE /deployments/{deployment_id}/{resource_kind}/{ref_id}/proxy/{proxy_path} Proxy HTTP DELETE request #
GET /deployments/{deployment_id}/{resource_kind}/{ref_id}/user_settings Get the user settings of a Deployment resource #
PUT /deployments/{deployment_id}/{resource_kind}/{ref_id}/user_settings Update user settings for a deployment resource #
DELETE /deployments/{deployment_id}/{stateless_resource_kind}/{ref_id} Delete Stateless Resource from Deployment #
POST /deployments/{deployment_id}/{stateless_resource_kind}/{ref_id}/_restart Restart Deployment Stateless Resource #
POST /deployments/{deployment_id}/{stateless_resource_kind}/{ref_id}/_shutdown Shutdown Deployment Stateless Resource #

Documentation

📖
Documentation
https://www.elastic.co/docs/reference/elasticsearch
📖
APIReference
https://www.elastic.co/docs/api/doc/elasticsearch/
📖
Documentation
https://www.elastic.co/docs/reference/kibana
📖
APIReference
https://www.elastic.co/docs/api/doc/kibana/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/elk-stack/refs/heads/main/openapi/elk-stack-deployments-api-openapi.yml

Other Resources

🔗
SourceCode
https://github.com/elastic/elasticsearch-specification
🔗
SourceCode
https://github.com/elastic/kibana
🔗
ToolCrosswalk
https://raw.githubusercontent.com/api-evangelist/elk-stack/refs/heads/main/mcp/elk-stack-tool-crosswalk.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/elk-stack-deployments-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

elk-stack-deployments-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: '1'
  title: Elastic Cloud Enterprise Deployments API
  termsOfService: ''
servers:
- url: https://{{hostname}}/api/v1
security:
- basicAuth: []
- apiKey: []
tags:


# --- truncated at 32 KB (432 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/elk-stack/refs/heads/main/openapi/elk-stack-deployments-api-openapi.yml