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

Get /api/config

GET
/api/config

Auto-generated from server.go. Handler: s.getConfig.

Authorizations

Section titled “Authorizations ”

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful response

Get /api/config.

Lifted by tools/schema-lift on 2026-05-16 from a live sample of GET /api/config against the demo. Required fields are conservative — server returned all of them in the seed; relax to optional if some states legitimately omit.

object
core
required
object
llm
required
object
enabled
required
boolean
api_type
required
string
base_url
required
string format: uri
timeout_seconds
required
integer
prompt_template_path
required
string
llm_actions
required
object
enabled
required
boolean
interval_seconds
required
integer
operational
required
object
llm
required
object
active
required
boolean
model
required
string
temperature
required
number
top_k
required
integer
top_p
required
number
min_p
required
number
repeat_penalty
required
number
repeat_last_n
required
integer
analysis_interval_minutes
required
integer
analysis_time_window_hours
required
integer
max_events_per_analysis
required
integer
min_analysis_interval_minutes
required
integer
llm_actions
required
object
active
required
boolean
interval_seconds
required
integer
system
required
object
disable_database_config
required
boolean
config_readonly
required
boolean
logging
required
object
level
required
integer
file_path
required
string
api_log_path
required
string
max_size
required
integer
max_age
required
integer
max_backups
required
integer
compress
required
boolean
foreground
required
boolean
restart_required
required
Array<string>
api
required
object
enabled
required
boolean
port
required
integer
read_timeout
required
integer
write_timeout
required
integer
debug
required
boolean
websocket
required
object
enabled
required
boolean
event_buffer_size
required
integer
max_connections
required
integer
ping_interval_secs
required
integer
pong_timeout_secs
required
integer
write_timeout_secs
required
integer
events_per_second
required
integer
burst_multiplier
required
integer
history
required
object
max_page_size
required
integer
default_page_size
required
integer
max_time_range_days
required
integer
default_time_range_seconds
required
integer
query_timeout_seconds
required
integer
csv_max_records
required
integer
csv_streaming
required
boolean
device_events_max
required
integer

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