Rotate Api Key

PATCH

/api/v1/api-keys/:key_id/rotate

PATCH

/api/v1/api-keys/:key_id/rotate

$ curl -X PATCH https://api.onepin.ai/api/v1/api-keys/key_id/rotate \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{}'

1 {
2   "data": {
3     "old_key": {
4       "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
5       "workspace_id": "7e9f1d2a-4c3b-4f8a-9d2e-1a2b3c4d5e6f",
6       "created_by": "d290f1ee-6c54-4b01-90e6-d701748f0851",
7       "name": "Legacy API Key",
8       "key_type": "read-only",
9       "key_prefix": "oldX9",
10       "key_suffix": "Z7Y3",
11       "scopes": [
12         "workflows:read"
13       ],
14       "active": false,
15       "last_used_at": "2024-04-10T14:22:00Z",
16       "rate_limit_per_min": 100,
17       "revoked_at": "2024-04-15T09:30:00Z",
18       "created_at": "2023-12-01T08:00:00Z",
19       "updated_at": "2024-04-15T09:30:00Z",
20       "preview": "oldX9...Z7Y3"
21     },
22     "new_key": {
23       "id": "9b2f1c3d-8a4e-4f7b-9c2d-3e4f5a6b7c8d",
24       "workspace_id": "7e9f1d2a-4c3b-4f8a-9d2e-1a2b3c4d5e6f",
25       "created_by": "d290f1ee-6c54-4b01-90e6-d701748f0851",
26       "name": "Rotated API Key",
27       "key_type": "read-only",
28       "key_prefix": "newA1",
29       "key_suffix": "X9Z4",
30       "scopes": [
31         "workflows:read"
32       ],
33       "active": true,
34       "last_used_at": null,
35       "rate_limit_per_min": 100,
36       "revoked_at": null,
37       "created_at": "2024-04-15T09:31:00Z",
38       "updated_at": "2024-04-15T09:31:00Z",
39       "api_key": "newA1-abc123xyz789X9Z4",
40       "preview": "newA1...X9Z4"
41     }
42   },
43   "meta": {
44     "request_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
45     "timestamp": "2024-04-15T09:31:00Z"
46   }
47 }

Rotate an API key by revoking the old row and creating a new key.

Authentication

AuthorizationBearer

Clerk JWT token

Path parameters

key_idstringRequiredformat: "uuid"

Response

Successful Response

dataobject

metaobject

Errors

422

Unprocessable Entity Error

Authentication

Path parameters

Headers

Response

Errors