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 a user API keyedit
Retrieves the API key metadata for a user.
Requestedit
GET /api/v1/users/{user_id}/auth/keys/{api_key_id}
Path parametersedit
Name | Type | Required | Description |
---|---|---|---|
|
|
Y |
The API Key ID. |
|
|
Y |
The user ID. |
Responsesedit
-
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
-
Request exampleedit
curl -XGET https://{{hostname}}/api/v1/users/{user_id}/auth/keys/{api_key_id} \ -H "Authorization: ApiKey $ECE_API_KEY"