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.
Get API key
editGet API key
editRetrieves the metadata for an API key.
Request
editGET /api/v1/users/auth/keys/{api_key_id}
Path parameters
edit| Name | Type | Required | Description |
|---|---|---|---|
|
|
Y |
The API Key ID. |
Responses
edit-
200 -
(
ApiKeyResponse) The API key metadata is retrieved. -
404 -
(
BasicFailedReply) The {api_key_id} can't be found. (code:api_keys.key_not_found)Headers
-
x-cloud-error-codes(string; allowed values: [api_keys.key_not_found]) - The error codes associated with the response
-
To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.
Request example
editcurl -XGET {{hostname}}/api/v1/users/auth/keys/{api_key_id} \
-H "Authorization: ApiKey $ECE_API_KEY"