Skip to main content
GET
/
v1
/
relay
/
status
Relay status
curl --request GET \
  --url https://api.example.com/v1/relay/status \
  --header 'Authorization: <authorization>'

​
Overview

Returns the current status of the Relay WebSocket service, including connection counts and service health. Use this before establishing a WebSocket connection to verify the relay is available. Required role: admin or member

​
Request headers

​
Authorization
string
required
JWT Bearer token. Format: Bearer <your-jwt>.

​
Response

Returns 200 OK. 
{
  "status": "healthy",
  "activeConnections": 142,
  "region": "us-east-1",
  "version": "1.4.2",
  "checkedAt": "2024-04-01T14:30:00Z"
}
FieldTypeDescription
statusstringService health: healthy, degraded, unavailable
activeConnectionsintegerNumber of active WebSocket connections across all tenants
regionstringAWS region serving this request
versionstringRelay service version
checkedAtstringISO 8601 timestamp of this status check

​
Error responses

StatusError codeDescription
401unauthorizedMissing or invalid JWT
503service_unavailableRelay is temporarily unavailable

​
Examples

curl https://api.causeflow.ai/v1/relay/status \
  -H "Authorization: Bearer eyJhbGc..."

Connect relay

Establish a WebSocket connection to the relay