Skip to main content
PATCH
/
websocket-servers
/
{websocketServer}
Update WebSocket cluster
curl --request PATCH \
  --url https://cloud.laravel.com/api/websocket-servers/{websocketServer} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "max_connections": 100
}
'
{
  "data": {
    "id": "<string>",
    "type": "websocketServers",
    "relationships": {}
  },
  "included": [
    {
      "id": "<string>",
      "type": "websocketApplications",
      "relationships": {}
    }
  ]
}

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

WebsocketServerResource

data
WebsocketServerResource · object
required
included
WebsocketApplicationResource · object[]