Health Status API

❖ Feature Description

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

Health Status API

GEThttp://localhost:8080/api/v1/status

❖ Response Properties

Field	Type	Description
code	Integer	Business status code.
msg	String	Response message.
data	Object	Response data.
data.infra	Object
data.infra.mysql	String
data.infra.redis	String
data.app	String
data.web	String
data.ts	String

🔗Request Example

curl --request GET \
+  --url http://localhost:8080/api/v1/status

✓Response Example

200 OK

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