Get WebSocket cluster
curl --request GET \
--url https://cloud.laravel.com/api/websocket-servers/{websocketServer} \
--header 'Authorization: Bearer <token>'{
"data": {
"id": "<string>",
"attributes": {
"name": "<string>",
"hostname": "<string>",
"created_at": "2023-11-07T05:31:56Z"
},
"relationships": {
"applications": {
"data": [
{
"id": "<string>"
}
]
}
}
},
"included": [
{
"id": "<string>",
"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": {
"id": "<string>"
}
}
}
}
]
}WebSocket Clusters
Get WebSocket cluster
Get a specific WebSocket cluster.
GET
/
websocket-servers
/
{websocketServer}
Get WebSocket cluster
curl --request GET \
--url https://cloud.laravel.com/api/websocket-servers/{websocketServer} \
--header 'Authorization: Bearer <token>'{
"data": {
"id": "<string>",
"attributes": {
"name": "<string>",
"hostname": "<string>",
"created_at": "2023-11-07T05:31:56Z"
},
"relationships": {
"applications": {
"data": [
{
"id": "<string>"
}
]
}
}
},
"included": [
{
"id": "<string>",
"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": {
"id": "<string>"
}
}
}
}
]
}Authorizations
The Bearer Token generated on the Cloud UI.
Path Parameters
The websocket server identifier
Query Parameters
Available options:
applications Was this page helpful?
⌘I

