Set API Key Active
setAPIKeyActiveToggles an API key on or off to allow or refuse requests using it; expired keys remain expired, and permanent removal requires deletion.
Instructions
Switches an API key off (active: false), so requests using it are refused, or back on (active: true). An expired key stays expired. To remove it for good use deleteAPIKey. Find the ID with listAPIKeys.
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": {
"keyID": "<keyID>",
"active": "<active>"
},
"name": "setAPIKeyActive"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| keyID | Yes | The ID of the API key | |
| active | Yes | false switches the key off, true back on |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ok | Yes | ||
| keyID | Yes | ||
| active | Yes |