REST API Reference

HTTP /v1 Endpoints

Programmatic access to cluster management, event broadcasting, and authentication.

Server Authentication Header

Include your application secret key in the Authorization header:

Authorization: Bearer sk_live_your_secret_key

POST/v1/apps/:id/events

Trigger an event on one or more topic channels

POST/v1/apps/:id/auth/channel

Generate HMAC auth signature for private or presence channels

GET/v1/apps/:id/channels

List active channels and subscriber rosters

GET/v1/apps/:id/connections

Current active connection count and quota metrics

GET/v1/apps/:id/usage

Daily 30-day message counts and bandwidth ledger

GET/v1/health

System liveness probe and server uptime

GET/v1/ready

Cluster readiness probe (PostgreSQL, Redis, NATS)