deployments-{deployment id}-elasticsearch/{ref id}

Number of APIs: 8

1. Get Deployment Elasticsearch Resource Info

GET {{baseUrl}}/deployments/:deployment_id/elasticsearch/:ref_id?show_security=false&show_metadata=false&show_plans=true&show_plan_logs=false&show_plan_history=false&show_plan_defaults=false&convert_legacy_plans=false&show_system_alerts=0&show_settings=false&enrich_with_template=true

Get info about an Elasticsearch Resource belonging to a given Deployment.

---

2. Shutdown Deployment Elasticsearch Resource

POST {{baseUrl}}/deployments/:deployment_id/elasticsearch/:ref_id/_shutdown?hide=false&skip_snapshot=false

Shutdown Elasticsearch Resource belonging to a given Deployment.

---

3. Restart Deployment Elasticsearch Resource

POST {{baseUrl}}/deployments/:deployment_id/elasticsearch/:ref_id/_restart?restore_snapshot=true&skip_snapshot=true&cancel_pending=false&group_attribute=__zone__&shard_init_wait_time=600

Restarts an Elasticsearch Resource. If a Resource is active: this command re-applies the existing plan but applies a cluster_reboot, which issues a restart command and waits for it to complete. If a Resource is inactive: this command starts it up with the most recent successful plan.

---

4. Migrate Elasticsearch resource to use SLM

POST {{baseUrl}}/deployments/:deployment_id/elasticsearch/:ref_id/_enable-slm?validate_only=false

Migrates the specified Elasticsearch resource to use SLM.

---

5. Reset 'elastic' user password

POST {{baseUrl}}/deployments/:deployment_id/elasticsearch/:ref_id/_reset-password

Resets the password of the 'elastic' user.

---

6. Migrate Elasticsearch and associated Kibana resources to enable CCR

POST {{baseUrl}}/deployments/:deployment_id/elasticsearch/:ref_id/_enable-ccr?validate_only=false

Migrates the specified Elasticsearch resource and its associated Kibana to enable CCR (if supported).

---

7. Get eligible remote clusters

POST {{baseUrl}}/deployments/:deployment_id/elasticsearch/:ref_id/eligible-remote-clusters

Returns the list of deployments which contain eligible remote clusters for the elasticsearch resource.

---

8. Migrate Elasticsearch resource to use ILM

POST {{baseUrl}}/deployments/:deployment_id/elasticsearch/:ref_id/_enable-ilm?validate_only=false

Migrates the specified Elasticsearch resource to use ILM.

---