List a Realtime app's keys

GET

/v1/realtime/apps/{realtime_app_id}/keys

curl -X GET "https://us1.platform.bird.com/v1/realtime/apps/{realtime_app_id}/keys" \
  -H "Authorization: Bearer $TOKEN" \
  --url-query "include_revoked=false"

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.

Parameter Kueri

include_revoked

boolean

When true, include revoked keys in the response.

Payload Respons

data

array of object

wajib

The app's keys, oldest first. Revoked keys are excluded unless include_revoked=true.

Tampilkan atribut turunan

data.id

string

wajib

data.key

string

wajib

The public app key clients use to connect.

data.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.

data.revoked_at

nullable string

wajib

When the key was revoked, or null if still active.

data.created_at

string

wajib

curl -X GET "https://us1.platform.bird.com/v1/realtime/apps/{realtime_app_id}/keys" \
  -H "Authorization: Bearer $TOKEN" \
  --url-query "include_revoked=false"