Revoke a Realtime app key
POST
/v1/realtime/apps/{realtime_app_id}/keys/{realtime_app_key_id}/revoke
bird realtime apps keys revoke <realtime-app-id> <realtime-app-key-id> --yescurl -X POST "https://us1.platform.bird.com/v1/realtime/apps/{realtime_app_id}/keys/{realtime_app_key_id}/revoke" \
-H "Authorization: Bearer $TOKEN"Antwort200
{
"id": "rak_01krdgeqcxet5s7t44vh8rt9mg",
"key": "d0e95a856ddc1b09d4c8",
"secret": "862925e1991a8b6902f9"
}
Revokes a key immediately and returns it with revoked_at set. Clients that still use the key can no longer authenticate. An already revoked key returns 409. The app's only key cannot be revoked and returns 422.
Parameter
realtime_app_id
string
ID of the Realtime app (rap_ prefix), as returned when the app was created.
realtime_app_key_id
string
ID of the Realtime app key (rak_ prefix), as returned when the key was created.
Antwort-Payload
id
string
erforderlich
key
string
erforderlich
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
erforderlich
When the key was revoked, or null if still active.
created_at
string
erforderlich