Update WebSocket cluster

Update a WebSocket cluster.

PATCH /websocket-servers/{websocketServer}

Update WebSocket cluster

cURL

curl --request PATCH \
  --url https://cloud.laravel.com/api/websocket-servers/{websocketServer} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>"
}
'

import requests

url = "https://cloud.laravel.com/api/websocket-servers/{websocketServer}"

payload = { "name": "<string>" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: '<string>'})
};

fetch('https://cloud.laravel.com/api/websocket-servers/{websocketServer}', 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://cloud.laravel.com/api/websocket-servers/{websocketServer}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>'
  ]),
  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://cloud.laravel.com/api/websocket-servers/{websocketServer}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://cloud.laravel.com/api/websocket-servers/{websocketServer}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://cloud.laravel.com/api/websocket-servers/{websocketServer}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\"\n}"

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

200

{
  "data": {
    "id": "<string>",
    "type": "websocketServers",
    "attributes": {
      "name": "<string>",
      "type": "reverb",
      "hostname": "<string>",
      "created_at": "2023-11-07T05:31:56Z"
    },
    "relationships": {
      "applications": {
        "data": [
          {
            "type": "websocketApplications",
            "id": "<string>"
          }
        ]
      }
    }
  },
  "included": [
    {
      "id": "<string>",
      "type": "websocketApplications",
      "attributes": {
        "name": "<string>",
        "app_id": "<string>",
        "allowed_origins": [
          "<unknown>"
        ],
        "ping_interval": 123,
        "activity_timeout": 123,
        "max_message_size": 123,
        "max_connections": 123,
        "key": "<string>",
        "secret": "<string>",
        "created_at": "2023-11-07T05:31:56Z"
      },
      "relationships": {
        "server": {
          "data": {
            "type": "websocketServers",
            "id": "<string>"
          }
        }
      }
    }
  ]
}

{
  "message": "<string>"
}

{
  "message": "<string>",
  "errors": {}
}

Authorizations

Authorization · string · header · required

The Bearer Token generated on the Cloud UI.

Path Parameters

websocketServer · string · required

The websocket server identifier

Body

application/json

name · string

Required string length: 3 - 40

Pattern: ^[a-z0-9_-]+$

max_connections · enum<integer>

The number of maximum connections allowed for the WebSocket server. If passed, the connection distribution strategy will be set to EVENLY.

Available options: 100, 200, 500, 2000, 5000, 10000

Response

200

application/vnd.api+json

WebsocketServerResource

data · WebsocketServerResource · object · required

Show child attributes

included · WebsocketApplicationResource · object[]

Show child attributes