Liveness check — confirms the API process is reachable

GET

/api/health

• Your DHCP Shield Pro appliance

Public, unauthenticated. Returns the running version, build time, and schema version. Intended for load-balancer health checks and the GUI’s pre-login version banner.

Responses

200

Service is healthy

Liveness payload returned by GET /api/health. Public, unauthenticated.

object

healthy

required

boolean

message

required

string

Example

API Connected

version

required

string

build_time

required

string

schema_version

required

string

500

Internal server error

Standardised error envelope per RFC 7807. Many existing endpoints still return an older shape (e.g. {"error": "..."}). This schema documents the target shape; legacy endpoints will be migrated in Phase 70. Per D-21 the spec describes current behaviour without enforcing the migration here.

object

type

A URI reference that identifies the problem type.

string format: uri-reference

default: about:blank

title

A short human-readable summary of the problem.

string

status

The HTTP status code generated by the origin server.

integer format: int32

>= 100 <= 599

detail

A human-readable explanation specific to this occurrence.

string

instance

A URI reference that identifies the specific occurrence.

string format: uri-reference

error

Legacy error message field. Will be removed once handlers are migrated.

string

details

Legacy per-field error details. Will be removed once handlers are migrated.

object

key

additional properties

string

requestId

The request id middleware-assigned identifier for tracing.

string