Skip to content
First requestVisit website ↗
Navigation

Rotate an MCP staff key (new value shown once)

Generates a new key value, replaces key_hash and key_prefix, and returns the plaintext once. The old value stops working immediately. Active state, grants and expiry are unchanged. Allowed for a platform owner, or for the platform admin who created the key when the key is neither global nor holds any write grant. A concurrent rotation answers 409.

POST
https://api.channelautomation.com/api/admin/mcp-permissions/keys/{keyId}/rotate

Authorization

  • BearerAuth
    HTTP Bearer (JWT)
    required

Path parameters

  • keyId
    string
    required
    format: uuid

Returns

200

{ success, data: { apiKey (plaintext, shown once), key } }

403

OWNER_OR_CREATOR_REQUIRED, or OWNER_ROLE_REQUIRED for a global/write key

404

Key not found

409

Rotated concurrently; reload

500

Internal server error
JSON
  • error
    optional
    string
  • details
    optional
    string
  • success
    optional
    boolean

Type to search…

↑↓ navigate↵ selectEsc close