Gets realtime configuration

1
{
2
  "private_only": true,
3
  "connection_pool": 1,
4
  "postgres_changes_pool": 1,
5
  "max_concurrent_users": 1,
6
  "max_events_per_second": 1,
7
  "max_bytes_per_second": 1,
8
  "max_channels_per_client": 1,
9
  "max_joins_per_second": 1,
10
  "max_presence_events_per_second": 1,
11
  "max_payload_size_in_kb": 1,
12
  "suspend": true,
13
  "presence_enabled": true,
14
  "admin_suspended_at": "4404-02-29T04:24Z"
15
}

1
{
2
  "type": "object",
3
  "properties": {
4
    "private_only": {
5
      "type": "boolean",
6
      "description": "Whether to only allow private channels",
7
      "nullable": true
8
    },
9
    "connection_pool": {
10
      "type": "integer",
11
      "minimum": 1,
12
      "maximum": 100,
13
      "description": "Sets connection pool size for Realtime Authorization",
14
      "nullable": true
15
    },
16
    "postgres_changes_pool": {
17
      "type": "integer",
18
      "minimum": 1,
19
      "maximum": 100,
20
      "description": "Sets connection pool size used to create Postgres Changes subscriptions",
21
      "nullable": true
22
    },
23
    "max_concurrent_users": {
24
      "type": "integer",
25
      "minimum": 1,
26
      "maximum": 300000,
27
      "description": "Sets maximum number of concurrent users rate limit",
28
      "nullable": true
29
    },
30
    "max_events_per_second": {
31
      "type": "integer",
32
      "minimum": 1,
33
      "maximum": 50000,
34
      "description": "Sets maximum number of events per second rate per channel limit",
35
      "nullable": true
36
    },
37
    "max_bytes_per_second": {
38
      "type": "integer",
39
      "minimum": 1,
40
      "maximum": 10000000,
41
      "description": "Sets maximum number of bytes per second rate per channel limit",
42
      "nullable": true
43
    },
44
    "max_channels_per_client": {
45
      "type": "integer",
46
      "minimum": 1,
47
      "maximum": 10000,
48
      "description": "Sets maximum number of channels per client rate limit",
49
      "nullable": true
50
    },
51
    "max_joins_per_second": {
52
      "type": "integer",
53
      "minimum": 1,
54
      "maximum": 5000,
55
      "description": "Sets maximum number of joins per second rate limit",
56
      "nullable": true
57
    },
58
    "max_presence_events_per_second": {
59
      "type": "integer",
60
      "minimum": 1,
61
      "maximum": 5000,
62
      "description": "Sets maximum number of presence events per second rate limit",
63
      "nullable": true
64
    },
65
    "max_payload_size_in_kb": {
66
      "type": "integer",
67
      "minimum": 1,
68
      "maximum": 10000,
69
      "description": "Sets maximum number of payload size in KB rate limit",
70
      "nullable": true
71
    },
72
    "suspend": {
73
      "type": "boolean",
74
      "description": "Disables the Realtime service for this project when true. Set to false to re-enable it.",
75
      "nullable": true
76
    },
77
    "presence_enabled": {
78
      "type": "boolean",
79
      "description": "Whether to enable presence"
80
    },
81
    "admin_suspended_at": {
82
      "type": "string",
83
      "format": "date-time",
84
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
85
      "description": "If set, the Realtime service has been suspended by an admin.",
86
      "nullable": true
87
    }
88
  },
89
  "required": [
90
    "private_only",
91
    "connection_pool",
92
    "postgres_changes_pool",
93
    "max_concurrent_users",
94
    "max_events_per_second",
95
    "max_bytes_per_second",
96
    "max_channels_per_client",
97
    "max_joins_per_second",
98
    "max_presence_events_per_second",
99
    "max_payload_size_in_kb",
100
    "suspend",
101
    "presence_enabled",
102
    "admin_suspended_at"
103
  ]
104
}