List a Realtime app's keys
GET
/v1/realtime/apps/{realtime_app_id}/keysbird realtime apps keys list <realtime-app-id>curl -X GET "https://us1.platform.bird.com/v1/realtime/apps/{realtime_app_id}/keys" \
-H "Authorization: Bearer $TOKEN" \
--url-query "include_revoked=false"Response200
{
"data": [
{
"id": "rak_01krdgeqcxet5s7t44vh8rt9mg",
"key": "d0e95a856ddc1b09d4c8",
"secret": "862925e1991a8b6902f9"
}
]
}
Returns the app's keys, oldest first. Non-revoked only by default; pass include_revoked=true to include revoked keys. An app can hold several keys at once (create a new key, roll it out, then revoke the old one for zero-downtime rotation). Secrets are never included in this response.
Parameters
realtime_app_idstringID of the Realtime app (rap_ prefix), as returned when the app was created.
Query Parameters
include_revokedbooleanWhen true, include revoked keys in the response.
Response Payload
dataarray of object
required
The app's keys, oldest first. Revoked keys are excluded unless include_revoked=true.
Related resources
Continue with the documentation, guides and examples for this topic.