List Project API Keys

(v2)

GET

Lists every API key scoped to the project, newest first. Each key's value is masked (only its last six characters are shown) — the full value is only ever returned once, by the response that issues it. A rotation whose grace period has already run out is completed before the list is read, so a shadowValue here is always still in flight.

GET/v2/projects/{projectId}/api-keys

curl -X GET "https://api.confident-ai.com/v2/projects/{projectId}/api-keys" \
  -H "CONFIDENT_API_KEY: <ORGANIZATION-API-KEY>"

200

{
  "success": true,
  "data": {
    "apiKeys": [
      {
        "id": 1420,
        "name": "CI pipeline",
        "valid": true,
        "created_at": "2025-01-15T09:30:00.000Z",
        "expiresAt": "2025-04-15T09:30:00.000Z",
        "value": "***************LmNoPq",
        "shadowValue": "***************Tu6vWx",
        "rotatesAt": "2025-03-01T12:00:00.000Z",
        "lastUsed": "2025-02-28T18:45:12.000Z"
      }
    ]
  },
  "deprecated": false
}

Headers

CONFIDENT_API_KEYstringRequired
The organization API key for your Confident AI organization.

Path parameters

projectIdstringRequired
The id of the project the key belongs to.

Response

List Project API Keys succeeded.

successboolean
Indicates if the request was successful.
dataobject
The API keys of one organization or one project. There is no pagination: the whole set is returned.
Show 1 propertyHide 1 property
- apiKeyslist of objects
  Every API key in the requested scope, newest first. Each key's secrets are masked.
  Show 9 propertiesHide 9 properties
  - idinteger
    The id of the API key, generated by Confident AI.
  - namestring | null
    The label for the key, shown on the Confident AI platform.
  - validboolean
    Whether the key authenticates. A deactivated key is rejected on every request until it is reactivated.
  - created_atstring
    When the key was created.
  - expiresAtstring | null
    The instant the key stops authenticating, or null when it never expires. Confident AI computes it from the expiresInDays duration sent when the key was created or last rotated.
  - valuestring
    The key, masked: fifteen asterisks followed by its last six characters. The full value is returned only by the response that issues it — creating a key, or rotating one — and never again.
  - shadowValuestring | null
    The masked replacement value while a rotation's grace period is running, or null when no rotation is pending.
  - rotatesAtstring | null
    When a pending rotation completes — shadowValue becomes value and the old value stops authenticating — or null when no rotation is pending.
  - lastUsedstring | null
    When the key last authenticated a request, or null when it never has.
deprecatedboolean
Indicates if this endpoint is deprecated.

Built byConfident AI