List All

GET /v1/api-keys/

Authentication

Requires authentication via: OAuth2PasswordBearer.

Parameters

Name	In	Type	Required	Description	Constraints
X-API-Key	header	string | null	No		nullable

Responses

200

Successful Response

application/json

Resolved schema:

{
  "type": "array",
  "items": {
    "properties": {
      "id": {
        "type": "integer",
        "title": "Id"
      },
      "key_prefix": {
        "type": "string",
        "title": "Key Prefix"
      },
      "user_id": {
        "type": "integer",
        "title": "User Id"
      },
      "status": {
        "anyOf": [
          {
            "type": "string"
          },
          {
            "type": "null"
          }
        ],
        "title": "Status"
      },
      "created_at": {
        "anyOf": [
          {
            "type": "string",
            "format": "date-time"
          },
          {
            "type": "null"
          }
        ],
        "title": "Created At"
      },
      "expires_at": {
        "anyOf": [
          {
            "type": "string",
            "format": "date-time"
          },
          {
            "type": "null"
          }
        ],
        "title": "Expires At"
      },
      "description": {
        "anyOf": [
          {
            "type": "string"
          },
          {
            "type": "null"
          }
        ],
        "title": "Description"
      },
      "full_key": {
        "anyOf": [
          {
            "type": "string"
          },
          {
            "type": "null"
          }
        ],
        "title": "Full Key"
      }
    },
    "type": "object",
    "required": [
      "id",
      "key_prefix",
      "user_id",
      "status",
      "created_at",
      "expires_at",
      "description"
    ],
    "title": "APIKeyRecordRead"
  },
  "title": "Response List All V1 Api Keys  Get"
}

Field details:

Field	Type	Required	Description	Constraints
[]	object	Yes
[].id	integer	Yes
[].key_prefix	string	Yes
[].user_id	integer	Yes
[].status	string | null	Yes		nullable
[].created_at	string | null	Yes		format=date-time, nullable
[].expires_at	string | null	Yes		format=date-time, nullable
[].description	string | null	Yes		nullable
[].full_key	string | null	No		nullable

422

Validation Error

application/json

Resolved schema:

{
  "properties": {
    "detail": {
      "items": {
        "properties": {
          "loc": {
            "items": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "type": "array",
            "title": "Location"
          },
          "msg": {
            "type": "string",
            "title": "Message"
          },
          "type": {
            "type": "string",
            "title": "Error Type"
          }
        },
        "type": "object",
        "required": [
          "loc",
          "msg",
          "type"
        ],
        "title": "ValidationError"
      },
      "type": "array",
      "title": "Detail"
    }
  },
  "type": "object",
  "title": "HTTPValidationError"
}

Field details:

Field	Type	Required	Description	Constraints
detail	array<object>	No
detail[]	object	No
detail[].loc	array<string | integer>	No
detail[].loc[]	string | integer	No
detail[].msg	string	No
detail[].type	string	No