Revoke an API key
Immediately revoke one of the current WorkspaceAPI actor's keys.
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.
DELETE /api-keys/{key_id}
Immediately revoke one of the current WorkspaceAPI actor's keys.
| Parameter | Type | Description |
|---|---|---|
key_idpath · required | string | User-owned key to revoke. |
curl --fail-with-body -X DELETE "https://app.sym.so/v1/workspaces/$WORKSPACE_ID/api-keys/$KEY_ID" \
-H "Authorization: Bearer $SYM_WORKSPACE_API_KEY"{
"worker_id": "worker-example-001",
"org_id": "workspace_example",
"item": {
"id": "key_01J8",
"revoked_at": "2026-08-15T02:00:00Z"
},
"revoked": true,
"ok": true
}Authorization
{
"type": "bearer",
"scope": "api_keys:write",
"transport": "Authorization: Bearer <workspace_api_key>"
}Errors
| Status | Description |
|---|---|
| 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. |