Uptime: Wiki | Appliance

Parameters

Path Parameters

id*integer

Entity id

Formatint64

Range0 <= value

Code example

curl -X GET "https://example.com/api/v1/network/appliances/0"

Response example

{  "id": 0,  "display_name": "string",  "display_name_plain": "string",  "rack_id": 0,  "start_u": 0,  "u_size": 0,  "az_id": 0,  "inv_status": "string",  "appliance_kind": "string",  "sku_name": "string",  "gateway_addon": true,  "fabric_capacity_gbps": 0,  "fabric_load_gbps": 0.1,  "fabric_saturated": true,  "forwarding_ceiling_gbps": 0.1,  "egress_gbps": 0.1,  "ingress_gbps": 0.1,  "wan_ingress_gbps": 0.1,  "wan_egress_gbps": 0.1,  "lan_ingress_gbps": 0.1,  "lan_egress_gbps": 0.1,  "threats": [    {      "class": "string",      "label": "string",      "label_eng": "string",      "reaching": 0.1,      "mitigated": 0.1,      "residual": 0.1,      "capacity": 0.1,      "defense_capable": true,      "unit": "string"    }  ],  "ports": [    {      "index": 0,      "label": "string",      "link": "Down",      "active": true,      "cable_ids": [        0      ],      "peer": null,      "port_id": 0,      "state": "string",      "media": "string",      "gbps_tx": 0.1,      "gbps_rx": 0.1,      "link_capacity_gbps": 0,      "error_count": 0,      "bytes_egress_total": 0,      "bytes_ingress_total": 0,      "link_flaps": 0,      "cable_able": true,      "connector": "string",      "color": "string",      "breakout_used_gbps": 0,      "breakout_capacity_gbps": 0,      "breakout_leg_count": 0    }  ],  "inspection_capacity_gbps": 0,  "inspection_load_gbps": 0.1,  "inspection_state": "string",  "inspection_saturated": true,  "inspection_enabled": true,  "enabled_functions": [    "string"  ],  "owned_functions": [    "string"  ],  "dropped_per_sec": 0.1,  "events_per_sec": 0.1,  "scrubbed_gbps": 0.1,  "indicator": "Off",  "monthly_opex_dollars": 0.1,  "powered": true,  "power_feeds": 0}

Response body

200The entity

application/json

id*integer

Formatint32

Range0 <= value

display_name?string

Player-facing identity like fw-01 / ids-01 / lb-01 (per-kind sequence). Empty on legacy saves whose appliances pre-date the two-voice naming pass; clients fall back to kind + id.

display_name_plain?string

Plain-mode counterpart: firewall 1 / intrusion detector 1. See HostView::display_name_plain.

rack_id*integer

Formatint32

Range0 <= value

start_u*integer

Formatint32

Range0 <= value

u_size*integer

Formatint32

Range0 <= value

az_id?integer

Availability zone this appliance sits in. Host / Switch / Gateway all carry one; the appliance corner did not, so nothing could scope the security estate per AZ without re-deriving it from rack_id. Resolved from the rack for a racked box, and from the HOST GATEWAY for a gateway_addon (which has no rack of its own). 0 when neither resolves. Four-corner parity — docs/SCHEMA.md § Network entities.

Formatint32

Range0 <= value

inv_status?string

Lifecycle status — see HostView::inv_status. Racked appliances are the only ones in this array (carried / loose surface via carried_items), so in practice this reads "Mounted" or "SellQueued"; it exists so a client can tell a box awaiting collection from a working one without a second lookup. Four-corner parity with Host / Switch / PatchPanel.

appliance_kind*string

Spec-aligned kind tag ("firewall" / "ids" / "waf" / "ddos_scrubber" / "vpn" / "loadbalancer" / "hsm" / "siem"). Drives icon + tone. Per docs/SCHEMA.md § Appliance.

sku_name*string

gateway_addon?boolean

True for gateway ADD-ONS (ApplianceMount::GatewayAddon) — license modules living inside a gateway, not racked boxes. They have no rack position, no ports, and (since the addon-mitigation fold) their per-class work is attributed to the HOST GATEWAY's defender entry, so their own drop/event meters legitimately read 0. Standalone-appliance UI (the IDS performance board, SIEM presence, rack rendering) must skip these — the gateway console owns their presentation.

fabric_capacity_gbps*integer

Nameplate forwarding ceiling — wire-rate throughput when the inspection plane is bypassed. Compared against fabric_load_gbps.

Formatint32

Range0 <= value

fabric_load_gbps?number

Smoothed full-duplex fabric load in Gbps (= egress_gbps + ingress_gbps, independently smoothed). The saturation metric; when this exceeds fabric_capacity_gbps the forwarding plane drops packets regardless of inspection state.

Formatdouble

fabric_saturated?boolean

Forwarding-plane saturation edge: fabric_load_gbps over the appliance's inspection-REDUCED effective forwarding capacity (deep inspection eats forwarding headroom). Engine-computed in the appliance fabric pass for IN-PATH inspectors that actually forward; an in-path box in this state drops customer traffic transiting it (facility-wide, folded into the same drop path as switch/uplink saturation) and fires an ApplianceFabricSaturated event + incident on the rising edge — like Switch/Gateway/Uplink. Off-path taps (HSM/SIEM) never forward, so this stays false for them.

