Reset 'elastic' user password
Base URL
https://api.elastic-cloud.com/api/v1
No auth
Resets the password of the 'elastic' user.
Expand all
deployment_id
string required
Identifier for the Deployment.
ref_id
string required
User-specified RefId for the Resource (or '_main' if there is only one).
check_completion
boolean · default: false
If true, will not reset elastic user password and instead will return a status code signaling whether or not the current credentials are ready to use (eg from creation or the last call to _reset_password)
200
The password reset was out carried successfully
application/json
username
string required
The username for the newly-reset password for the given Elasticsearch cluster
password
string required
The newly-reset password for the given Elasticsearch cluster
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)
application/json
errors
object [] required
A list of errors that occurred in the failing request
−
Hide 3 properties
code
string required
A structured code representing the error type that occurred
message
string required
A human readable message describing the error that occurred
fields
string []
If the error can be tied to a specific field or fields in the user request, this lists those fields
500
Failed to reset the 'elastic' user's password. (code: deployments.elasticsearch.password_reset_error)
application/json
errors
object [] required
A list of errors that occurred in the failing request
−
Hide 3 properties
code
string required
A structured code representing the error type that occurred
message
string required
A human readable message describing the error that occurred
fields
string []
If the error can be tied to a specific field or fields in the user request, this lists those fields