Skip to main content
GET
/
websocket-applications
/
{websocketApplication}
Get WebSocket application
curl --request GET \
  --url https://cloud.laravel.com/api/websocket-applications/{websocketApplication} \
  --header 'Authorization: Bearer <token>'
import requests

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

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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 => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://cloud.laravel.com/api/websocket-applications/{websocketApplication}")
  .header("Authorization", "Bearer <token>")
  .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::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "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>"
}

Authorizations

​
Authorization
string
header
required

The Bearer Token generated on the Cloud UI.

Path Parameters

​
websocketApplication
string
required

The websocket application identifier

Query Parameters

​
include
enum<string>[]
Available options:
server

Response

WebsocketApplicationResource

​
data
WebsocketApplicationResource · object
required
​
included
WebsocketServerResource · object[]