Get API key

开发环境

http://127.0.0.1

GET

/users/auth/keys/{api_key_id}

Authentication

Retrieves the metadata for an API key.

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET 'http://127.0.0.1/users/auth/keys/' \
--header 'Authorization: ApiKey {{EC_API_KEY}}'

响应示例

200 - 示例 1

{
    "creation_date": "2019-08-24T14:15:22Z",
    "user_id": "string",
    "id": "string",
    "key": "string",
    "description": "string"
}

请求参数

Path 参数

api_key_id

必需

The API Key ID.

Header 参数

Authorization

string

可选

默认值:

ApiKey {{EC_API_KEY}}

返回响应

🟢200The API key metadata is retrieved.

application/json

Body

The response model for an API key.

creation_date

string <date-time>

必需

The date/time for when the API key is created.

user_id

string

可选

The user ID.

string

必需

The API key ID.

key

string

可选

The API key. TIP: Since the API key is returned only once, save it in a safe place.

description

string

必需

The API key description. TIP: Useful when you have multiple API keys.

🟠404The {api_key_id} can't be found. (code: `api_keys.key_not_found`)

Delete API key

Create API key