Health check

Returns the health status of the VIA Protocol service, including database connectivity and service availability.

GET /v1/via/health

Health check

cURL

curl --request GET \
  --url https://api.example.com/v1/via/health

200

{
  "protocol": "via-protocol",
  "version": "1.0.0",
  "status": "ok",
  "timestamp": "2025-01-22T14:30:00.000Z"
}

Response

200 - application/json

Service is healthy

protocol · string · required

Protocol name

Example:

"via-protocol"

version · string · required

Protocol version

Example:

"1.0.0"

status · enum<string> · required

Service health status

Available options: ok, error

Example:

"ok"

timestamp · string · required

Current timestamp in ISO 8601 format

Example:

"2025-01-22T14:30:00.000Z"