/api/v1/api-keys (GET)

GET

/api/v1/api-keys

curl --request GET \
  --url https://example.com/api/v1/api-keys \
  --header 'Authorization: Bearer <token>'

Authorizations

• Bearer

Parameters

Query Parameters

Page

integer format: int32

PageSize

integer format: int32

Sort

string

Responses

200

OK

object

items

required

Array<object>

object

id

required

string format: uuid

name

required

string

keyPrefix

required

string

permissions

required

Array<string>

status

required

string

Allowed values: Active Expired Inactive

createdAt

required

string format: date-time

createdByUserId

required

string format: uuid

nullable

lastUsedAt

required

string format: date-time

nullable

expiresAt

required

string format: date-time

nullable

page

required

integer format: int32

pageSize

required

integer format: int32

totalCount

required

integer format: int32

object

items

required

Array<object>

object

id

required

string format: uuid

name

required

string

keyPrefix

required

string

permissions

required

Array<string>

status

required

string

Allowed values: Active Expired Inactive

createdAt

required

string format: date-time

createdByUserId

required

string format: uuid

nullable

lastUsedAt

required

string format: date-time

nullable

expiresAt

required

string format: date-time

nullable

page

required

integer format: int32

pageSize

required

integer format: int32

totalCount

required

integer format: int32

Example

{
  "items": [
    {
      "status": "Active"
    }
  ]
}

object

items

required

Array<object>

object

id

required

string format: uuid

name

required

string

keyPrefix

required

string

permissions

required

Array<string>

status

required

string

Allowed values: Active Expired Inactive

createdAt

required

string format: date-time

createdByUserId

required

string format: uuid

nullable

lastUsedAt

required

string format: date-time

nullable

expiresAt

required

string format: date-time

nullable

page

required

integer format: int32

pageSize

required

integer format: int32

totalCount

required

integer format: int32

Example

{
  "items": [
    {
      "status": "Active"
    }
  ]
}

400

Bad Request

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

403

Forbidden

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}