Create WebSocket cluster

Create a new WebSocket cluster with a default application.

POST /websocket-servers

Create WebSocket cluster

cURL

curl --request POST \
  --url https://cloud.laravel.com/api/websocket-servers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "type": "reverb",
  "region": "us-east-2",
  "max_connections": 123
}
'

201

{
  "data": {
    "id": "<string>",
    "type": "websocketServers",
    "attributes": {
      "name": "<string>",
      "type": "reverb",
      "region": "us-east-2",
      "status": "creating",
      "max_connections": 100,
      "connection_distribution_strategy": "evenly",
      "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>"
          }
        }
      }
    }
  ]
}

Authorizations

Authorization · string · header · required

The Bearer Token generated on the Cloud UI.

Body

application/json

name · string · required

Required string length: 3 - 40

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

type · enum<string> · required

Available options: reverb

region · enum<string> · required

Available options: us-east-2, us-east-1, ca-central-1, eu-central-1, eu-west-1, eu-west-2, me-central-1, ap-southeast-1, ap-southeast-2, ap-northeast-1

max_connections · integer · required

Response

201

application/vnd.api+json

WebsocketServerResource

data · WebsocketServerResource · object · required

Show child attributes

included · WebsocketApplicationResource · object[]

Show child attributes