---
title: "Gets realtime configuration"
method: GET
path: "/v1/projects/{ref}/config/realtime"
tags: ["Realtime"]
---

# Gets realtime configuration

`GET /v1/projects/{ref}/config/realtime`

## Path parameters

- `ref` string, required

## Response `200`

Gets project's realtime configuration

- RealtimeConfigResponse
  - `private_only` boolean, nullable, required — Whether to only allow private channels
  - `connection_pool` integer, nullable, required — Sets connection pool size for Realtime Authorization
  - `max_concurrent_users` integer, nullable, required — Sets maximum number of concurrent users rate limit
  - `max_events_per_second` integer, nullable, required — Sets maximum number of events per second rate per channel limit
  - `max_bytes_per_second` integer, nullable, required — Sets maximum number of bytes per second rate per channel limit
  - `max_channels_per_client` integer, nullable, required — Sets maximum number of channels per client rate limit
  - `max_joins_per_second` integer, nullable, required — Sets maximum number of joins per second rate limit
  - `max_presence_events_per_second` integer, nullable, required — Sets maximum number of presence events per second rate limit
  - `max_payload_size_in_kb` integer, nullable, required — Sets maximum number of payload size in KB rate limit
  - `suspend` boolean, nullable, required — Disables the Realtime service for this project when true. Set to false to re-enable it.
  - `presence_enabled` boolean, required — Whether to enable presence

## Other responses

- `401` — Unauthorized
- `403` — Forbidden action
- `429` — Rate limit exceeded

---

[API](https://skmtc.net/supabase/apis/management-api.md) · [All operations](https://skmtc.net/supabase/apis/management-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/supabase/management-api/versions/a7cb39418064/schema)