Service Health Check API

The Service Health Check API allows you to verify whether the Eagle 3D Streaming Pixel Streaming service is currently operational.

Endpoint

POST https://agw.eagle3dstreaming.com/api/v4/health-check

Request

Headers

Content-Type: application/json

Body

{
  "apiKey": "Insert Your Eagle 3D Streaming API Key"
}

To get API Key follow this doc.

Response

Success Response (Service Operational)

Returned when the service is healthy and the API key is valid:

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

Service Not Operational

Returned when one or more system components are not functioning correctly:

{
  "status": "unhealthy",
  "checks": {
    "connector": "unhealthy"
  },
  "timestamp": "2026-04-24T06:44:20.479Z",
  "message": "One or more health checks failed"
}

Field	Type	Description

Field	Type	Description
`status`	string	Overall service status (`ok`, `unhealthy`, or `error`)
`checks.connector`	string	Status of the streaming connector (`healthy` / `unhealthy`)
`timestamp`	string	Response timestamp (UTC)
`version`	string	API version (only in success response)
`message`	string	Additional details (present when unhealthy)

Failure Responses

Invalid API Key

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

Missing API Key

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

Status Interpretation

Status	Meaning

Status	Meaning
`ok`	Service is operational
`unhealthy`	Service is partially or fully unavailable
`error`	Request failed (authentication or validation issue)

Use Cases

Display real-time service status in your application
Monitor platform health programmatically
Notify users if streaming services are unavailable
Integrate into dashboards or uptime monitoring tools

Need help?

If you need any assistance, feel free to reach out through any of the following channels:

🛠️ Support Portal: Contact Our Support Team

💬 Discord Community (Faster Support): Join Our Discord Community

📧 Email Support: support@eagle3dstreaming.com

🆓 Get Started for free

Follow us on:

Facebook | GitHub | LinkedIn | YouTube