Revoke a Realtime app key
POST
/v1/realtime/apps/{realtime_app_id}/keys/{realtime_app_key_id}/revoke
curl -X POST "https://us1.platform.bird.com/v1/realtime/apps/{realtime_app_id}/keys/{realtime_app_key_id}/revoke" \
-H "Authorization: Bearer $TOKEN"Revokes a key. The key stops working immediately; the record is retained with revoked_at set for audit. Only revoke a key once it is no longer in use. Returns the updated key. Returns 409 if the key is already revoked, and 422 if it is the app's only key (an app must keep at least one).
Response Payload
id
string
required
key
string
required
The public app key clients use to connect.
secret
string
The key secret, used for server-side request signing. Returned only when the key is created, and never shown again — store it securely. If lost, create a new key and revoke this one.
revoked_at
nullable string
required
When the key was revoked, or null if still active.
created_at
string
required