bird realtime apps update

Usage

Code example

bird realtime apps update <realtime-app-id> [flags]

Rename a Realtime app or change its configuration flags. Omitted fields keep their current value. Region cannot be changed after creation, so moving an app to another region means creating a new one and repointing clients.

Build the request from flags, a JSON RealtimeAppUpdate body via --body-file ("-" reads stdin), or both — a flag overrides the matching body field. Run --example to print a ready-to-edit body, or --dry-run to print the resolved request without sending it.

Examples

Code example

# print the body shape (no credentials needed)
bird realtime apps update --example

# the body it prints:

Code example

{
  "connection_counting": true,
  "name": "chat-production"
}

Options

Request

Name	Description
--body-file	Read the JSON request body from this file; "-" reads stdin
--example	Print a complete example request body, then exit
--dry-run	Print the resolved request without sending it, then exit
--idempotency-key	Deduplication key; a retry with the same key won't act twice

Options

Name	Description
--name	A label for the app, shown wherever it is listed.
--client-events	Allow clients to trigger events directly (client events).
--connection-counting	Count the connections subscribed to each channel and expose the count on channel queries.
--connection-count-events	Broadcast a connection-count event to a channel's subscribers whenever its connection count changes. Requires connection_counting.
--watchlist-events	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	Require every connection to be authorized.
--response-schema	Print the fields this command returns, then exit

Name	Description
bird realtime apps create	Create a Realtime app
bird realtime apps delete	Delete a Realtime app
bird realtime apps get	Get a Realtime app
bird realtime apps list	List Realtime apps

Related resources

Continue with the documentation, guides and examples for this topic. Resources are in English.

Explore the capabilityRealtime Follow the learning pathBuild your first integration Implementation guideSend your first realtime event

Try the practice and get an implementation brief