Update real-time settings and connection configuration

Update real-time settings and connection configuration

Authentication: required

Required API Scope: Instance Workspace: Update

PUT /workspace/{workspace_id}/realtime

Update real-time settings and connection configuration

cURL

curl --request PUT \
  --url https://your-xano-instance.xano.io/api:meta/workspace/{workspace_id}/realtime \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "enabled": true,
  "hash": "<string>",
  "channels": [
    {
      "pattern": "<string>",
      "anonymous_clients": true,
      "client_authenticated_messaging": true,
      "client_private_messaging": true,
      "client_private_messaging_authenticated_only": true,
      "client_public_messaging": true,
      "client_public_messaging_authenticated_only": true,
      "description": "<string>",
      "enabled": true,
      "id": 123,
      "presence": true,
      "wildcard": true
    }
  ]
}
'

import requests

url = "https://your-xano-instance.xano.io/api:meta/workspace/{workspace_id}/realtime"

payload = {
    "enabled": True,
    "hash": "<string>",
    "channels": [
        {
            "pattern": "<string>",
            "anonymous_clients": True,
            "client_authenticated_messaging": True,
            "client_private_messaging": True,
            "client_private_messaging_authenticated_only": True,
            "client_public_messaging": True,
            "client_public_messaging_authenticated_only": True,
            "description": "<string>",
            "enabled": True,
            "id": 123,
            "presence": True,
            "wildcard": True
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    enabled: true,
    hash: '<string>',
    channels: [
      {
        pattern: '<string>',
        anonymous_clients: true,
        client_authenticated_messaging: true,
        client_private_messaging: true,
        client_private_messaging_authenticated_only: true,
        client_public_messaging: true,
        client_public_messaging_authenticated_only: true,
        description: '<string>',
        enabled: true,
        id: 123,
        presence: true,
        wildcard: true
      }
    ]
  })
};

fetch('https://your-xano-instance.xano.io/api:meta/workspace/{workspace_id}/realtime', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://your-xano-instance.xano.io/api:meta/workspace/{workspace_id}/realtime",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'enabled' => true,
    'hash' => '<string>',
    'channels' => [
        [
                'pattern' => '<string>',
                'anonymous_clients' => true,
                'client_authenticated_messaging' => true,
                'client_private_messaging' => true,
                'client_private_messaging_authenticated_only' => true,
                'client_public_messaging' => true,
                'client_public_messaging_authenticated_only' => true,
                'description' => '<string>',
                'enabled' => true,
                'id' => 123,
                'presence' => true,
                'wildcard' => true
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://your-xano-instance.xano.io/api:meta/workspace/{workspace_id}/realtime"

	payload := strings.NewReader("{\n  \"enabled\": true,\n  \"hash\": \"<string>\",\n  \"channels\": [\n    {\n      \"pattern\": \"<string>\",\n      \"anonymous_clients\": true,\n      \"client_authenticated_messaging\": true,\n      \"client_private_messaging\": true,\n      \"client_private_messaging_authenticated_only\": true,\n      \"client_public_messaging\": true,\n      \"client_public_messaging_authenticated_only\": true,\n      \"description\": \"<string>\",\n      \"enabled\": true,\n      \"id\": 123,\n      \"presence\": true,\n      \"wildcard\": true\n    }\n  ]\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://your-xano-instance.xano.io/api:meta/workspace/{workspace_id}/realtime")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"enabled\": true,\n  \"hash\": \"<string>\",\n  \"channels\": [\n    {\n      \"pattern\": \"<string>\",\n      \"anonymous_clients\": true,\n      \"client_authenticated_messaging\": true,\n      \"client_private_messaging\": true,\n      \"client_private_messaging_authenticated_only\": true,\n      \"client_public_messaging\": true,\n      \"client_public_messaging_authenticated_only\": true,\n      \"description\": \"<string>\",\n      \"enabled\": true,\n      \"id\": 123,\n      \"presence\": true,\n      \"wildcard\": true\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://your-xano-instance.xano.io/api:meta/workspace/{workspace_id}/realtime")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"enabled\": true,\n  \"hash\": \"<string>\",\n  \"channels\": [\n    {\n      \"pattern\": \"<string>\",\n      \"anonymous_clients\": true,\n      \"client_authenticated_messaging\": true,\n      \"client_private_messaging\": true,\n      \"client_private_messaging_authenticated_only\": true,\n      \"client_public_messaging\": true,\n      \"client_public_messaging_authenticated_only\": true,\n      \"description\": \"<string>\",\n      \"enabled\": true,\n      \"id\": 123,\n      \"presence\": true,\n      \"wildcard\": true\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

200

{
  "enabled": true,
  "hash": "Dl3HlakmBZDhezv6yml7hliTM20",
  "channels": [
    {
      "anonymous_clients": true,
      "client_authenticated_messaging": true,
      "client_private_messaging": true,
      "client_private_messaging_authenticated_only": true,
      "client_public_messaging": true,
      "client_public_messaging_authenticated_only": true,
      "description": "<string>",
      "enabled": true,
      "id": 123,
      "pattern": "<string>",
      "presence": true,
      "wildcard": true
    }
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

workspace_id · integer<int64> · required

Body

application/jsonmultipart/form-data

enabled · boolean

hash · string

channels · object[]

Show child attributes

Response

200

application/json

Success!

enabled · boolean

hash · string · default: Dl3HlakmBZDhezv6yml7hliTM20

channels · object[]

Show child attributes