forwarding_ceiling_gbps?number

The appliance's effective FORWARDING ceiling with deep inspection's penalty applied — fabric_load_gbps is the load against it, and it IS the threshold fabric_saturated flips on. Full fabric_capacity_gbps when inspection is bypassed/off/ceiling-at-or-above-fabric; collapses toward inspection_capacity_gbps as inspection engages. Mirrors GatewayView::forwarding_ceiling_gbps (same shared curve, sim_core::security::effective_forwarding_capacity_gbps, same reason: a client dividing fabric_load_gbps by the raw nameplate fabric_capacity_gbps disagreed with the engine's own saturation verdict). Single source of truth: Appliance::effective_forwarding_capacity_gbps(). Never re-derive it renderer-side.

Formatdouble

egress_gbps?number

Smoothed directional egress in Gbps (traffic leaving the appliance toward the LAN side). Pairs with ingress_gbps. Until the engine ships a directional split on appliance cables, this is populated with the legacy half-duplex flow figure for backward compat.

Formatdouble

ingress_gbps?number

Smoothed directional ingress in Gbps (traffic arriving from the WAN side). Mirror of egress_gbps.

Formatdouble

wan_ingress_gbps?number

Formatdouble

wan_egress_gbps?number

Formatdouble

lan_ingress_gbps?number

Formatdouble

lan_egress_gbps?number

Formatdouble

threats?array<>

Per-device threat handling — ONLY the classes THIS box defends, with what reached it, what it absorbed, and what it passed on. Replaces the confusing fleet-wide read: a firewall shows Protocol only, an IDS shows Intrusion only. Empty for off-path boxes (HSM / SIEM). From the engine positional cascade.

ports?array<>

Per-port views — one entry per physical port on the appliance. Mirrors SwitchView.ports / GatewayView.ports. Closes the parity gap noted in docs/SCHEMA.md § ApplianceView. Each port carries media, state, link capacity, live throughput, peer reference; the diegetic inspector + topology view both consume this.

inspection_capacity_gbps?integer

Rated DPI ceiling (Gbps). Typically a fraction of fabric_capacity_gbps — e.g. a 10 G appliance might inspect at 3 G. When inspection_enabled is true and live throughput exceeds this, the appliance either bypasses (drops to forwarding rate) or drops packets, depending on inspection_state.

Formatint32

Range0 <= value

inspection_load_gbps?number

Smoothed live throughput actually deep-inspected. Distinct from egress_gbps (total pass-through). When inspection is bypassed this is 0 even while pass-through is high.

Formatdouble

inspection_state?string

"Active" (inspecting), "Bypass" (line-rate forwarding, no inspection), or "Failed" (engine forced drop — DPI overload). Drives the inspection-plane LED color on the appliance pill.

inspection_saturated?boolean

Edge-triggered: inspection_load_gbps > inspection_capacity_gbps. Even when fabric still has headroom, this fires when the DPI engine itself overloads.

inspection_enabled?boolean

Whether deep inspection is currently on (the bypass lever, toggled by SetApplianceInspection).

enabled_functions?array<string>

Enabled security functions on this box as slugs ("firewall"/"ips"/ "scrub") — the base plus any licensed-on. Dynamic (changes only on a license toggle). The console joins these with the catalog's per-SKU license options (ApplianceSkuView.licenses) to render the toggle rows

costs — the static option data is NOT duplicated per tick.

owned_functions?array<string>

Function-license slugs whose one-time capex has already been paid on this box (the ownership ledger — superset of enabled_functions). An owned license that's been unsubscribed (not in enabled_functions) can be re-enabled for FREE; the console reads this to show Resubscribe (free) vs Buy $X.

dropped_per_sec?number

Live filtering throughput, latest ring sample. ONE FIELD PER ATTACK CLASS, in that class's own unit — never combined, and a dual-licensed (Scrub + Firewall) box populates more than one:

dropped_per_sec — stateful-firewall Protocol drops, Kpps
scrubbed_gbps — scrubber Volumetric absorb, Gbps
events_per_sec — IDS/IPS Intrusion detections, events/s

A box without the matching licence enabled reports 0 for that class. Off-path kinds (HSM/SIEM) report 0 for all three. Abstract magnitudes (spec §9.1).

Formatdouble

events_per_sec?number

Formatdouble

scrubbed_gbps?number

Formatdouble

indicator*IndicatorLed

Value in

"Off"
"Green"
"Amber"
"Red"
"FlashRed"

monthly_opex_dollars?number

Live projected monthly opex ($/mo) — running fee + chassis power + seated-optic draw. Mirrors the host console's read.

Formatdouble

powered?boolean

At least one AC cord seated (or none required). False = dark until the player plugs it in. Mirrors the engine's powered.

power_feeds?integer

Connected AC cord count. >= 2 = PSU-failure resilience at redundant_psu_overhead_w extra draw per extra cord.

Formatint32

Range0 <= value

Appliance

Parameters

Try the endpoint

Code example

Response example

Response body

On this page