Skip to content

Operational snapshot — counters, alarms, processing rate, license expiry

GET
/api/status

Authenticated. Returns the dashboard headline counters (24h packet count, 6h blocked count, 6h LLM analysis count, 6h automated reactions), the current system health colour, uptime, processing rate, license expiry, and version metadata.

Operational snapshot

Operational snapshot returned by GET /api/status. Headline counters, alarm count, uptime, processing rate, license expiry, version metadata.

object
dhcp_packets_processed
required

24h DHCP packet count.

integer format: int64
blocked_packets_6h
required
integer format: int64
suspicious_activities
required
integer format: int64
llm_analyses_6h
required
integer format: int64
automated_reactions_6h
required
integer format: int64
system_status
required

Health colour (e.g. “healthy”, “degraded”).

string
system_alarms
required
integer format: int64
license_expires
required

License expiry, empty when license handler is absent.

string
uptime
required

Process uptime, free-form string.

string
processing_rate
required

Current processing rate, free-form string.

string
version
required
string
build_time
required
string
schema_version
required
string

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

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