Health Status API

Check whether ComPDF Self-hosted and its dependencies are reachable.

Item	Value
Request URL	GET http://localhost:8080/api/v1/status
Authentication	Public

Request Example

curl -X GET "http://localhost:8080/api/v1/status"

Response

{
  "code": 200,
  "msg": "success",
  "data": {
    "infra": {
      "mysql": "ok",
      "redis": "ok"
    },
    "app": "ok",
    "web": "ok",
    "ts": "2026-07-07T00:00:00.000Z"
  }
}

Field	Description
data.infra.mysql	MySQL status: ok or down.
data.infra.redis	Redis status: ok or down.
data.app	Application health status: ok or down.
data.web	Web entry status. If this endpoint responds, it is ok.
data.ts	Server timestamp in ISO 8601 format.