Atlas
Health

Health check

Returns the health status of the Atlas API including checks for datasource connectivity, LLM provider, semantic layer, internal database, explore backend, auth mode, and Slack integration. Returns HTTP 200 for 'ok' or 'degraded' status, and 503 for 'error' status.

GET
/api/health

Response Body

application/json

application/json

curl -X GET "http://localhost:3001/api/health"
{
  "status": "ok",
  "warnings": [
    "string"
  ],
  "brandColor": "string",
  "components": {
    "datasource": {
      "status": "healthy",
      "latencyMs": 0,
      "lastCheckedAt": "string",
      "message": "string",
      "model": "string",
      "backend": "string"
    },
    "internalDb": {
      "status": "healthy",
      "latencyMs": 0,
      "lastCheckedAt": "string",
      "message": "string",
      "model": "string",
      "backend": "string"
    },
    "provider": {
      "status": "healthy",
      "latencyMs": 0,
      "lastCheckedAt": "string",
      "message": "string",
      "model": "string",
      "backend": "string"
    },
    "scheduler": {
      "status": "healthy",
      "latencyMs": 0,
      "lastCheckedAt": "string",
      "message": "string",
      "model": "string",
      "backend": "string"
    },
    "sandbox": {
      "status": "healthy",
      "latencyMs": 0,
      "lastCheckedAt": "string",
      "message": "string",
      "model": "string",
      "backend": "string"
    }
  },
  "checks": {
    "datasource": {
      "status": "ok",
      "latencyMs": 0,
      "error": "string"
    },
    "provider": {
      "status": "ok",
      "provider": "string",
      "model": "string",
      "error": "string"
    },
    "semanticLayer": {
      "status": "ok",
      "entityCount": 0,
      "error": "string"
    },
    "internalDb": {
      "status": "ok",
      "latencyMs": 0,
      "error": "string"
    },
    "explore": {
      "backend": "nsjail",
      "isolated": true,
      "isolationVerified": true,
      "pluginId": "string"
    },
    "auth": {
      "mode": "none",
      "enabled": true,
      "error": "string"
    },
    "slack": {
      "enabled": true,
      "mode": "disabled"
    }
  },
  "sources": {
    "property1": {
      "status": "healthy",
      "latencyMs": 0,
      "message": "string",
      "checkedAt": "string",
      "dbType": "string"
    },
    "property2": {
      "status": "healthy",
      "latencyMs": 0,
      "message": "string",
      "checkedAt": "string",
      "dbType": "string"
    }
  }
}
{
  "status": "ok",
  "warnings": [
    "string"
  ],
  "brandColor": "string",
  "components": {
    "datasource": {
      "status": "healthy",
      "latencyMs": 0,
      "lastCheckedAt": "string",
      "message": "string",
      "model": "string",
      "backend": "string"
    },
    "internalDb": {
      "status": "healthy",
      "latencyMs": 0,
      "lastCheckedAt": "string",
      "message": "string",
      "model": "string",
      "backend": "string"
    },
    "provider": {
      "status": "healthy",
      "latencyMs": 0,
      "lastCheckedAt": "string",
      "message": "string",
      "model": "string",
      "backend": "string"
    },
    "scheduler": {
      "status": "healthy",
      "latencyMs": 0,
      "lastCheckedAt": "string",
      "message": "string",
      "model": "string",
      "backend": "string"
    },
    "sandbox": {
      "status": "healthy",
      "latencyMs": 0,
      "lastCheckedAt": "string",
      "message": "string",
      "model": "string",
      "backend": "string"
    }
  },
  "checks": {
    "datasource": {
      "status": "ok",
      "latencyMs": 0,
      "error": "string"
    },
    "provider": {
      "status": "ok",
      "provider": "string",
      "model": "string",
      "error": "string"
    },
    "semanticLayer": {
      "status": "ok",
      "entityCount": 0,
      "error": "string"
    },
    "internalDb": {
      "status": "ok",
      "latencyMs": 0,
      "error": "string"
    },
    "explore": {
      "backend": "nsjail",
      "isolated": true,
      "isolationVerified": true,
      "pluginId": "string"
    },
    "auth": {
      "mode": "none",
      "enabled": true,
      "error": "string"
    },
    "slack": {
      "enabled": true,
      "mode": "disabled"
    }
  },
  "sources": {
    "property1": {
      "status": "healthy",
      "latencyMs": 0,
      "message": "string",
      "checkedAt": "string",
      "dbType": "string"
    },
    "property2": {
      "status": "healthy",
      "latencyMs": 0,
      "message": "string",
      "checkedAt": "string",
      "dbType": "string"
    }
  }
}