A newer version is available. For the latest information, see the
current release documentation.
Refresh authentication token
edit
IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.
Refresh authentication token
editIssues a new authentication token.
Request
editPOST /api/v1/users/auth/_refresh
Responses
edit-
200 -
The token refreshed successfully and was returned in the body of the response.
-
401 -
The authentication token is invalid or expired. (code:
root.unauthorized)Headers
-
x-cloud-error-codes(string; allowed values: [root.unauthorized]) - The error codes associated with the response
-
-
501 -
The administrator needs to configure the authentication cluster. (code:
authc.no_authentication_cluster)Headers
-
x-cloud-error-codes(string; allowed values: [authc.no_authentication_cluster]) - The error codes associated with the response
-
-
502 -
The authentication cluster failed to process the request. The response body contains details about the error. (code:
authc.authentication_cluster_error)Headers
-
x-cloud-error-codes(string; allowed values: [authc.authentication_cluster_error]) - The error codes associated with the response
-
Request example
editcurl -XPOST https://{{hostname}}/api/v1/users/auth/_refresh \
-H "Authorization: ApiKey $ECE_API_KEY"