Dokumentasi
Sign inGet started
Mulai sekarang
Panduan
Referensi API
SDK
CLI
Basis Pengetahuan
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
Respons200
{
  "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.
Parameter
realtime_app_id
string
ID of the Realtime app (rap_ prefix), as returned when the app was created.
Payload Permintaan
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 Respons
created_at
string
wajib
updated_at
string
wajib
client_events
boolean
wajib
Allow clients to trigger events directly (client events).
connection_counting
boolean
wajib
Count the connections subscribed to each channel and expose the count on channel queries.
connection_count_events
boolean
wajib
Broadcast a connection-count event to a channel's subscribers whenever its connection count changes. Requires connection_counting.
watchlist_events
boolean
wajib
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
wajib
Require every connection to be authorized.
id
string
wajib
app_id
integer
wajib
The numeric Realtime app id. Use it together with a key and secret to initialize a Realtime client/server SDK. Immutable.
name
string
wajib
A label for the app, shown wherever it is listed.
region
string
wajib
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
wajib
Lifecycle state of the app. active apps serve connections; suspended apps are provisioned but reject connections.
Possible values: active, suspended

Sumber daya terkait

Lanjutkan dengan dokumentasi, panduan, dan contoh untuk topik ini. Sumber daya tersedia dalam bahasa Inggris.

Jelajahi kemampuannyaRealtimeIkuti jalur pembelajaranBuild your first integrationPanduan implementasiSend your first realtime event
Coba praktiknya dan dapatkan ringkasan implementasi