Sign in

v1

latestOpenAPI 3.0.02026-07-14169146300.3 KB
Realtime

Updates realtime configuration

patch/v1/projects/{ref}/config/realtime

Path parameters

refstring required
Example:abcdefghijklmnopqrst

Project ref

Request body

private_onlyboolean

Whether to only allow private channels

connection_poolinteger

Sets connection pool size for Realtime Authorization

max_concurrent_usersinteger

Sets maximum number of concurrent users rate limit

max_events_per_secondinteger

Sets maximum number of events per second rate per channel limit

max_bytes_per_secondinteger

Sets maximum number of bytes per second rate per channel limit

max_channels_per_clientinteger

Sets maximum number of channels per client rate limit

max_joins_per_secondinteger

Sets maximum number of joins per second rate limit

max_presence_events_per_secondinteger

Sets maximum number of presence events per second rate limit

max_payload_size_in_kbinteger

Sets maximum number of payload size in KB rate limit

suspendboolean

Disables the Realtime service for this project when true. Set to false to re-enable it.

presence_enabledboolean

Whether to enable presence

Example request

{
  "private_only": false,
  "max_concurrent_users": 1000,
  "max_channels_per_client": 100
}