Skip to content
Management API Reference

Gets realtime configuration

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

The fine-grained token must include the following permissions to access this endpoint:

  • realtime_config_read

Path parameters

  • ref
    Required
    string

    Project ref

Response codes

  • 200
  • 401
  • 403
  • 429

Response (200)

{
  "private_only": true,
  "connection_pool": 1,
  "postgres_changes_pool": 1,
  "max_concurrent_users": 1,
  "max_events_per_second": 1,
  "max_bytes_per_second": 1,
  "max_channels_per_client": 1,
  "max_joins_per_second": 1,
  "max_presence_events_per_second": 1,
  "max_payload_size_in_kb": 1,
  "suspend": true,
  "presence_enabled": true
}