Sign in
Realtime

Gets realtime configuration

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

Request

  • The document declares no server URL.
  • Auth: HTTP bearer

Path parameters

refstring required

Project ref

Response

Gets project's realtime configuration

private_onlyboolean nullable required

Whether to only allow private channels

connection_poolinteger nullable required

Sets connection pool size for Realtime Authorization

max_concurrent_usersinteger nullable required

Sets maximum number of concurrent users rate limit

max_events_per_secondinteger nullable required

Sets maximum number of events per second rate per channel limit

max_bytes_per_secondinteger nullable required

Sets maximum number of bytes per second rate per channel limit

max_channels_per_clientinteger nullable required

Sets maximum number of channels per client rate limit

max_joins_per_secondinteger nullable required

Sets maximum number of joins per second rate limit

max_presence_events_per_secondinteger nullable required

Sets maximum number of presence events per second rate limit

max_payload_size_in_kbinteger nullable required

Sets maximum number of payload size in KB rate limit

suspendboolean nullable required

Whether to suspend realtime

Changes

No recorded changes to this operation across all 1 revision of this API.