Sign inGet Started
Começar
Guias
Referência de API
SDKs
CLI
Base de conhecimento
Changelog

Update a Realtime app

PATCH
/v1/realtime/apps/{realtime_app_id}
bird realtime apps update <realtime-app-id> \
  --connection-counting=true \
  --name chat-production
Resposta200
{
  "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"
}

Updates a Realtime app's name and configuration flags. Region is immutable; TLS is always enforced. Omitted fields are left unchanged.

Parâmetros

realtime_app_idstring

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

Corpo da requisição

name
string

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

client_events
boolean

Allow clients to trigger events directly (client events).

connection_counting
boolean

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

connection_count_events
boolean

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

watchlist_events
boolean

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

Require every connection to be authorized.

Payload de resposta

created_at
string
obrigatório
updated_at
string
obrigatório
client_events
boolean
obrigatório

Allow clients to trigger events directly (client events).

connection_counting
boolean
obrigatório

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

connection_count_events
boolean
obrigatório

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

watchlist_events
boolean
obrigatório

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
obrigatório

Require every connection to be authorized.

id
string
obrigatório
app_id
integer
obrigatório

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

name
string
obrigatório

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

region
string
obrigatório

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
obrigatório

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

Possible values: active, suspended

Recursos relacionados

Continue com a documentação, guias e exemplos sobre este tópico.

Experimente na prática e obtenha um resumo de implementação