Api Keys Create

POST

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

POST

/api/keys/

$ curl -X POST https://api.respan.ai/api/keys/ \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{}'

201Created

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

Create a new API key for the organization.

super().post() routes through OrganizationInjectionMixin.post which calls inject_target_organization(request) — that handles superadmin- gated organization / organization_id injection for us. We only need to pin user (which the injection helper does not touch) before delegating.

Create a new API key for the organization. ``super().post()`` routes through ``OrganizationInjectionMixin.post`` which calls ``inject_target_organization(request)`` — that handles superadmin- gated ``organization`` / ``organization_id`` injection for us. We only need to pin ``user`` (which the injection helper does not touch) before delegating.

Authentication

AuthorizationBearer

JWT access token or Respan API key

Request

This endpoint expects an object.

projectstring or nullOptional>=1 character

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

Response

idstringRead-only

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