Detailed health check (DB, MQTT, WebSocket) - Admin only

GET

/api/v1/health/detailed

const url = 'https://internal.myscore.live/api/v1/api/v1/health/detailed';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://internal.myscore.live/api/v1/api/v1/health/detailed \
  --header 'Authorization: Bearer <token>'

Returns per-service health status. Requires admin role.

Authorizations

JWT

Responses

200

Detailed health status

application/json

object

status

required

Aggregated status across all services

string

Allowed values: ok degraded

timestamp

required

ISO-8601 timestamp

string format: date-time

services

required

Per-service health results

Array<object>

object

service

required

Service name

string

status

required

Service health status

string

Allowed values: healthy unhealthy

message

Error message when unhealthy

string

nullable

details

Additional diagnostic details

object

Example

{
  "status": "ok",
  "timestamp": "2024-01-15T10:30:00.000Z",
  "services": [
    {
      "service": "database",
      "status": "healthy",
      "message": "Connection refused"
    }
  ]
}

401

Unauthorized

403

Forbidden - Admin only

503

Service unavailable