edgegate_revoke_api_key
Revoke an API key by ID to immediately block its use, terminating access for clients that still hold it. Preserves the key record for audit trail while all subsequent requests fail.
Instructions
Revoke an API key by id. The key is immediately rejected for all subsequent requests; the row is preserved (with revoked_at set) so the audit trail survives. Destructive. Requires owner role.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"workspace_id": "<workspace_id>",
"key_id": "<key_id>"
},
"name": "edgegate_revoke_api_key"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| key_id | Yes | UUID of the key to revoke (the `id` field from `edgegate_list_api_keys`). This is destructive and immediate — any CI job or client still using the plaintext will fail authentication on the next request. | |
| workspace_id | Yes |