A newer version is available. For the latest information, see the
current release documentation.
Reset elastic user password
editReset elastic user password
editResets the password of the 'elastic' user.
Request
editPOST /api/v1/deployments/{deployment_id}/elasticsearch/{ref_id}/_reset-password
Path parameters
edit| Name | Type | Required | Description |
|---|---|---|---|
|
|
Y |
Identifier for the Deployment. |
|
|
Y |
User-specified RefId for the Resource. |
Responses
edit-
200 -
(
ElasticsearchElasticUserPasswordResetResponse)The password reset was out carried successfully
-
404 -
-
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
-
The Deployment specified by {deployment_id} cannot be found. (code:
-
449 -
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 -
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 example
editcurl -XPOST https://{{hostname}}/api/v1/deployments/{deployment_id}/elasticsearch/{ref_id}/_reset-password \
-H "Authorization: ApiKey $ECE_API_KEY"