Docs
Elastic Cloud Enterprise Reference [2.9] » RESTful API » API reference » Deployment - Commands » Reset elastic user password
« Migrate Elasticsearch resource to use SLM Restart Deployment Elasticsearch Resource »

Reset elastic user passwordedit

Resets the password of the 'elastic' user.

Requestedit

POST /api/v1/deployments/{deployment_id}/elasticsearch/{ref_id}/_reset-password

Path parametersedit

Name Type Required Description

deployment_id

string

Y

Identifier for the Deployment.

ref_id

string

Y

User-specified RefId for the Resource.

Responsesedit

200

(ElasticsearchElasticUserPasswordResetResponse) The password reset was out carried successfully

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) Failed to reset the 'elastic' user's password. (code: deployments.elasticsearch.password_reset_error)

Headers

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

Request exampleedit

curl -XPOST https://{{hostname}}/api/v1/deployments/{deployment_id}/elasticsearch/{ref_id}/_reset-password \
-H "Authorization: ApiKey $ECE_API_KEY"
« Migrate Elasticsearch resource to use SLM Restart Deployment Elasticsearch Resource »