Elastic Stack (ELK Stack) Deployments API

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

GitHub OpenAPI
Business capability
IT Infrastructure Management BC-600.50

Operations 72

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /deployments List all deployments · List Deployments #
Ask an LLM
“What deployments do I have running in Elastic Cloud Enterprise?”
“Can I see every deployment in my environment at once?”
Tell an agent
List all my deployments.
Show me every deployment I currently have.
POST /deployments Create a new deployment · Create Deployment #
Ask an LLM
“How do I spin up a new Elastic deployment?”
“Can I build a new deployment from a deployment template?”
Tell an agent
Create a new deployment named {name} from template {template_id}.
Create a deployment called {name} on stack version {version}.
POST /deployments/_resync Resync the search index for all deployments · Resynchronize Deployments #
Ask an LLM
“How do I rebuild the deployment search index across every deployment?”
“Can I skip deployments whose indexed version already matches during a full resync?”
Tell an agent
Resynchronize the search index for all deployments.
Resync every deployment's index entry, skipping ones already on the matching version.
POST /deployments/_search Search deployments with a query · Search Deployments #
Ask an LLM
“How do I find deployments that match a specific query?”
“Can I page and sort through deployment search results?”
Tell an agent
Search my deployments using query {query}.
Find deployments matching {query} and return the first {size} results.
POST /deployments/eligible-remote-clusters Find deployments eligible as remote clusters · Get eligible remote clusters #
Ask an LLM
“Which deployments can serve as remote clusters for a given Elasticsearch version?”
“How do I find candidate remote clusters compatible with version 8.x across all deployments?”
Tell an agent
List deployments with remote clusters eligible for version {version}.
Find remote cluster candidates compatible with Elasticsearch {version} matching {query}.
GET /deployments/{deployment_id} Get a deployment's details · Get Deployment #
Ask an LLM
“How do I look up the full details of one deployment?”
“Can I include plan history and instance metrics when fetching a deployment?”
Tell an agent
Get details for deployment {deployment_id}.
Show deployment {deployment_id} including its plan history.
PUT /deployments/{deployment_id} Update a deployment's configuration · Update Deployment #
Ask an LLM
“How do I change the configuration of an existing deployment?”
“Can I rename a deployment and prune resources I left out of the update?”
Tell an agent
Rename deployment {deployment_id} to {name}.
Update deployment {deployment_id} with prune orphans set to {prune_orphans}.
DELETE /deployments/{deployment_id} Delete a deployment and its resources · Delete Deployment #
Ask an LLM
“How do I permanently delete a deployment along with all its resources?”
“Can I remove a deployment I no longer need entirely?”
Tell an agent destructive · confirm first
Delete deployment {deployment_id} and all of its resources.
Permanently remove deployment {deployment_id}.
POST /deployments/{deployment_id}/_restore Restore a shut-down deployment · Restores a shutdown Deployment #
Ask an LLM
“How do I bring back a whole deployment that was shut down?”
“Can I restore every resource in a deployment from the latest snapshot?”
Tell an agent
Restore shut-down deployment {deployment_id}.
Restore all resources in deployment {deployment_id} from snapshot.
POST /deployments/{deployment_id}/_resync Resync the search index for one deployment · Resynchronize Deployment #
Ask an LLM
“How do I force a single deployment's search index entry to resynchronize now?”
“Can I refresh the indexed record for just one deployment?”
Tell an agent
Resynchronize the search index for deployment {deployment_id}.
Immediately resync deployment {deployment_id}.
POST /deployments/{deployment_id}/_shutdown Shut down an entire deployment · Shuts down Deployment #
Ask an LLM
“How do I shut down every resource in a deployment?”
“Can I hide a deployment when I shut it down?”
Tell an agent destructive · confirm first
Shut down deployment {deployment_id}.
Shut down all resources in deployment {deployment_id} and hide it.
GET /deployments/{deployment_id}/apm/{ref_id} Get a deployment's APM resource info · Get Deployment APM Resource Info #
Ask an LLM
“How do I see the details of the APM resource in my deployment?”
“Can I view the APM resource's plan and settings?”
Tell an agent
Get APM resource {ref_id} in deployment {deployment_id}.
Show the APM resource {ref_id} settings for deployment {deployment_id}.
POST /deployments/{deployment_id}/apm/{ref_id}/_reset-token Reset an APM resource's secret token · Reset the secret token for an APM resource #
Ask an LLM
“How do I rotate the APM secret token for a deployment?”
“Can I generate a new secret token for my APM server?”
Tell an agent
Reset the APM secret token for resource {ref_id} in deployment {deployment_id}.
Rotate the APM token on deployment {deployment_id}, resource {ref_id}.
GET /deployments/{deployment_id}/appsearch/{ref_id} Get a deployment's App Search resource info · Get Deployment App Search Resource Info #
Ask an LLM
“How do I see the details of the App Search resource in a deployment?”
“Can I include the plan log for my App Search resource?”
Tell an agent
Get App Search resource {ref_id} in deployment {deployment_id}.
Show App Search resource {ref_id} of deployment {deployment_id} with plan logs.
GET /deployments/{deployment_id}/appsearch/{ref_id}/read_only_mode Check App Search read-only status · Set AppSearch read-only status #
Ask an LLM
“Is my App Search resource currently in read-only mode?”
“How can I check whether App Search writes are blocked?”
Tell an agent
Check whether App Search resource {ref_id} in deployment {deployment_id} is read-only.
Get the read-only status of App Search on deployment {deployment_id}, resource {ref_id}.
PUT /deployments/{deployment_id}/appsearch/{ref_id}/read_only_mode Turn App Search read-only mode on or off · Set AppSearch read-only status #
Ask an LLM
“How do I put App Search into read-only mode?”
“Can I switch App Search back to accepting writes?”
Tell an agent
Set App Search read-only mode to {enabled} for resource {ref_id} in deployment {deployment_id}.
Enable read-only mode on App Search resource {ref_id} of deployment {deployment_id}.
GET /deployments/{deployment_id}/certificate-authority Get a deployment's certificate authority · Get certificate authority #
Ask an LLM
“Which certificate authority signs my deployment's certificates?”
“How do I download the CA certificate for a deployment?”
Tell an agent
Get the certificate authority for deployment {deployment_id}.
Fetch the CA used to sign certificates on deployment {deployment_id}.
GET /deployments/{deployment_id}/elasticsearch/{ref_id} Get a deployment's Elasticsearch resource info · Get Deployment Elasticsearch Resource Info #
Ask an LLM
“How do I see the details of the Elasticsearch cluster inside a deployment?”
“Can I include system alerts and security settings for the Elasticsearch resource?”
Tell an agent
Get Elasticsearch resource {ref_id} in deployment {deployment_id}.
Show system alerts for Elasticsearch resource {ref_id} of deployment {deployment_id}.
POST /deployments/{deployment_id}/elasticsearch/{ref_id}/_enable-ccr Migrate Elasticsearch and Kibana to enable CCR · Migrate Elasticsearch and associated Kibana resources to enable CCR #
Ask an LLM
“How do I enable cross-cluster replication on an existing deployment?”
“Can I validate a CCR migration before running it?”
Tell an agent
Enable cross-cluster replication for Elasticsearch resource {ref_id} in deployment {deployment_id}.
Validate the CCR migration for deployment {deployment_id}, resource {ref_id}, without applying it.
POST /deployments/{deployment_id}/elasticsearch/{ref_id}/_enable-ilm Migrate an Elasticsearch resource to ILM · Migrate Elasticsearch resource to use ILM #
Ask an LLM
“How do I switch an Elasticsearch cluster over to index lifecycle management?”
“Which index patterns do I need to supply when migrating to ILM?”
Tell an agent
Migrate Elasticsearch resource {ref_id} in deployment {deployment_id} to ILM for index patterns {index_patterns}.
Turn on index lifecycle management for deployment {deployment_id} resource {ref_id} covering {index_patterns}.
POST /deployments/{deployment_id}/elasticsearch/{ref_id}/_enable-slm Migrate an Elasticsearch resource to SLM · Migrate Elasticsearch resource to use SLM #
Ask an LLM
“How do I move a cluster's snapshots onto snapshot lifecycle management?”
“Can I check that an SLM migration would succeed before doing it?”
Tell an agent
Migrate Elasticsearch resource {ref_id} in deployment {deployment_id} to SLM.
Validate switching deployment {deployment_id} resource {ref_id} to snapshot lifecycle management.
POST /deployments/{deployment_id}/elasticsearch/{ref_id}/_reset-password Reset the elastic superuser password · Reset 'elastic' user password #
Ask an LLM
“I lost the elastic user password — how do I reset it?”
“Can I generate a new password for the built-in elastic superuser?”
Tell an agent
Reset the elastic user password for resource {ref_id} in deployment {deployment_id}.
Generate a new elastic superuser password on deployment {deployment_id}, cluster {ref_id}.
POST /deployments/{deployment_id}/elasticsearch/{ref_id}/_restart Restart a deployment's Elasticsearch cluster · Restart Deployment Elasticsearch Resource #
Ask an LLM
“How do I restart the Elasticsearch cluster in a deployment?”
“Can I restart Elasticsearch one availability zone at a time?”
Tell an agent
Restart Elasticsearch resource {ref_id} in deployment {deployment_id}.
Restart Elasticsearch {ref_id} on deployment {deployment_id} grouped by {group_attribute}.
POST /deployments/{deployment_id}/elasticsearch/{ref_id}/_shutdown Shut down a deployment's Elasticsearch cluster · Shutdown Deployment Elasticsearch Resource #
Ask an LLM
“How do I shut down only the Elasticsearch cluster of a deployment?”
“Can I skip the snapshot when shutting down Elasticsearch?”
Tell an agent destructive · confirm first
Shut down Elasticsearch resource {ref_id} in deployment {deployment_id}.
Shut down Elasticsearch {ref_id} on deployment {deployment_id} without taking a snapshot.
POST /deployments/{deployment_id}/elasticsearch/{ref_id}/eligible-remote-clusters List remote clusters eligible for one cluster · Get eligible remote clusters #
Ask an LLM
“Which deployments could I connect as remote clusters to this specific Elasticsearch cluster?”
“How do I find remote cluster candidates for my existing cluster?”
Tell an agent
List eligible remote clusters for Elasticsearch resource {ref_id} in deployment {deployment_id}.
Find deployments that can be remotes for cluster {ref_id} on deployment {deployment_id}.
POST /deployments/{deployment_id}/elasticsearch/{ref_id}/instances/{instance_ids}/_move Move Elasticsearch instances to another allocator · Move Elasticsearch resource instances #
Ask an LLM
“How do I move Elasticsearch instances off an allocator?”
“Can I force-move instances even when they are down?”
Tell an agent
Move instances {instance_ids} of Elasticsearch resource {ref_id} in deployment {deployment_id} to another allocator.
Force-move Elasticsearch instances {instance_ids} on deployment {deployment_id}, resource {ref_id}.
GET /deployments/{deployment_id}/elasticsearch/{ref_id}/keystore List Elasticsearch keystore entries · Get the items in the Elasticsearch resource keystore #
Ask an LLM
“What secure settings are stored in my Elasticsearch keystore?”
“Can I see keystore keys without exposing their values?”
Tell an agent
List keystore entries for Elasticsearch resource {ref_id} in deployment {deployment_id}.
Show the keystore fields on deployment {deployment_id}, cluster {ref_id}.
PATCH /deployments/{deployment_id}/elasticsearch/{ref_id}/keystore Add or remove Elasticsearch keystore secrets · Add or remove items from the Elasticsearch resource keystore #
Ask an LLM
“How do I add a secure setting to the Elasticsearch keystore?”
“Can I remove a secret from the keystore of my cluster?”
Tell an agent
Add secrets {secrets} to the keystore of Elasticsearch {ref_id} in deployment {deployment_id}.
Update the keystore on deployment {deployment_id}, cluster {ref_id}, with {secrets}.
GET /deployments/{deployment_id}/elasticsearch/{ref_id}/remote-clusters List certificate-based remote clusters · Get certificate based remote clusters #
Ask an LLM
“Which certificate-based remote clusters are configured on my cluster?”
“How do I see the remote clusters already linked to an Elasticsearch resource?”
Tell an agent
List certificate-based remote clusters for Elasticsearch {ref_id} in deployment {deployment_id}.
Show configured remote clusters on deployment {deployment_id}, resource {ref_id}.
PUT /deployments/{deployment_id}/elasticsearch/{ref_id}/remote-clusters Set certificate-based remote clusters · Set certificate based remote clusters #
Ask an LLM
“How do I configure certificate-based remote clusters for cross-cluster search?”
“Does setting remote clusters replace the existing list?”
Tell an agent
Set remote clusters {resources} on Elasticsearch {ref_id} in deployment {deployment_id}.
Overwrite the remote cluster list for deployment {deployment_id}, resource {ref_id}, with {resources}.
GET /deployments/{deployment_id}/elasticsearch/{ref_id}/snapshot/repository List attached snapshot repositories · List the attached snapshot repositories #
Ask an LLM
“Which other deployments' snapshot repositories can my cluster read from?”
“How do I see snapshot repositories linked to a deployment?”
Tell an agent
List attached snapshot repositories for Elasticsearch {ref_id} in deployment {deployment_id}.
Show linked snapshot repositories on deployment {deployment_id}, cluster {ref_id}.
POST /deployments/{deployment_id}/elasticsearch/{ref_id}/snapshot/repository Link another deployment's snapshot repository · Create a snapshot repository for Elasticsearch resource #
Ask an LLM
“How do I let my cluster access snapshots from another deployment?”
“Can I attach a source deployment's snapshots to a new cluster?”
Tell an agent
Attach snapshots from deployment {source_deployment_id} to Elasticsearch {ref_id} in deployment {deployment_id}.
Create a snapshot repository link on deployment {deployment_id}, resource {ref_id}, sourced from {source_deployment_id}.
DELETE /deployments/{deployment_id}/elasticsearch/{ref_id}/snapshot/repository/{repository_name} Remove an attached snapshot repository · Remove the attached snapshot repository #
Ask an LLM
“How do I detach a snapshot repository from my deployment?”
“Can I remove a linked repository that searchable snapshots still use?”
Tell an agent destructive · confirm first
Remove snapshot repository {repository_name} from Elasticsearch {ref_id} in deployment {deployment_id}.
Detach repository {repository_name} from deployment {deployment_id}, cluster {ref_id}.
GET /deployments/{deployment_id}/elasticsearch/{ref_id}/tiers Get Elasticsearch tier sizes and zones · Get Elasticsearch tiers #
Ask an LLM
“How much memory and how many zones does each data tier have?”
“What sizes are available for my hot, warm and cold tiers?”
Tell an agent
Show the Elasticsearch tiers for resource {ref_id} in deployment {deployment_id}.
Get tier memory sizes and zone counts on deployment {deployment_id}, cluster {ref_id}.
PATCH /deployments/{deployment_id}/elasticsearch/{ref_id}/tiers Resize Elasticsearch data tiers · Update Elasticsearch tiers #
Ask an LLM
“How do I scale up the hot tier of my cluster?”
“Can I change the zone count of the warm tier?”
Tell an agent
Resize the hot tier of Elasticsearch {ref_id} in deployment {deployment_id} to {hot_content}.
Set the warm tier on deployment {deployment_id}, cluster {ref_id}, to {warm}.
GET /deployments/{deployment_id}/enterprise_search/{ref_id} Get a deployment's Enterprise Search resource info · Get Deployment Enterprise Search Resource Info #
Ask an LLM
“Where can I inspect the Enterprise Search component running in my deployment?”
“Can I view the Enterprise Search plan defaults?”
Tell an agent
Get Enterprise Search resource {ref_id} in deployment {deployment_id}.
Show Enterprise Search {ref_id} plan defaults for deployment {deployment_id}.
GET /deployments/{deployment_id}/heap_dumps List heap dumps for a deployment · Get details about heap dumps for a Deployment #
Ask an LLM
“Which heap dumps exist or are being captured for my deployment?”
“How do I check the progress of an on-demand heap dump?”
Tell an agent
List heap dumps for deployment {deployment_id}.
Show in-progress heap dump captures on deployment {deployment_id}.
GET /deployments/{deployment_id}/integrations_server/{ref_id} Get a deployment's Integrations Server info · Get Deployment Integrations Server Resource Info #
Ask an LLM
“How do I see the details of the Integrations Server in my deployment?”
“Can I view the Integrations Server's current settings?”
Tell an agent
Get Integrations Server resource {ref_id} in deployment {deployment_id}.
Show Integrations Server {ref_id} metadata for deployment {deployment_id}.
GET /deployments/{deployment_id}/kibana/{ref_id} Get a deployment's Kibana resource info · Get Deployment Kibana Resource Info #
Ask an LLM
“How do I see the details of the Kibana instance in a deployment?”
“Can I view Kibana's plan history for a deployment?”
Tell an agent
Get Kibana resource {ref_id} in deployment {deployment_id}.
Show Kibana {ref_id} plan history on deployment {deployment_id}.
GET /deployments/{deployment_id}/migrate_template Build a request to switch deployment template · Build request to migrate deployment to a different template #
Ask an LLM
“How do I move a deployment to a different deployment template?”
“What would the update request look like to migrate to another template?”
Tell an agent
Build the migration request to move deployment {deployment_id} to template {template_id}.
Preview migrating deployment {deployment_id} onto template {template_id}.
GET /deployments/{deployment_id}/tags Get a deployment's tags · Get the tags for a Deployment #
Ask an LLM
“What tags are on my deployment?”
“How can I read the labels attached to a deployment?”
Tell an agent
Get the tags for deployment {deployment_id}.
Show the labels on deployment {deployment_id}.
PUT /deployments/{deployment_id}/tags Replace a deployment's tags · Set the tags for a Deployment #
Ask an LLM
“How do I tag a deployment?”
“Does setting tags overwrite the ones already on the deployment?”
Tell an agent
Set the tags on deployment {deployment_id} to {tags}.
Replace all tags on deployment {deployment_id} with {tags}.
POST /deployments/{deployment_id}/upgrade Upgrade a deployment's Elastic Stack version · Upgrade a Deployment to a new Elastic Stack version #
Ask an LLM
“How do I upgrade my whole deployment to a newer Elastic Stack version?”
“Does the upgrade cover Kibana and APM as well as Elasticsearch?”
Tell an agent
Upgrade deployment {deployment_id} to version {target_version}.
Move all resources in deployment {deployment_id} to Elastic Stack {target_version}.
GET /deployments/{deployment_id}/upgrade_assistant/status Check upgrade readiness for a deployment · Get Deployment upgrade assistant status #
Ask an LLM
“Is my deployment ready to upgrade to the next version?”
“What does the upgrade assistant report for my cluster?”
Tell an agent
Get the upgrade assistant status for deployment {deployment_id}.
Check upgrade readiness of deployment {deployment_id} for version {target_version}.
POST /deployments/{deployment_id}/{resource_kind}/{ref_id}/_restore Restore one shut-down resource · Restores a shutdown resource #
Ask an LLM
“How do I restore a single resource that was shut down, like Kibana?”
“Can I bring back just one component of a deployment from snapshot?”
Tell an agent
Restore the {resource_kind} resource {ref_id} in deployment {deployment_id}.
Bring back shut-down {resource_kind} {ref_id} on deployment {deployment_id} from snapshot.
GET /deployments/{deployment_id}/{resource_kind}/{ref_id}/activity/{attempt_id} Get a single plan activity attempt · Get plan activity #
Ask an LLM
“How do I see what happened during a specific plan change attempt?”
“Where can I find the details of one plan attempt for a resource?”
Tell an agent
Get plan attempt {attempt_id} for {resource_kind} {ref_id} in deployment {deployment_id}.
Show plan activity {attempt_id} on deployment {deployment_id}, {resource_kind} {ref_id}.
POST /deployments/{deployment_id}/{resource_kind}/{ref_id}/diagnostics/_capture Capture a diagnostic bundle · Capture diagnostics for an Elasticsearch or Kibana resource #
Ask an LLM
“How do I grab a diagnostic bundle from my Elasticsearch or Kibana cluster?”
“Does the cluster need to be responsive to capture diagnostics?”
Tell an agent
Capture diagnostics for {resource_kind} {ref_id} in deployment {deployment_id}.
Collect a diagnostic bundle in {mode} mode from deployment {deployment_id}, {resource_kind} {ref_id}.
POST /deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/_start Start every instance of a resource · Start all instances #
Ask an LLM
“How do I start all instances of a deployment resource at once?”
“Can I power on every node of a stopped component?”
Tell an agent
Start all instances of {resource_kind} {ref_id} in deployment {deployment_id}.
Power on every node of {resource_kind} {ref_id} on deployment {deployment_id}.
POST /deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/_stop Stop every instance of a resource · Stop all instances #
Ask an LLM
“How do I stop all instances of a deployment resource at once?”
“Can I halt every node of a component in one call?”
Tell an agent
Stop all instances of {resource_kind} {ref_id} in deployment {deployment_id}.
Halt every node of {resource_kind} {ref_id} on deployment {deployment_id}.
POST /deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/maintenance-mode/_start Put all instances into maintenance mode · Start maintenance mode (all instances) #
Ask an LLM
“How do I put every instance of a resource into maintenance mode?”
“Can I enable maintenance mode across a whole component?”
Tell an agent
Start maintenance mode on all instances of {resource_kind} {ref_id} in deployment {deployment_id}.
Put every node of {resource_kind} {ref_id} on deployment {deployment_id} into maintenance.
POST /deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/maintenance-mode/_stop Take all instances out of maintenance mode · Stop maintenance mode (all instances) #
Ask an LLM
“How do I end maintenance mode for every instance of a resource?”
“Can I bring a whole component out of maintenance in one step?”
Tell an agent
Stop maintenance mode on all instances of {resource_kind} {ref_id} in deployment {deployment_id}.
Take every node of {resource_kind} {ref_id} on deployment {deployment_id} out of maintenance.
PUT /deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/overrides Override size for all instances of a resource · Set size overrides #
Ask an LLM
“How do I temporarily bump capacity on every instance of a resource?”
“Do instance size overrides survive the next plan change?”
Tell an agent
Override capacity to {capacity} for all instances of {resource_kind} {ref_id} in deployment {deployment_id}.
Set a storage multiplier of {storage_multiplier} across every node of {resource_kind} {ref_id} on deployment {deployment_id}.
POST /deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_ids}/_start Start specific instances of a resource · Start instances #
Ask an LLM
“How do I start only certain instances of a resource?”
“Can I start selected nodes and ignore ones that are missing?”
Tell an agent
Start instances {instance_ids} of {resource_kind} {ref_id} in deployment {deployment_id}.
Power on just nodes {instance_ids} on deployment {deployment_id}, {resource_kind} {ref_id}.
POST /deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_ids}/_stop Stop specific instances of a resource · Stop instances #
Ask an LLM
“How do I stop only certain instances of a resource?”
“Can I stop selected nodes without touching the rest?”
Tell an agent
Stop instances {instance_ids} of {resource_kind} {ref_id} in deployment {deployment_id}.
Halt just nodes {instance_ids} on deployment {deployment_id}, {resource_kind} {ref_id}.
POST /deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_ids}/maintenance-mode/_start Put specific instances into maintenance mode · Start maintenance mode #
Ask an LLM
“How do I put just a few instances into maintenance mode?”
“Can I enable maintenance mode on selected nodes only?”
Tell an agent
Enable maintenance mode only for nodes {instance_ids} of {resource_kind} {ref_id} in deployment {deployment_id}.
Put nodes {instance_ids} of deployment {deployment_id}, {resource_kind} {ref_id}, into maintenance.
POST /deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_ids}/maintenance-mode/_stop Take specific instances out of maintenance mode · Stop maintenance mode #
Ask an LLM
“How do I end maintenance mode on just a few instances?”
“Can I bring selected nodes back out of maintenance?”
Tell an agent
Disable maintenance mode only for nodes {instance_ids} of {resource_kind} {ref_id} in deployment {deployment_id}.
Take nodes {instance_ids} of deployment {deployment_id}, {resource_kind} {ref_id}, out of maintenance.
PUT /deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_ids}/overrides Override size for specific instances · Set size overrides #
Ask an LLM
“How do I give just one or two instances more capacity temporarily?”
“Can I restart selected instances after overriding their size?”
Tell an agent
Give only nodes {instance_ids} of {resource_kind} {ref_id} in deployment {deployment_id} a temporary capacity of {capacity}.
Set storage multiplier {storage_multiplier} on nodes {instance_ids} of deployment {deployment_id}, {resource_kind} {ref_id}.
POST /deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_id}/heap_dump/_capture Capture an on-demand heap dump · Capture a new on-demand heap dump for the given instance #
Ask an LLM
“How do I take a heap dump of a single instance that is using too much memory?”
“Is heap dump capture asynchronous?”
Tell an agent
Capture a heap dump of instance {instance_id} in {resource_kind} {ref_id} of deployment {deployment_id}.
Start a new heap dump on node {instance_id} for deployment {deployment_id}, {resource_kind} {ref_id}.
GET /deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_id}/heap_dump/_download Download an instance's heap dump · Download the given instance's heap dump #
Ask an LLM
“How do I download a heap dump once it has been captured?”
“Can I fetch the heap dump file for one instance?”
Tell an agent
Download the heap dump of instance {instance_id} in {resource_kind} {ref_id} of deployment {deployment_id}.
Fetch node {instance_id}'s heap dump file from deployment {deployment_id}, {resource_kind} {ref_id}.
POST /deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_id}/thread_dump/_capture Capture a thread dump from an instance · Capture a new thread dump for the given instance #
Ask an LLM
“How do I get a thread dump from a stuck instance?”
“Does a thread dump capture return its contents right away?”
Tell an agent
Capture a thread dump of instance {instance_id} in {resource_kind} {ref_id} of deployment {deployment_id}.
Take a thread dump on node {instance_id} for deployment {deployment_id}, {resource_kind} {ref_id}.
POST /deployments/{deployment_id}/{resource_kind}/{ref_id}/metadata/raw Overwrite a resource's internal metadata · Set a Deployment's resource metadata #
Ask an LLM
“How do I replace the raw internal metadata JSON on a deployment resource?”
“Can I set resource metadata only if the version still matches?”
Tell an agent
Overwrite the raw metadata of {resource_kind} {ref_id} in deployment {deployment_id}.
Set raw metadata on deployment {deployment_id}, {resource_kind} {ref_id}, at version {version}.
PATCH /deployments/{deployment_id}/{resource_kind}/{ref_id}/metadata/raw Patch a resource's internal metadata · Patch a Deployment's resource metadata #
Ask an LLM
“How do I merge a small change into a resource's raw metadata?”
“Can I patch internal metadata without replacing all of it?”
Tell an agent
Patch the raw metadata of {resource_kind} {ref_id} in deployment {deployment_id}.
Apply a partial metadata change to deployment {deployment_id}, {resource_kind} {ref_id}.
DELETE /deployments/{deployment_id}/{resource_kind}/{ref_id}/plan/pending Cancel a resource's pending plan · Cancel resource pending plan #
Ask an LLM
“How do I cancel a plan change that is stuck in progress?”
“Can I force-delete a pending plan on a resource?”
Tell an agent destructive · confirm first
Cancel the pending plan for {resource_kind} {ref_id} in deployment {deployment_id}.
Force-cancel the in-progress plan on deployment {deployment_id}, {resource_kind} {ref_id}.
GET /deployments/{deployment_id}/{resource_kind}/{ref_id}/proxy/{proxy_path} Proxy a GET request to a deployment resource · Proxy HTTP GET request #
Ask an LLM
“How do I send a GET call straight through to my cluster's API for management?”
“What header is required when proxying reads to a deployment resource?”
Tell an agent
Proxy a GET to {proxy_path} on {resource_kind} {ref_id} in deployment {deployment_id} with management header {X-Management-Request}.
Read {proxy_path} from deployment {deployment_id}'s {resource_kind} {ref_id} through the proxy.
POST /deployments/{deployment_id}/{resource_kind}/{ref_id}/proxy/{proxy_path} Proxy a POST request to a deployment resource · Proxy HTTP POST request #
Ask an LLM
“Can I submit a POST body to my cluster's API through the deployment proxy?”
“Can I run a management POST against Kibana via the deployment proxy?”
Tell an agent
Proxy a POST to {proxy_path} on {resource_kind} {ref_id} in deployment {deployment_id} with management header {X-Management-Request}.
Send a proxied POST to {proxy_path} on deployment {deployment_id}'s {resource_kind} {ref_id}.
PUT /deployments/{deployment_id}/{resource_kind}/{ref_id}/proxy/{proxy_path} Proxy a PUT request to a deployment resource · Proxy HTTP PUT request #
Ask an LLM
“How do I send a PUT call through the proxy to my cluster?”
“Can I update a cluster setting via a proxied PUT?”
Tell an agent
Proxy a PUT to {proxy_path} on {resource_kind} {ref_id} in deployment {deployment_id} with management header {X-Management-Request}.
Send a proxied PUT to {proxy_path} on deployment {deployment_id}'s {resource_kind} {ref_id}.
DELETE /deployments/{deployment_id}/{resource_kind}/{ref_id}/proxy/{proxy_path} Proxy a DELETE request to a deployment resource · Proxy HTTP DELETE request #
Ask an LLM
“What's the way to issue a DELETE against my cluster's API via the deployment proxy?”
“Can I remove something on the cluster via a proxied DELETE?”
Tell an agent destructive · confirm first
Proxy a DELETE to {proxy_path} on {resource_kind} {ref_id} in deployment {deployment_id} with management header {X-Management-Request}.
Send a proxied DELETE to {proxy_path} on deployment {deployment_id}'s {resource_kind} {ref_id}.
GET /deployments/{deployment_id}/{resource_kind}/{ref_id}/user_settings Get a resource's user settings · Get the user settings of a Deployment resource #
Ask an LLM
“What custom user settings are applied to a deployment component?”
“How do I read the user-defined settings for Kibana or Elasticsearch?”
Tell an agent
Get the user settings for {resource_kind} {ref_id} in deployment {deployment_id}.
Show user-defined settings on deployment {deployment_id}, {resource_kind} {ref_id}.
PUT /deployments/{deployment_id}/{resource_kind}/{ref_id}/user_settings Replace a resource's user settings · Update user settings for a deployment resource #
Ask an LLM
“How do I change the user settings for a deployment component?”
“Will submitting an empty object clear all component-level user settings?”
Tell an agent
Replace user settings of {resource_kind} {ref_id} in deployment {deployment_id} with {user_settings}.
Overwrite component user settings on deployment {deployment_id}, {resource_kind} {ref_id}, to {user_settings}.
DELETE /deployments/{deployment_id}/{stateless_resource_kind}/{ref_id} Delete a stateless resource from a deployment · Delete Stateless Resource from Deployment #
Ask an LLM
“How do I remove Kibana or APM from a deployment entirely?”
“Does a stateless resource have to be shut down before I delete it?”
Tell an agent destructive · confirm first
Delete the {stateless_resource_kind} resource {ref_id} from deployment {deployment_id}.
Remove stateless {stateless_resource_kind} {ref_id} from deployment {deployment_id} permanently.
POST /deployments/{deployment_id}/{stateless_resource_kind}/{ref_id}/_restart Restart a stateless resource like Kibana · Restart Deployment Stateless Resource #
Ask an LLM
“How do I restart Kibana or APM in a deployment?”
“Can I cancel a pending plan while restarting a stateless resource?”
Tell an agent
Restart {stateless_resource_kind} {ref_id} in deployment {deployment_id}.
Restart stateless {stateless_resource_kind} {ref_id} on deployment {deployment_id}, cancelling any pending plan.
POST /deployments/{deployment_id}/{stateless_resource_kind}/{ref_id}/_shutdown Shut down a stateless resource · Shutdown Deployment Stateless Resource #
Ask an LLM
“How do I shut down APM or Enterprise Search without touching Elasticsearch?”
“Why can't Kibana be shut down on Elasticsearch Service?”
Tell an agent destructive · confirm first
Shut down {stateless_resource_kind} {ref_id} in deployment {deployment_id}.
Shut down stateless {stateless_resource_kind} {ref_id} on deployment {deployment_id} and hide it.

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:elk-stack-deployments-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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.

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://artifacts.apis.io/elk-stack/openapi/elk-stack-deployments-api-openapi.yml