Get a Realtime app
GET
/v1/realtime/apps/{realtime_app_id}
curl -X GET "https://us1.platform.bird.com/v1/realtime/apps/{realtime_app_id}" \
-H "Authorization: Bearer $TOKEN"Returns a single Realtime app with its configuration and connection details (app_id, region, cluster). Key secrets are never included; manage keys with listRealtimeAppKeys. Returns a 404 not_found_error if the app does not exist in the workspace.
Payload di risposta
created_at
string
obbligatorio
updated_at
string
obbligatorio
client_events
boolean
obbligatorio
Allow clients to trigger events directly (client events).
connection_counting
boolean
obbligatorio
Emit connection-count events on channels.
authorized_connections
boolean
obbligatorio
Require every connection to be authorized.
id
string
obbligatorio
app_id
integer
obbligatorio
The numeric Realtime app id. Use it together with a key and secret to initialize a Realtime client/server SDK. Immutable.
name
string
obbligatorio
region
object
obbligatorio
The region this app runs in. Unlike other Bird products, a Realtime app can be placed in a region other than the workspace's home region. Immutable after creation.
status
string
obbligatorio
Lifecycle state of the app. active apps serve connections; suspended apps are provisioned but reject connections.
Possible values: active, suspended