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

Returns table retention policies and disk space statistics

GET
/api/config/retention

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

Authorizations

Section titled “Authorizations ”

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful response

Returns table retention policies and disk space statistics.

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

object
tables
required
Array<object>
object
table_name
required
string
category
required
string
Allowed values: short medium long
current_ttl_days
required
integer
default_ttl_days
required
integer
size_bytes
required
integer
size_pretty
required
string
row_count
required
integer
ttl_column
required
string
non_configurable_tables
required
Array<object>
object
table_name
required
string
size_bytes
required
integer
size_pretty
required
string
row_count
required
integer
disk_space
required
object
total_bytes
required
integer
used_bytes
required
integer
free_bytes
required
integer
used_percent
required
number
warning_level
required
boolean
total_pretty
required
string
used_pretty
required
string
free_pretty
required
string

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