Returns the current running nftables configuration from the system (via `nft -j list ruleset`)

GET

/api/v1/nftables/config/running

• Your DHCP Shield Pro appliance

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

Authorizations

• bearerAuth

Responses

200

Successful response

Returns the current running nftables configuration from the system (via nft -j list ruleset).

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

object

config

required

object

nftables

required

Array<object>

object

metainfo

object

json_schema_version

required

integer

release_name

required

string

version

required

string

table

object

family

required

string

Allowed values: inet

handle

required

integer

name

required

string

Allowed values: dhcp_inspection

counter

object

bytes

required

integer

family

required

string

Allowed values: inet

handle

required

integer

name

required

string

packets

required

integer

table

required

string

Allowed values: dhcp_inspection

set

object

family

required

string

Allowed values: inet

flags

required

Array<string>

Allowed values: timeout dynamic

handle

required

integer

name

required

string

size

required

integer

table

required

string

Allowed values: dhcp_inspection

timeout

required

integer

type

required

string

Allowed values: mark

elem

Array<object>

object

elem

required

object

expires

required

integer

timeout

required

integer

val

required

integer

chain

object

family

required

string

Allowed values: inet

handle

required

integer

hook

string

name

required

string

policy

string

prio

integer

table

required

string

Allowed values: dhcp_inspection

type

string

rule

object

chain

required

string

expr

required

Array<object>

object

match

object

left

required

object

payload

object

field

required

string

protocol

required

string

meta

object

key

required

string

Allowed values: mark

op

required

string

Allowed values: != ==

accept

object

key

additional properties

any

counter

string

queue

object

flags

required

Array<string>

num

required

object

range

required

Array<integer>

drop

object

key

additional properties

any

vmap

object

data

required

object

set

required

Array<array>

key

required

object

&

required

array

jump

object

target

required

string

mangle

object

key

required

object

meta

required

object

key

required

string

Allowed values: mark

value

required

object

&

required

array

limit

object

burst

required

integer

per

required

string

Allowed values: minute second

rate

required

integer

inv

boolean

log

object

key

additional properties

any

set

object

elem

required

object

meta

object

key

required

string

Allowed values: mark

elem

object

timeout

required

integer

val

required

object

meta

required

object

key

required

string

Allowed values: mark

op

required

string

set

required

string

stmt

Array<object>

object

limit

required

object

burst

required

integer

per

required

string

Allowed values: minute second

rate

required

integer

inv

boolean

family

required

string

Allowed values: inet

handle

required

integer

table

required

string

Allowed values: dhcp_inspection

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

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