Update Project API Key

PUThttps://api.confident-ai.com/v1/projects/{projectId}/api-keys/{apiKeyId}

Activates or deactivates a project-scoped API key. A deactivated key is rejected on authentication.

PUT/v1/projects/{projectId}/api-keys/{apiKeyId}

curl -X PUT "https://api.confident-ai.com/v1/projects/{projectId}/api-keys/{apiKeyId}" \
  -H "CONFIDENT_API_KEY: <ORGANIZATION-API-KEY>" \
  -H "Content-Type: application/json" \
  -d '{
  "valid": false
}'

200

{
  "success": true,
  "data": {
    "apiKey": {
      "id": 34,
      "name": "Production agent key",
      "valid": false,
      "value": "***************d4e5f6",
      "created_at": "2024-12-04T23:00:00.000Z",
      "lastUsed": "2024-12-05T10:15:00.000Z"
    }
  }
}

Headers

CONFIDENT_API_KEYstringRequired
The organization API key for your Confident AI organization.

Path parameters

projectIdstringRequired
The unique identifier of the project.
apiKeyIdintegerRequired
The unique identifier of the API key.

Request body

validbooleanRequired
Set to false to deactivate the key, or true to reactivate it

Response

successboolean
Indicates if the request was successful
dataobject
Show 1 propertyHide 1 property
- apiKeyobject
  Show 9 propertiesHide 9 properties
  - idinteger
    Unique identifier for the API key
  - namestring
    Human-readable label for the API key
  - validboolean
    Whether the key is active. A deactivated key is rejected on authentication.
  - valuestring
    The API key value. This is redacted (only the last 6 characters are shown, prefixed with asterisks) on every response except the create response — and the rotate response when rotating without a grace period — where the full value is returned exactly once.
  - shadowValuestring
    The replacement value while a rotation's grace period is running, or null when no rotation is pending. Redacted on every response except the rotate response that issued it, where the full value is returned exactly once.
  - rotatesAtstring
    ISO 8601 timestamp of when a pending rotation completes and shadowValue replaces value, or null when no rotation is pending
  - expiresAtstring
    ISO 8601 timestamp of when the key expires, or null if it never expires
  - created_atstring
    ISO 8601 timestamp of when the key was created
  - lastUsedstring
    ISO 8601 timestamp of when the key was last used to authenticate, or null if never used

Built byConfident AI