Skip to content

List Api Keys

GET
/api/v1/api-keys
curl --request GET \
--url 'https://api.qeychain.xyz/api/v1/api-keys?page=1&per_page=50&include_inactive=false'

List all API keys.

Note: Key values are never returned, only prefixes and metadata.

Requires: admin:api-keys permission

page
Page

Page number

integer
default: 1 >= 1

Page number

per_page
Per Page

Items per page

integer
default: 50 >= 1 <= 100

Items per page

include_inactive
Include Inactive

Include inactive/revoked keys

boolean

Include inactive/revoked keys

Successful Response

Media typeapplication/json
Response List Api Keys Api V1 Api Keys Get
object
key
additional properties
any
Examplegenerated
{}

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
"detail": [
{
"loc": [
"example"
],
"msg": "example",
"type": "example"
}
]
}