Api Update Key Retrieve

GET

https://api.respan.ai/api/update-key/:id/

GET

/api/update-key/:id/

$ curl https://api.respan.ai/api/update-key/id/ \
>      -H "Authorization: Bearer <token>"

200Retrieved

1 {
2   "id": "string",
3   "suffix": "string",
4   "tags": [
5     {
6       "id": "string",
7       "name": "string",
8       "color": "string",
9       "created_at": "2024-01-15T09:30:00Z",
10       "updated_at": "2024-01-15T09:30:00Z"
11     }
12   ],
13   "status": "active",
14   "prefix": "string",
15   "hashed_key": "string",
16   "created": "2024-01-15T09:30:00Z",
17   "key_usage": 1,
18   "last_used": "2024-01-15T09:30:00Z",
19   "spending_in_period": 1.1,
20   "revoked_at": "2024-01-15T09:30:00Z",
21   "revoked_by_email": "string",
22   "user": 1,
23   "organization": 1,
24   "created_by": 1,
25   "updated_by": 1,
26   "project": "string",
27   "name": "string",
28   "revoked": true,
29   "expiry_date": "2024-01-15T09:30:00Z",
30   "max_usage": 1,
31   "rate_limit": 1.1,
32   "spending_limit": 1.1,
33   "is_test": true,
34   "is_temporary": true
35 }

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.

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.

Authentication

AuthorizationBearer

JWT access token or Respan API key

Path parameters

idstringRequired

Response

idstringRead-only

suffixstringRead-only

tagslist of objectsRead-only

statusenum

active - Active
expired - Expired
revoked - Revoked

prefixstringRead-only

hashed_keystringRead-only

createddatetimeRead-only

key_usageintegerRead-only

last_useddatetimeRead-only

spending_in_perioddoubleRead-only

revoked_atdatetime or nullRead-only

revoked_by_emailstring or nullRead-only

userinteger or nullRead-only

organizationinteger or nullRead-only

created_byinteger or nullRead-only

updated_byinteger or nullRead-only

projectstring or null

namestring<=50 characters

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_datedatetime or null

Once API key expires, clients cannot use it anymore.

max_usageinteger-2147483648-2147483647

rate_limitdouble or null

spending_limitdouble or null

is_testboolean

is_temporaryboolean