QuickSwapBrokerService
Revoke API key
Revoke a broker API key immediately.
Method
POST
Path
/v1/quickswap/brokers/{broker}/keys/{key_id}/revoke
Visibility
Authentication
Session token
MFA Requirement
Not required
POST
/v1/quickswap/brokers/{broker}/keys/{key_id}/revoke Request
Testnet
curl --request POST \ \ --url 'https://api.testnet.polyester.com/v1/quickswap/brokers/value/keys/3f9c2a7b5d1e4f8a9b0c6d2e7f1a3b5c/revoke' \ --header 'Accept: */*' \ --header 'X-API-KEY-ID: YOUR_API_KEY_ID' \ --header 'X-API-TIMESTAMP: YOUR_API_TIMESTAMP' \ --header 'X-API-SIGNATURE: YOUR_API_SIGNATURE'
Responses
{
"key": {
"active": false,
"createdAt": "2025-01-01T00:00:00Z",
"createdByAccountId": "7563897446546",
"expiresAt": "2025-01-01T00:00:00Z",
"keyId": "3f9c2a7b5d1e4f8a9b0c6d2e7f1a3b5c",
"label": "Name Of My Subaccount",
"revokedAt": "2025-01-01T00:00:00Z",
"rotatedFrom": "value"
}
} broker string
Broker name.
key_id string
Public key ID of the key to revoke.
8 fields
active boolean
Whether the key works now: neither revoked nor past expires_at.
Example
false createdAt string (date-time)
When the key was created.
Example
2025-01-01T00:00:00Z createdByAccountId string
Public account ID of the member who created the key; 0 for a key that a key created by rotating itself.
Example
7563897446546 expiresAt string (date-time)
End of the key's rotation overlap; the key stops working then. Unset while the key works until revoked.
Example
2025-01-01T00:00:00Z keyId string
Public key ID: the part of the token between "qsk_" and the second "_".
Example
3f9c2a7b5d1e4f8a9b0c6d2e7f1a3b5c label string
Label given at creation; empty for a key created by rotation.
Example
Name Of My Subaccount revokedAt string (date-time)
When the key was revoked; unset while not revoked.
Example
2025-01-01T00:00:00Z rotatedFrom string
Key this key replaced by rotation; empty otherwise.
Example
value| Key | HTTP status | Connect code | Error | When |
|---|---|---|---|---|
| unauthenticated | 401 | unauthenticated | Unauthenticated | Authentication required. |
| permission-denied | 403 | permission_denied | Permission Denied | Permission denied. |
| invalid-argument | 400 | invalid_argument | Invalid Argument | Invalid argument. |
| not-found | 404 | not_found | Not Found | Not found. |
| unavailable | 503 | unavailable | Unavailable | Service unavailable. |