Toggle Proxy Key Status
Enable or disable a proxy key without deleting it
Overview
Toggle the active status of a proxy key between enabled and disabled states. This provides a non-destructive way to temporarily revoke access without losing the key’s configuration.
Path Parameters
The proxy key ID to toggle (starts with ek-proxy-
)
Response Fields
Confirmation message that the status was updated
The new status of the proxy key (true
= active, false
= inactive)
Behavior
The toggle endpoint switches the proxy key between two states:
- Active (
true
): The proxy key can be used for API requests - Inactive (
false
): The proxy key is rejected with authentication errors
Use Cases
Temporary Suspension
Quickly disable access during maintenance or investigations
Conditional Access
Enable/disable keys based on business logic or schedules
Security Response
Immediately block suspicious activity without permanent deletion
Testing
Safely test key revocation and restoration workflows
Advantages Over Deletion
Example Workflow
Error Codes
Unauthorized - Invalid or missing API key
Forbidden - You don’t have permission to modify this proxy key
Not Found - Proxy key doesn’t exist
Rate Limited - Too many requests, please slow down
Related Endpoints
- List Proxy Keys - View current status of all keys
- Update Proxy Key - Modify key configuration
- Delete Proxy Key - Permanently remove a key
Authorizations
Enter your API key (starts with 'ek-')
Path Parameters
Proxy key ID
Response
Proxy key status updated
The response is of type object
.