Sign in
Realtime

Update realtime configuration for a project

Changed on

Updates realtime settings including feature toggles and limits.

put/projects/{id}/realtime/config

Request

  • Base URL: https://api.volcano.dev
  • URL: https://api.volcano.dev/projects/{id}/realtime/config
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

idstring uuid required

Project ID

Request body

enabledboolean

Whether realtime is enabled for this project

broadcast_enabledboolean

Whether broadcast channels are enabled

presence_enabledboolean

Whether presence tracking is enabled

postgres_changes_enabledboolean

Whether Postgres change notifications are enabled

Response

Updated realtime configuration

project_idstring uuid

Project ID

enabledboolean

Whether realtime is enabled for this project

broadcast_enabledboolean

Whether broadcast channels are enabled

presence_enabledboolean

Whether presence tracking is enabled

postgres_changes_enabledboolean

Whether Postgres change notifications are enabled

created_atstring date-time

When the configuration was created

updated_atstring date-time

When the configuration was last updated

Changes

  • 23e7875e7c4cRevision changes
    • ○

      the endpoint scheme security ProjectAccessToken was added to the API

  • 3a6f365f3f35Revision changes
    • ▲

      added the new path request parameter id

    • ▲

      the request's body type changed from no type to object

    • ▲

      the response's body type changed from no type to object for status

    • ▲

      the response's body type changed from no type to object for status

    • ▲

      the response's body type changed from no type to object for status

    • ○

      added the new optional request property

    • ○

      added the new optional request property

    • ○

      added the new optional request property

    • ○

      added the new optional request property

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the required property to the response with the status

    • ○

      added the required property to the response with the status