Sign inGet Started
Comenzar
Guías
Referencia de API
SDKs
CLI
Base de conocimientos
Registro de cambios

Get a Realtime app

GET
/v1/realtime/apps/{realtime_app_id}
bird realtime apps get <realtime-app-id>
Respuesta200
{
  "created_at": "2026-05-20T09:14:52Z",
  "updated_at": "2026-05-25T16:42:01Z",
  "id": "rap_01krdgeqcxet5s7t44vh8rt9mg",
  "app_id": 432557,
  "name": "chat-production",
  "region": "us1",
  "status": "active"
}

Returns a single Realtime app with its configuration and connection details (app_id, region). Key secrets are never included; use List a Realtime app's keys to manage them. Returns a 404 Not Found error if the app does not exist in the workspace.

Parámetros

realtime_app_idstring

ID of the Realtime app (rap_ prefix), as returned when the app was created.

Carga de respuesta

created_at
string
obligatorio
updated_at
string
obligatorio
client_events
boolean
obligatorio

Allow clients to trigger events directly (client events).

connection_counting
boolean
obligatorio

Count the connections subscribed to each channel and expose the count on channel queries.

connection_count_events
boolean
obligatorio

Broadcast a connection-count event to a channel's subscribers whenever its connection count changes. Requires connection_counting.

watchlist_events
boolean
obligatorio

Tell a signed-in member when the members on their watchlist come online or go offline. The watchlist is part of the identity your backend signs at signin.

authorized_connections
boolean
obligatorio

Require every connection to be authorized.

id
string
obligatorio
app_id
integer
obligatorio

The numeric Realtime app id. Use it together with a key and secret to initialize a Realtime client/server SDK. Immutable.

name
string
obligatorio

A label for the app, shown wherever it is listed.

region
string
obligatorio

The region this app runs in. Unlike other products, a Realtime app can be placed in a region other than the workspace's home region. Immutable after creation.

status
string
obligatorio

Lifecycle state of the app. active apps serve connections; suspended apps are provisioned but reject connections.

Possible values: active, suspended

Recursos relacionados

Continúa con la documentación, guías y ejemplos de este tema.

Prueba el ejercicio y obtén un resumen de implementación