Sign in

v3

latestOpenAPI 3.1.02026-07-311,4541,5202.3 MB
users

Api Update Key Partial Update

PATCH handler with superadmin lock and field protection.

Checks:

  1. Object lock (is_managed=True -> non-superadmins can't modify)
  2. Field protection (non-superadmins can't modify specific fields)
patch/api/update-key/{id}/

Path parameters

idstring required

Headers

Authorizationstring required

JWT access token or Respan API key

Request body

projectstring nullable
namestring

A free-form name for the API key. Need not be unique. 50 characters max.

revokedboolean

If the API key is revoked, clients cannot use it anymore. (This cannot be undone.)

expiry_datestring date-time nullable

Once API key expires, clients cannot use it anymore.

max_usageinteger
rate_limitnumber double nullable
spending_limitnumber double nullable
is_temporaryboolean

Response

idstring required
api_keystring required
suffixstring required
status'active' | 'expired' | 'revoked' required
  • active - Active
  • expired - Expired
  • revoked - Revoked
projectstring nullable
prefixstring required
hashed_keystring required
createdstring date-time required
namestring

A free-form name for the API key. Need not be unique. 50 characters max.

revokedboolean

If the API key is revoked, clients cannot use it anymore. (This cannot be undone.)

expiry_datestring date-time nullable

Once API key expires, clients cannot use it anymore.

key_usageinteger required
max_usageinteger
last_usedstring date-time required
rate_limitnumber double nullable
spending_limitnumber double nullable
spending_in_periodnumber double required
is_testboolean required
is_temporaryboolean
revoked_atstring date-time nullable required
revoked_by_emailstring nullable required
userinteger nullable required
organizationinteger nullable required
created_byinteger nullable required
updated_byinteger nullable required