How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Laravel WebSocket Clusters API

The WebSocket Clusters API from Laravel — 3 operation(s) for websocket clusters.

Laravel WebSocket Clusters API is one of 42 APIs that Laravel publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include WebSocket Clusters. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 6 operations across 3 paths, and defines 12 schemas. It is described by OpenAPI 3.1.0, at version 0.0.1.

Requests are made against a single base URL, https://cloud.laravel.com/api.

6 operations 3 paths 12 schemas 1 DELETE3 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
0.0.1
Base URL
https://forge.laravel.com/api
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Laravel WebSocket Clusters API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearer) (http). By default, every request must be authenticated.

  • http — The Bearer Token generated on the Cloud UI.

Paths & Operations 6

Across 3 paths, the API surfaces 6 operations — 1 DELETE, 3 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

WebSocket Clusters 6
GET
/websocket-servers
List WebSocket clusters
public.websocket-servers.index 4 params → 200401403
POST
/websocket-servers
Create WebSocket cluster
public.websocket-servers.store body → 201401403422
GET
/websocket-servers/{websocketServer}
Get WebSocket cluster
public.websocket-servers.show 2 params → 200404403
PATCH
/websocket-servers/{websocketServer}
Update WebSocket cluster
public.websocket-servers.update 1 param body → 200404403422
DELETE
/websocket-servers/{websocketServer}
Delete WebSocket cluster
public.websocket-servers.destroy 1 param → 204404403422
GET
/websocket-servers/{websocketServer}/metrics
Get WebSocket cluster metrics
public.websocket-servers.metrics 2 params → 200404403422

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are WebsocketServerResource (4 properties), WebsocketApplicationResource (4 properties), StoreWebsocketServerRequest (4 properties), WebsocketServerResourceIdentifier (2 properties). Each schema is shown below with its type and property counts.

CloudRegion
string
MetricPeriod
string
WebsocketApplicationResource
object
4 properties 2 required
WebsocketApplicationResourceIdentifier
object
2 properties 2 required
WebsocketServerStatus
string
WebsocketServerResourceIdentifier
object
2 properties 2 required
WebsocketServerConnectionDistributionStrategy
string
UpdateWebsocketServerRequest
object
2 properties
WebsocketServerResource
object
4 properties 2 required
WebsocketServerType
string
StoreWebsocketServerRequest
object
4 properties 4 required
WebsocketServerMaxConnection
integer

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

laravel-websocket-clusters-api-openapi.yml Raw ↑

Other APIs Laravel publishes across the network.

Laravel Forge API (Legacy v1)
Envoyer API
Laravel Applications API
Laravel Background Processes API
Laravel Backups API
Laravel Bucket Keys API
Laravel Caches API
Laravel Commands API
Laravel Database Clusters API
Laravel Database Restores API
Laravel Database Snapshots API
Laravel Databases API
Where this information came from

This is an independent, third-party profile of Laravel WebSocket Clusters API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.