Api Keys Retrieve

GET

https://api.respan.ai/api/keys/:id/

GET

/api/keys/:id/

$ curl https://api.respan.ai/api/keys/id/ \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json"

200Retrieved

1 {
2   "id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
3   "suffix": "X9Z7",
4   "tags": [
5     {
6       "id": "tag12345",
7       "name": "production",
8       "color": "#FF5733",
9       "created_at": "2024-01-15T09:30:00Z",
10       "updated_at": "2024-01-15T09:30:00Z"
11     }
12   ],
13   "status": "active",
14   "prefix": "RSN",
15   "hashed_key": "5f4dcc3b5aa765d61d8327deb882cf99",
16   "created": "2024-01-15T09:30:00Z",
17   "key_usage": 15234,
18   "last_used": "2024-04-20T14:45:00Z",
19   "spending_in_period": 1250.75,
20   "revoked_at": null,
21   "revoked_by_email": null,
22   "user": 9876,
23   "organization": 5432,
24   "created_by": 9876,
25   "updated_by": 1234,
26   "project": "Respan Analytics",
27   "name": "Main API Key",
28   "revoked": false,
29   "expiry_date": "2025-01-15T09:30:00Z",
30   "max_usage": 100000,
31   "rate_limit": 120.5,
32   "spending_limit": 5000,
33   "is_test": false,
34   "is_temporary": false
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 nullOptional

namestringOptional<=50 characters

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

revokedbooleanOptional

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

expiry_datedatetime or nullOptional

Once API key expires, clients cannot use it anymore.

max_usageintegerOptional-2147483648-2147483647

rate_limitdouble or nullOptional

spending_limitdouble or nullOptional

is_testbooleanOptional

is_temporarybooleanOptional