A newer version is available. For the latest information, see the current release documentation.
Elastic Docs ›Elastic Cloud Enterprise Reference [2.9] ›RESTful API ›API reference ›Deployment - Commands
« Migrate Elasticsearch resource to use ILM Reset elastic user password »

Migrate Elasticsearch resource to use SLMedit

Migrates the specified Elasticsearch resource to use SLM.

Requestedit

POST /api/v1/deployments/{deployment_id}/elasticsearch/{ref_id}/_enable-slm

Path parametersedit

Name Type Required Description

deployment_id

string

Y

Identifier for the Deployment.

ref_id

string

Y

User-specified RefId for the Resource.

Query parametersedit

Name Type Required Description

validate_only

boolean; default: false

N

When true, does not enable SLM but returns warnings if any applications may lose availability during SLM migration.

Responsesedit

200

(DeploymentResourceCommandResponse) Standard response

404

(BasicFailedReply) * The Deployment specified by {deployment_id} cannot be found. (code: deployments.deployment_not_found) * The Resource specified by {ref_id} cannot be found. (code: deployments.deployment_resource_not_found)

Headers

x-cloud-error-codes (string; allowed values: [deployments.deployment_not_found, deployments.deployment_resource_not_found])
The error codes associated with the response
449

(BasicFailedReply) Elevated permissions are required. (code: root.unauthorized.rbac.elevated_permissions_required)

Headers

x-cloud-error-codes (string; allowed values: [root.unauthorized.rbac.elevated_permissions_required])
The error codes associated with the response
500

(BasicFailedReply) We have failed you. (code: deployments.deployment_resource_no_longer_exists)

Headers

x-cloud-error-codes (string; allowed values: [deployments.deployment_resource_no_longer_exists])
The error codes associated with the response

Request exampleedit

curl -XPOST https://{{hostname}}/api/v1/deployments/{deployment_id}/elasticsearch/{ref_id}/_enable-slm \
-H "Authorization: ApiKey $ECE_API_KEY"
« Migrate Elasticsearch resource to use ILM Reset elastic user password »