---
type: api
title: Deployments
description: Perform CRUD operations, resync, and commands on your deployments.
url: https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-enterprise/group/endpoint-deployments
resource: https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-enterprise/group/endpoint-deployments
products:
  - Elastic Cloud Enterprise
---

# Deployments

Perform CRUD operations, resync, and commands on your deployments.

- [List Deployments](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-enterprise/operation/operation-list-deployments): `GET` `/deployments`
- [Create Deployment](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-enterprise/operation/operation-create-deployment): `POST` `/deployments`
- [Resynchronize Deployments](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-enterprise/operation/operation-resync-deployments): `POST` `/deployments/_resync`
- [Search Deployments](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-enterprise/operation/operation-search-deployments): `POST` `/deployments/_search`
- [Get eligible remote clusters](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-enterprise/operation/operation-search-eligible-remote-clusters): `POST` `/deployments/eligible-remote-clusters`
- [Get eligible remote clusters](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-enterprise/operation/operation-get-deployment-es-resource-eligible-remote-clusters): `POST` `/deployments/{deployment_id}/elasticsearch/{ref_id}/eligible-remote-clusters`
- [Get Deployment](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-enterprise/operation/operation-get-deployment): `GET` `/deployments/{deployment_id}`
- [Update Deployment](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-enterprise/operation/operation-update-deployment): `PUT` `/deployments/{deployment_id}`
- [Delete Deployment](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-enterprise/operation/operation-delete-deployment): `DELETE` `/deployments/{deployment_id}`
- [Restores a shutdown Deployment](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-enterprise/operation/operation-restore-deployment): `POST` `/deployments/{deployment_id}/_restore`
- [Resynchronize Deployment](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-enterprise/operation/operation-resync-deployment): `POST` `/deployments/{deployment_id}/_resync`
- [Shuts down Deployment](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-enterprise/operation/operation-shutdown-deployment): `POST` `/deployments/{deployment_id}/_shutdown`
- [Get Deployment APM Resource Info](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-enterprise/operation/operation-get-deployment-apm-resource-info): `GET` `/deployments/{deployment_id}/apm/{ref_id}`
- [Reset the secret token for an APM resource.](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-enterprise/operation/operation-deployment-apm-reset-secret-token): `POST` `/deployments/{deployment_id}/apm/{ref_id}/_reset-token`
- [Get Deployment App Search Resource Info](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-enterprise/operation/operation-get-deployment-appsearch-resource-info): `GET` `/deployments/{deployment_id}/appsearch/{ref_id}`
- [Set AppSearch read-only status](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-enterprise/operation/operation-get-appsearch-read-only-mode): `GET` `/deployments/{deployment_id}/appsearch/{ref_id}/read_only_mode`
- [Set AppSearch read-only status](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-enterprise/operation/operation-set-appsearch-read-only-mode): `PUT` `/deployments/{deployment_id}/appsearch/{ref_id}/read_only_mode`
- [Migrate Deployment BYOK](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-enterprise/operation/operation-migrate-deployment-byok): `POST` `/deployments/{deployment_id}/byok-migration`
- [Get certificate authority](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-enterprise/operation/operation-get-deployment-certificate-authority): `GET` `/deployments/{deployment_id}/certificate-authority`
- [Get Deployment Elasticsearch Resource Info](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-enterprise/operation/operation-get-deployment-es-resource-info): `GET` `/deployments/{deployment_id}/elasticsearch/{ref_id}`
- [Migrate Elasticsearch and associated Kibana resources to enable CCR](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-enterprise/operation/operation-enable-deployment-resource-ccr): `POST` `/deployments/{deployment_id}/elasticsearch/{ref_id}/_enable-ccr`
- [Migrate Elasticsearch resource to use ILM](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-enterprise/operation/operation-enable-deployment-resource-ilm): `POST` `/deployments/{deployment_id}/elasticsearch/{ref_id}/_enable-ilm`
- [Migrate Elasticsearch resource to use SLM](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-enterprise/operation/operation-enable-deployment-resource-slm): `POST` `/deployments/{deployment_id}/elasticsearch/{ref_id}/_enable-slm`
- [Reset 'elastic' user password](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-enterprise/operation/operation-reset-elasticsearch-user-password): `POST` `/deployments/{deployment_id}/elasticsearch/{ref_id}/_reset-password`
- [Restart Deployment Elasticsearch Resource](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-enterprise/operation/operation-restart-deployment-es-resource): `POST` `/deployments/{deployment_id}/elasticsearch/{ref_id}/_restart`
- [Shutdown Deployment Elasticsearch Resource](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-enterprise/operation/operation-shutdown-deployment-es-resource): `POST` `/deployments/{deployment_id}/elasticsearch/{ref_id}/_shutdown`
- [Move Elasticsearch resource instances](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-enterprise/operation/operation-move-deployment-elasticsearch-resource-instances): `POST` `/deployments/{deployment_id}/elasticsearch/{ref_id}/instances/{instance_ids}/_move`
- [Get the items in the Elasticsearch resource keystore](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-enterprise/operation/operation-get-deployment-es-resource-keystore): `GET` `/deployments/{deployment_id}/elasticsearch/{ref_id}/keystore`
- [Add or remove items from the Elasticsearch resource keystore](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-enterprise/operation/operation-set-deployment-es-resource-keystore): `PATCH` `/deployments/{deployment_id}/elasticsearch/{ref_id}/keystore`
- [Get certificate based remote clusters](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-enterprise/operation/operation-get-deployment-es-resource-remote-clusters): `GET` `/deployments/{deployment_id}/elasticsearch/{ref_id}/remote-clusters`
- [Set certificate based remote clusters](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-enterprise/operation/operation-set-deployment-es-resource-remote-clusters): `PUT` `/deployments/{deployment_id}/elasticsearch/{ref_id}/remote-clusters`
- [List the attached snapshot repositories](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-enterprise/operation/operation-get-deployment-es-resource-snapshot-repository): `GET` `/deployments/{deployment_id}/elasticsearch/{ref_id}/snapshot/repository`
- [Create a snapshot repository for Elasticsearch resource](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-enterprise/operation/operation-create-deployment-es-resource-snapshot-repository): `POST` `/deployments/{deployment_id}/elasticsearch/{ref_id}/snapshot/repository`
- [Remove the attached snapshot repository](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-enterprise/operation/operation-delete-deployment-es-resource-snapshot-repository): `DELETE` `/deployments/{deployment_id}/elasticsearch/{ref_id}/snapshot/repository/{repository_name}`
- [Get Elasticsearch tiers](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-enterprise/operation/operation-get-deployment-es-resource-tiers): `GET` `/deployments/{deployment_id}/elasticsearch/{ref_id}/tiers`
- [Update Elasticsearch tiers](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-enterprise/operation/operation-update-deployment-es-resource-tier): `PATCH` `/deployments/{deployment_id}/elasticsearch/{ref_id}/tiers`
- [Get Deployment Enterprise Search Resource Info](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-enterprise/operation/operation-get-deployment-enterprise-search-resource-info): `GET` `/deployments/{deployment_id}/enterprise_search/{ref_id}`
- [Get details about heap dumps for a Deployment](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-enterprise/operation/operation-get-deployment-heap-dumps): `GET` `/deployments/{deployment_id}/heap_dumps`
- [Get Deployment Integrations Server Resource Info](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-enterprise/operation/operation-get-deployment-integrations-server-resource-info): `GET` `/deployments/{deployment_id}/integrations_server/{ref_id}`
- [Get Deployment Kibana Resource Info](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-enterprise/operation/operation-get-deployment-kib-resource-info): `GET` `/deployments/{deployment_id}/kibana/{ref_id}`
- [Build request to migrate deployment to a different template](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-enterprise/operation/operation-migrate-deployment-template): `GET` `/deployments/{deployment_id}/migrate_template`
- [Get the tags for a Deployment](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-enterprise/operation/operation-get-deployment-tags): `GET` `/deployments/{deployment_id}/tags`
- [Set the tags for a Deployment](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-enterprise/operation/operation-set-deployment-tags): `PUT` `/deployments/{deployment_id}/tags`
- [Upgrade a Deployment to a new Elastic Stack version](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-enterprise/operation/operation-upgrade-deployment): `POST` `/deployments/{deployment_id}/upgrade`
- [Get Deployment upgrade assistant status](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-enterprise/operation/operation-get-deployment-upgrade-assistant-status): `GET` `/deployments/{deployment_id}/upgrade_assistant/status`
- [Restores a shutdown resource](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-enterprise/operation/operation-restore-deployment-resource): `POST` `/deployments/{deployment_id}/{resource_kind}/{ref_id}/_restore`
- [Get plan activity](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-enterprise/operation/operation-get-deployment-resource-plan-activity): `GET` `/deployments/{deployment_id}/{resource_kind}/{ref_id}/activity/{attempt_id}`
- [Capture diagnostics for an Elasticsearch or Kibana resource](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-enterprise/operation/operation-capture-deployment-resource-diagnostics): `POST` `/deployments/{deployment_id}/{resource_kind}/{ref_id}/diagnostics/_capture`
- [Start all instances](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-enterprise/operation/operation-start-deployment-resource-instances-all): `POST` `/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/_start`
- [Stop all instances](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-enterprise/operation/operation-stop-deployment-resource-instances-all): `POST` `/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/_stop`
- [Start maintenance mode (all instances)](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-enterprise/operation/operation-start-deployment-resource-instances-all-maintenance-mode): `POST` `/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/maintenance-mode/_start`
- [Stop maintenance mode (all instances)](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-enterprise/operation/operation-stop-deployment-resource-instances-all-maintenance-mode): `POST` `/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/maintenance-mode/_stop`
- [Set size overrides](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-enterprise/operation/operation-set-all-instances-settings-overrides): `PUT` `/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/overrides`
- [Set size overrides](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-enterprise/operation/operation-set-instance-settings-overrides): `PUT` `/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_ids}/overrides`
- [Start instances](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-enterprise/operation/operation-start-deployment-resource-instances): `POST` `/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_ids}/_start`
- [Stop instances](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-enterprise/operation/operation-stop-deployment-resource-instances): `POST` `/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_ids}/_stop`
- [Start maintenance mode](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-enterprise/operation/operation-start-deployment-resource-maintenance-mode): `POST` `/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_ids}/maintenance-mode/_start`
- [Stop maintenance mode](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-enterprise/operation/operation-stop-deployment-resource-maintenance-mode): `POST` `/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_ids}/maintenance-mode/_stop`
- [Capture a new on-demand heap dump for the given instance](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-enterprise/operation/operation-capture-deployment-instance-heap-dump): `POST` `/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_id}/heap_dump/_capture`
- [Download the given instance's heap dump](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-enterprise/operation/operation-download-deployment-instance-heap-dump): `GET` `/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_id}/heap_dump/_download`
- [Capture a new thread dump for the given instance](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-enterprise/operation/operation-capture-deployment-instance-thread-dump): `POST` `/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_id}/thread_dump/_capture`
- [Set a Deployment's resource metadata](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-enterprise/operation/operation-set-deployment-resource-raw-metadata): `POST` `/deployments/{deployment_id}/{resource_kind}/{ref_id}/metadata/raw`
- [Patch a Deployment's resource metadata](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-enterprise/operation/operation-patch-deployment-resource-raw-metadata): `PATCH` `/deployments/{deployment_id}/{resource_kind}/{ref_id}/metadata/raw`
- [Cancel resource pending plan](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-enterprise/operation/operation-cancel-deployment-resource-pending-plan): `DELETE` `/deployments/{deployment_id}/{resource_kind}/{ref_id}/plan/pending`
- [Proxy HTTP GET request](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-enterprise/operation/operation-get-deployment-resource-proxy-requests): `GET` `/deployments/{deployment_id}/{resource_kind}/{ref_id}/proxy/{proxy_path}`
- [Proxy HTTP POST request](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-enterprise/operation/operation-post-deployment-resource-proxy-requests): `POST` `/deployments/{deployment_id}/{resource_kind}/{ref_id}/proxy/{proxy_path}`
- [Proxy HTTP PUT request](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-enterprise/operation/operation-put-deployment-resource-proxy-requests): `PUT` `/deployments/{deployment_id}/{resource_kind}/{ref_id}/proxy/{proxy_path}`
- [Proxy HTTP DELETE request](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-enterprise/operation/operation-delete-deployment-resource-proxy-requests): `DELETE` `/deployments/{deployment_id}/{resource_kind}/{ref_id}/proxy/{proxy_path}`
- [Get the user settings of a Deployment resource](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-enterprise/operation/operation-get-deployment-resource-user-settings): `GET` `/deployments/{deployment_id}/{resource_kind}/{ref_id}/user_settings`
- [Update user settings for a deployment resource](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-enterprise/operation/operation-update-deployment-resource-user-settings): `PUT` `/deployments/{deployment_id}/{resource_kind}/{ref_id}/user_settings`
- [Delete Stateless Resource from Deployment](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-enterprise/operation/operation-delete-deployment-stateless-resource): `DELETE` `/deployments/{deployment_id}/{stateless_resource_kind}/{ref_id}`
- [Restart Deployment Stateless Resource](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-enterprise/operation/operation-restart-deployment-stateless-resource): `POST` `/deployments/{deployment_id}/{stateless_resource_kind}/{ref_id}/_restart`
- [Shutdown Deployment Stateless Resource](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-enterprise/operation/operation-shutdown-deployment-stateless-resource): `POST` `/deployments/{deployment_id}/{stateless_resource_kind}/{ref_id}/_shutdown`