Skip to main content
The WireSocket Data Plane exposes HTTP and WebSocket endpoints across every deployed region. Endpoints are grouped into public (for your application) and infrastructure (for monitoring and administration).

​
Base URLs

WireSocket uses two different protocols depending on the endpoint type:
TypeProtocolBase URL
HTTP (JSON)https://https://{region-code}.wiresocket.net
WebSocketwss://wss://{region-code}.wiresocket.net
Replace {region-code} with any available node cluster (e.g., eu-central-1).

​
Authentication

All public endpoints require a valid JWT access token issued by the WireSocket Dashboard. See Authentication for how to obtain and refresh tokens. Infrastructure endpoints (/health, /metrics) are unauthenticated to support load balancer probes and Prometheus scraping.

​
Endpoints

Discovery

Resolve the correct regional node for a document before connecting. Eliminates wrong-region handshakes and ensures lowest latency on first connect.

WebSocket Sync

The core WireSocket product. All Yjs document updates, awareness state, and heartbeats flow through this connection.

Usage

Get a real-time snapshot of your application’s current concurrent connections and active documents across the global network.

Health

Tri-state liveness check used by load balancers and DNS failover. Returns 200 (healthy) or 503 (degraded/overloaded).

Metrics

Prometheus-compatible telemetry for node-level observability. Integrate with Grafana, Datadog, or any Prometheus-compatible stack.

​
Rate Limits

All HTTP endpoints are rate limited per IP address. See Rate Limits for policy details per endpoint.

​
Status

Live service status and incident history: status.wiresocket.com
Last modified on March 5, 2026