Sign in

v3

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

Api Update Key Retrieve

Declare per-endpoint throttling configuration attributes for views.

Endpoints can inherit this mixin and set:

  • endpoint_default_rate_limit_per_user_per_min: float | None

When set (not None), throttling will use ONLY this default RPM for the endpoint without requiring API key / org attributes on the request. When unset, the standard API key / organization / subscription limits apply.

get/api/update-key/{id}/

Path parameters

idstring required

Headers

Authorizationstring required

JWT access token or Respan API key

Response

idstring 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
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