Rotate an API key
Revoke a user-owned key and return a replacement secret once without broadening its scopes.
API 2.7.0 · Published service contract ↗
Request
Base URL: https://app.sym.so/v1/workspaces/{workspace_id}
Authentication: bearer. Required scope: api_keys:write.
POST /api-keys/{key_id}/rotate
Revoke a user-owned key and return a replacement secret once without broadening its scopes.
| Parameter | Type | Description |
|---|---|---|
key_idpath · required | string | Key owned by the current WorkspaceAPI actor. |
curl --fail-with-body -X POST "https://app.sym.so/v1/workspaces/$WORKSPACE_ID/api-keys/$KEY_ID/rotate" \
-H "Authorization: Bearer $SYM_WORKSPACE_API_KEY"{
"worker_id": "worker-example-001",
"org_id": "workspace_example",
"item": {
"id": "key_01J9",
"name": "Local integration",
"scopes": [
"files:read",
"chats:read"
]
},
"key": "sym_ws_r8M4...2Lka",
"reveal_once": true,
"previous_key_revoked": true,
"ok": true
}Authorization
{
"type": "bearer",
"scope": "api_keys:write",
"transport": "Authorization: Bearer <workspace_api_key>"
}Errors
| Status | Description |
|---|---|
| 400 | The request body or parameters are invalid. |
| 401 | The workspace API key is missing, invalid, expired, or revoked. |
| 403 | The key lacks the required scope or its owner no longer has permission. |
| 404 | The resource is missing or intentionally hidden by authorization. |
| 429 | The key exceeded its current rate limit. |
Usage notes
- A caller cannot rotate a key whose scopes are broader than its own because rotation reveals the replacement secret.