List API keys

OpenAPI contract

Method

GET

Path

/api/v1/api-keys

Security

jwtBearer (bearer)

Response status

200 400 401 403 404 429 500

Request and response schemas

JSON

{
  "requestBody": {},
  "responses": {
    "200": {
      "description": "API keys",
      "content": {
        "application/json": {
          "items": {
            "$ref": "#/components/schemas/ApiKeyResponse"
          },
          "type": "array"
        }
      }
    },
    "400": {
      "description": "Invalid request",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/RequestError"
        }
      }
    },
    "401": {
      "description": "Authentication required or invalid",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/SecurityError"
        }
      }
    },
    "403": {
      "description": "Authenticated but not permitted",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/SecurityError"
        }
      }
    },
    "404": {
      "description": "Requested API key was not found",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/ApiError"
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/SecurityError"
        }
      }
    },
    "500": {
      "description": "Unexpected server error",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/ApiError"
        }
      }
    }
  }
}

GET /api/v1/api-keys is JWT-only. It returns the authenticated user's key metadata: identity and scopes; effective status, disable, expiry, and revocation state; usage limit, counters, and period; normalized allowed CIDRs; and request count plus last-use time and IP. It never returns an API-key secret.

Responses are marked Cache-Control: no-store. An nfy_ automation key cannot list keys, including its own. Missing or invalid JWT authentication is rejected.

http

GET /api/v1/api-keys
Authorization: Bearer <access token>