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>"
  ]
}
'

import requests

url = "https://cloud.laravel.com/api/websocket-applications/{websocketApplication}"

payload = {
    "name": "<string>",
    "ping_interval": 30,
    "activity_timeout": 30,
    "allowed_origins": ["<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>',
    ping_interval: 30,
    activity_timeout: 30,
    allowed_origins: ['<string>']
  })
};

fetch('https://cloud.laravel.com/api/websocket-applications/{websocketApplication}', 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-applications/{websocketApplication}",
  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>',
    'ping_interval' => 30,
    'activity_timeout' => 30,
    'allowed_origins' => [
        '<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-applications/{websocketApplication}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"ping_interval\": 30,\n  \"activity_timeout\": 30,\n  \"allowed_origins\": [\n    \"<string>\"\n  ]\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-applications/{websocketApplication}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"ping_interval\": 30,\n  \"activity_timeout\": 30,\n  \"allowed_origins\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"ping_interval\": 30,\n  \"activity_timeout\": 30,\n  \"allowed_origins\": [\n    \"<string>\"\n  ]\n}"

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

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",
        "hostname": "<string>",
        "created_at": "2023-11-07T05:31:56Z"
      },
      "relationships": {
        "applications": {
          "data": [
            {
              "type": "websocketApplications",
              "id": "<string>"
            }
          ]
        }
      }
    }
  ]
}

{
  "message": "<string>"
}

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

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