/api/v1/api-keys/{id} (GET)

GET

/api/v1/api-keys/{id}

curl --request GET \
  --url https://example.com/api/v1/api-keys/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Authorizations

• Bearer

Parameters

Path Parameters

id

required

string format: uuid

Responses

200

OK

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

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

Example

{
  "status": "Active"
}

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

Example

{
  "status": "Active"
}

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"
}

404

Not Found

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"
}