Update WebSocket application

Update a WebSocket application.

PATCH /websocket-applications/{websocketApplication}

Update WebSocket application

cURL

curl --request PATCH \
  --url https://cloud.laravel.com/api/websocket-applications/{websocketApplication} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "ping_interval": 30,
  "activity_timeout": 30,
  "allowed_origins": [
    "<string>"
  ]
}
'

200

{
  "data": {
    "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>"
        }
      }
    }
  },
  "included": [
    {
      "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>"
            }
          ]
        }
      }
    }
  ]
}

Authorizations

Authorization · string · header · required

The Bearer Token generated on the Cloud UI.

Path Parameters

websocketApplication · string · required

The websocket application identifier

Body

application/json

name · string

Required string length: 3 - 40

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

ping_interval · integer

Required range: 1 <= x <= 60

activity_timeout · integer

Required range: 1 <= x <= 60

allowed_origins · string[]

Maximum string length: 255

Response

200

application/vnd.api+json

WebsocketApplicationResource

data · WebsocketApplicationResource · object · required

Show child attributes

included · WebsocketServerResource · object[]

Show child attributes