SymDocs
Workspace API
All productsSym Workspace APISym Passes MCP
Supportjoinsym.com ↗
Sym Workspace API

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.

ParameterTypeDescription
key_id
path · required
stringKey owned by the current WorkspaceAPI actor.
Request
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"
Response 201
{
  "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

Credential contract
{
  "type": "bearer",
  "scope": "api_keys:write",
  "transport": "Authorization: Bearer <workspace_api_key>"
}

Errors

StatusDescription
400The request body or parameters are invalid.
401The workspace API key is missing, invalid, expired, or revoked.
403The key lacks the required scope or its owner no longer has permission.
404The resource is missing or intentionally hidden by authorization.
429The key exceeded its current rate limit.

Usage notes