API Key List
GET/api/v1/apikey/list
List API keys for the requesting team.
Request​
Responses​
- 200
- 500
OK
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
api_key Api Key (string)nullablerequired
The API key. Will be null
unless the key was created during the request. Keys are not stored in plaintext and can not be recovered after creation time.
date_created date-timerequired
The date that the API key was created.
date_expires date-timenullablerequired
The date that the API key will automatically expire.
date_last_used date-timenullablerequired
The last time that the API key was used to authenticate with the API.
id uuid4required
The database ID for the API key. Used when deleting keys.
name Name (string)required
The human-readable name for the API key used for managing keys.
prefix Prefix (string)required
The non-secret key prefix.
suffix Suffix (string)required
The non-secret key suffix. Helpful for identifying keys if a name wasn't specified at creation time.
[
{
"api_key": "string",
"date_created": "2024-11-21T14:57:17.518Z",
"date_expires": "2024-11-21T14:57:17.518Z",
"date_last_used": "2024-11-21T14:57:17.518Z",
"id": "string",
"name": "string",
"prefix": "string",
"suffix": "string"
}
]
Internal Server Error
- application/json
- Schema
- Example (from schema)
Schema
error Error (string)required
message Message (string)
Default value: An internal error occurred.
{
"error": "string",
"message": "An internal error occurred."
}
Loading...