It is time to say goodbye: This version of Elastic Cloud Enterprise has reached end-of-life (EOL) and is no longer supported.
The documentation for this version is no longer being maintained. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.
Refresh authentication token
editRefresh authentication token
editIssues a new authentication token.
Request
editPOST /api/v1/users/auth/_refresh
Responses
edit-
200
-
(
TokenResponse
) The token refreshed successfully and was returned in the body of the response. -
401
-
(
BasicFailedReply
) 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
-
(
BasicFailedReply
) 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
-
(
BasicFailedReply
) 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"