Update an API key

Update an API key name and/or hard credit limit.

PATCH /v1/api-keys/{key_id}

200

{
  "key_id": "<string>",
  "name": "<string>",
  "status": "<string>",
  "api_key": "<string>",
  "prefix": "<string>",
  "created_at": "<string>",
  "last_used_at": "<string>",
  "disabled_at": "<string>",
  "expires_at": "<string>",
  "rotated_from_key_id": "<string>",
  "rotated_at": "<string>",
  "credit_limit": 123,
  "credit_used": 0,
  "credit_reserved": 0,
  "credit_remaining": 123,
  "credit_budget_reset_at": "<string>"
}

Path Parameters

key_id · string · required

Public API key identifier returned by GET /v1/api-keys.

Body

application/json

name · string | null

Updated display name for the API key.

Required string length: 1 - 120

credit_limit · number | null

Hard credit limit for this API key, or null for Unlimited.

Required range: 0 <= x <= 1000000000

Response

200

application/json

Updated API key.

key_id · string · required

name · string · required

status · string · required

api_key · string | null

prefix · string | null

created_at · string | null

last_used_at · string | null

disabled_at · string | null

expires_at · string | null

rotated_from_key_id · string | null

rotated_at · string | null

credit_limit · number | null

credit_used · number · default: 0

credit_reserved · number · default: 0

credit_remaining · number | null

credit_budget_reset_at · string | null