Health check API

One endpoint that tells you whether the Pixel Streaming service is operational — for a status indicator in your own product, or for uptime monitoring.

Request

POST https://agw.eagle3dstreaming.com/api/v4/health-check
Content-Type: application/json
{
  "apiKey": "your Eagle 3D Streaming API key"
}

The key is your Eagle 3D Streaming API key. The endpoint accepts POST only — a GET on the same URL returns HTTP 404. Most uptime monitors send GET by default, so set yours to POST with the JSON body above.

Response

Healthy:

{
  "status": "ok",
  "checks": { "connector": "healthy" },
  "timestamp": "2026-04-24T04:32:40.168Z",
  "version": "1.0.0"
}

Not healthy:

{
  "status": "unhealthy",
  "checks": { "connector": "unhealthy" },
  "timestamp": "2026-04-24T06:44:20.479Z",
  "message": "One or more health checks failed"
}
FieldTypeWhat it is
statusstring or numberok or unhealthy on a checked response; error when the key is missing. On an invalid key it is the number 401, not a string — see below.
checks.connectorstringThe streaming connector: healthy or unhealthy.
timestampstringUTC time of the response.
versionstringAPI version. Only present on success.
messagestringDetail. Only present when unhealthy.

The three statuses are not two

A failed request is about your request, not the service

ok means the service is up and unhealthy means it is not — but a failed request means the call itself failed authentication or validation. A status page that treats that as an outage will report the service down when the real problem is a key that expired on your side.

The two failure shapes do not share a status type, so do not branch on status alone. Branch on the HTTP status code, or on the presence of an error or code field.

Invalid key — HTTP 401:

{
  "error": "Invalid API Key",
  "status": 401,
  "meta": { "error": { "message": "illegal argument" }, "status": 403 }
}

Missing key — HTTP 400:

{
  "status": "error",
  "code": "MISSING_API_KEY",
  "message": "API key is required and must be non-empty",
  "timestamp": "2026-04-24T04:38:06.038Z"
}

What to use it for

Last updated