Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Schemas

There is no public reflection / RPC schema for publish and subscribe. Use the SDK, or stay on the wire described in Protocols.

REST (JSON)

Token admin bodies live on the edge OpenAPI at /api-docs/openapi.json and Swagger UI at /swagger-ui when the edge exposes them.

Main shapes:

  • POST /v1/get-tokencreated_by, optional description, right (tenant_grants, optional allow_ip_masks / allow_regions / allowed_ws_origin / allow_protocols / ingress_kb_per_sec / egress_kb_per_sec, expires_at)
  • response { "token": "AT_..." }
  • PUT /v1/refresh-tokentoken_id, expires_at
  • DELETE /v1/revoke-token{ "token": "AT_..." }

See REST API for curl examples.

WebSocket

  • Text: SUB: / UNSUB: / OK:SUB: / OK:UNSUB: / ERR: / PING / PONG
  • Binary: publish (v1 broadcast or v2 with a delivery tag) and deliver (tag 0x01, tenant, channel, payload, matched patterns)

WebTransport

Same application frames as WebSocket on one bidirectional stream, plus optional unidirectional subscribe lines. See WebTransport.