API Documentation

Protected endpoints require a valid auth token in the query string and an active browser session cookie.

Public endpoints

MethodPathDescription
GET/healthService health probe (JSON)
GET/api/v1/info.jsonProduct metadata
GET/api/v1/endpoints.jsonPublished API routes

Authenticated Relay Endpoint

Primary gateway for packet ingest and session pull operations.

MethodPathBodyResponse
POST/stream/relay/hub.php?auth=<token>binary / octet-stream4xx on invalid session (expected)
GET/stream/relay/hub.php?auth=<token>—pull / stream chunk

Required headers (client)

Accept: */*
Content-Type: application/octet-stream   # for POST ingest
Cookie: session_id=<uuid>
Origin: https://<your-host>/
Referer: https://<your-host>/
User-Agent: Mozilla/5.0 ... Firefox/...
Sec-Fetch-Mode: cors
Sec-Fetch-Site: same-origin

Error codes

CodeMeaning
200Public static content / docs
400Invalid or expired relay session
401Missing auth token
405Method not allowed on static route