Get API key

edit

Retrieves the metadata for an API key.

Request

edit

GET /api/v1/users/auth/keys/{api_key_id}

Path parameters

edit
Name Type Required Description

api_key_id

string

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

edit
curl -XGET https://{{hostname}}/api/v1/users/auth/keys/{api_key_id} \
-H "Authorization: ApiKey $ECE_API_KEY"