---
title: "Get WebSocket cluster"
method: GET
path: "/websocket-servers/{websocketServer}"
tags: ["WebSocket Clusters"]
---

# Get WebSocket cluster

`GET /websocket-servers/{websocketServer}`

## Request

- Base URL: `https://cloud.laravel.com/api`
- URL: `https://cloud.laravel.com/api/websocket-servers/{websocketServer}`
- Auth: HTTP bearer

Get a specific WebSocket cluster.

## Path parameters

- `websocketServer` string, required

## Query parameters

- `include` string[]

## Response `200`

`WebsocketServerResource`

- object
  - `data` WebsocketServerResource, required
    - `id` string, required
    - `type` 'websocketServers', required
    - `attributes` object
      - `name` string, required
      - `type` 'reverb', required
      - `region` 'us-east-1' | 'us-east-2' | 'ca-central-1' | 'eu-central-1' | 'eu-west-1' | 'eu-west-2' | 'eu-west-3' | 'me-central-1' | 'ap-southeast-1' | 'ap-southeast-2' | 'ap-northeast-1', required
      - `status` 'creating' | 'updating' | 'available' | 'stopped' | 'deleting' | 'deleted' | 'unknown', required
      - `max_connections` 100 | 200 | 500 | 2000 | 5000 | 10000, required
      - `connection_distribution_strategy` 'evenly' | 'custom', required
      - `hostname` string, required
      - `created_at` string, date-time, nullable, required
    - `relationships` object
      - `applications` object
        - `data` WebsocketApplicationResourceIdentifier[], required
          - `type` 'websocketApplications', required
          - `id` string, required
  - `included` WebsocketApplicationResource[]
    - `id` string, required
    - `type` 'websocketApplications', required
    - `attributes` object
      - `name` string, required
      - `app_id` string, required
      - `allowed_origins` unknown[], required
        - unknown
      - `ping_interval` integer, required
      - `activity_timeout` integer, required
      - `max_message_size` integer, required
      - `max_connections` integer, required
      - `created_at` string, date-time, nullable, required
      - union
        - object
          - `key` string, required
          - union
            - string[]
            - object
              - …
        - string[]
    - `relationships` object
      - `server` object
        - `data` WebsocketServerResourceIdentifier, required
          - `type` 'websocketServers', required
          - `id` string, required

## Other responses

- `403`: Authorization error
- `404`: Not found

---

[API](https://skmtc.dev/laravel/apis/laravel-cloud.md) - [All operations](https://skmtc.dev/laravel/apis/laravel-cloud/llms.txt) - [OpenAPI document](https://skmtc.dev/laravel/apis/laravel-cloud/revisions/af603f54ff33?raw)