Skip to content
Sign in Get started
DHCP Shield Pro DHCP Shield Pro

Backend + database load averages and database resource utilization

GET
/api/system/load-averages

Authenticated. Returns 1m / 5m / 15m load averages for both the dhcp-processor host and the ClickHouse database host, plus additional database metrics: memory usage, CPU frequency, active queries / merges, disk read/write rates, disk used %, free/total bytes, uptime.

Authorizations

Section titled “Authorizations ”

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Load average snapshot

Combined backend (dhcp-processor host) + database (ClickHouse host) load averages and database resource utilization. Returned by GET /api/system/load-averages.

object
backend
required

Linux-style 1m / 5m / 15m load averages for the dhcp-processor host.

object
load1
required
number format: double
load5
required
number format: double
load15
required
number format: double
database
required

ClickHouse host load averages and resource utilization, sourced from system.asynchronous_metrics, system.metrics, and system.disks.

object
load1
required
number format: double
load5
required
number format: double
load15
required
number format: double
memory_resident
required
integer format: int64
cpu_freq_mhz
required
number format: double
active_queries
required
integer format: int64
active_merges
required
integer format: int64
disk_read_rate
required
number format: double
disk_write_rate
required
number format: double
disk_used_percent
required
number format: double
disk_free_bytes
required
integer format: int64
disk_total_bytes
required
integer format: int64
uptime
required
integer format: int64

401

Section titled “401 ”

Authentication is required or the supplied token is invalid.

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

500

Section titled “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