Uptime: Wiki | Gateway

Parameters

Path Parameters

id*integer

Entity id

Formatint64

Range0 <= value

Code example

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

Response example

{  "id": 0,  "display_name": "string",  "display_name_plain": "string",  "az_id": 0,  "sku_name": "string",  "form": "string",  "u_size": 0,  "rack_id": 0,  "start_u": 0,  "wan_port_count": 0,  "lan_port_count": 0,  "used_ports": 0,  "fabric_capacity_gbps": 0,  "fabric_load_gbps": 0.1,  "fabric_saturated": true,  "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,  "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    }  ],  "builtin_firewall": {    "dropped_per_sec": 0.1,    "class_label": "string",    "reaching": 0.1,    "mitigated": 0.1,    "residual": 0.1,    "capacity": 0.1,    "unit": "string"  },  "builtin_firewall_enabled": true,  "bgp_capable": true,  "multi_az_capable": true,  "bgp_advertising": true,  "wan_policy": "string",  "security_addons": [    {      "addon": "string",      "name": "string",      "class_label": "string",      "enabled": true,      "owned": true,      "capex_dollars": 0.1,      "monthly_dollars": 0.1    }  ],  "addon_throttled": true,  "addon_throttle": 0.1,  "forwarding_ceiling_gbps": 0.1,  "monthly_opex_dollars": 0.1,  "inv_status": "string",  "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"    }  ],  "powered": true,  "power_feeds": 0}

Response body

200The entity

application/json

Live edge-gateway projection. WAN port(s) cable to the edd; LAN ports to switches. Forwarding device in the reachability chain.

id*integer

Formatint32

Range0 <= value

display_name?string

display_name_plain?string

Plain-mode counterpart: gateway 1 vs gw-01.

az_id*integer

Formatint32

Range0 <= value

sku_name?string

form?string

u_size?integer

Formatint32

Range0 <= value

rack_id?integer

Formatint32

Range0 <= value

start_u?integer

Formatint32

Range0 <= value

wan_port_count?integer

Live count of this gateway's ports currently cabled to the carrier (a edd / patch panel) — i.e. acting WAN. Derived from cabling, not a nameplate: gateways are ARM-ASIC and have no fixed WAN ports.

Formatint32

Range0 <= value

lan_port_count?integer

Live count of ports currently cabled to a switch — i.e. acting LAN.

Formatint32

Range0 <= value

used_ports?integer

Formatint32

Range0 <= value

fabric_capacity_gbps?integer

SKU fabric/forwarding ceiling — sustained traffic above this saturates the ARM-ASIC packet engine. Legacy name kept as alias.

Formatint32

Range0 <= value

fabric_load_gbps?number

Smoothed full-duplex fabric load in Gbps (= egress + ingress). Compared against fabric_capacity_gbps for the saturation banner.

Formatdouble

fabric_saturated?boolean

True when sustained fabric_load_gbps exceeds fabric_capacity_gbps — packets start dropping. Edge-triggered in the engine; banner state here.

egress_gbps?number

Smoothed directional egress (LAN-side outbound) in Gbps.

Formatdouble

ingress_gbps?number

Smoothed directional ingress (WAN-side inbound) in Gbps.

Formatdouble

wan_ingress_gbps?number

Formatdouble

wan_egress_gbps?number

Formatdouble

lan_ingress_gbps?number

Formatdouble

lan_egress_gbps?number

Formatdouble

ports?array<>

builtin_firewall?

Always-on built-in firewall baseline every gateway ships (drops unsolicited inbound — the intrinsic archetype-B firewall).

SUPERSEDED, and NO CLIENT READER (audited 2026-08-09). threats below carries the same numbers per class, and that is what the gateway console renders — the only GDScript reference to anything named builtin_firewall* is to the SIBLING bool builtin_firewall_enabled. This whole nested 7-field struct survives only because ~17 assertions in sim-render/tests/views/{threat_per_device,security_e2e}.rs read it; retiring it means porting those to the threats row for class == "protocol" first. Do not build new UI against it.

builtin_firewall_enabled?boolean

Whether the built-in firewall is switched ON. Player-toggleable from the gateway console (→ SetGatewayFirewall); off removes this gateway's Protocol baseline. Defaults true.

bgp_capable?boolean

Whether this gateway's SKU can run BGP (eBGP to the carrier + HA pairing). Entry/SOHO routers are single boxes — circuit redundancy only, no router HA. Gates the "form a redundant pair" affordance.

multi_az_capable?boolean

Whether the SKU can be a multi-AZ region border (implies bgp_capable).

bgp_advertising?boolean

Whether this gateway is CURRENTLY advertising the provider prefix — a live, bgp_capable, internet-facing edge. Two or more advertising edges = an HA border; a lone advertiser (or a non-BGP edge) is a border SPOF.

wan_policy?string

This router's WAN uplink policy across ITS circuits ("Failover" / "ActiveActive"). The console's WAN tab toggles it. Moved off the passive EDD 2026-07-22 — the router owns the routing decision.

security_addons?array<>

One row per available gateway security add-on (advanced firewall / basic IPS / basic scrub). enabled reflects whether THIS gateway has it fitted. The console renders a CheckButton per row with capex+monthly

the throttle warning, dispatching SetGatewayAddon.

addon_throttled?boolean

A gateway has NO deep-inspection engine. These three fields describe the gateway's FORWARDING ceiling being reduced by the security add-ons fitted to it, and nothing more. An add-on riding a router costs the router's ASIC headroom; that penalty is a throttle on forwarding, not an inspection throughput rating. Only a dedicated appliance has a real inspection plane (ApplianceView::inspection_*), and a gateway must never read as capable as one. Renamed 2026-07-25 from inspection_active / inspection_throttle / inspection_capacity_gbps, which mislabelled the throttle penalty as a DPI ceiling.

True when this gateway has a DPI add-on fitted (Σ deep-inspection inspection_capacity_gbps > 0), i.e. something on the router is actually costing it forwarding headroom.

NOT "some fitted add-on carries a gateway_throttle". The stateful firewall add-on carries one but does no per-packet DPI, so the engine charges it nothing; a firewall-only gateway reports false and keeps its full rated ceiling below.

addon_throttle?number

forwarding_ceiling_gbps / fabric_capacity_gbps — the fraction of rated fabric the effective ceiling leaves, for the console's "×0.80" hint. 1.0 when nothing is throttling. A PRESENTATION of the ceiling below, derived from it, so the two can never disagree; it is not an authored constant.

Formatfloat

forwarding_ceiling_gbps?number

The gateway's effective FORWARDING ceiling with its add-ons fitted — fabric_load_gbps is the load against it, and it IS the threshold fabric_saturated flips on.

Single source of truth: effective_forwarding_capacity_gbps(fabric_capacity, Engine::gateway_inspection_capacity_gbps(id), load), the same shared curve (and the same inputs) Engine::metrics_edge_traffic_pass saturates against in sim-engine/src/traffic/fabric.rs. Load-dependent by nature: DPI eats forwarding headroom as inspection engages, so this falls from full fabric toward the DPI ceiling as fabric_load_gbps rises.

Pre-v29 this was fabric_capacity_gbps × Π gateway_throttle, an unrelated authored multiplier that disagreed with the saturation verdict at every load. Never re-derive it renderer-side.

Named throttled_capacity_gbps until 2026-08-09. *_capacity_gbps is RESERVED for an integer nameplate rating (docs/SCHEMA.md § Naming conventions), and this is an explicitly load-dependent f64 — the one thing the suffix rule exists to keep apart. schema_naming_conventions.rs now fails the build if the old spelling comes back.

Formatdouble

monthly_opex_dollars?number

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

Formatdouble

inv_status?string

Lifecycle status — see HostView::inv_status. Four-corner parity with Host / Switch / PatchPanel; a gateway could not report a sell-queued state before this.

threats?array<>

Per-class threat rows for THIS gateway — one row per class reaching it, defended or not. Defended classes are the built-in L3/L4 firewall's (Protocol / Volumetric / Intrusion) plus any enabled add-on's (Intrusion via Basic IPS, Volumetric via Basic Scrub); undefended classes (L7 Application, or anything whose defence is switched off) still appear at mitigated: 0, capacity: 0 with defense_capable telling them apart. Same shape + shared ThreatMitigationView as ApplianceView::threats, so the gateway console renders the identical per-class Threats breakdown the appliance does. builtin_firewall above stays the legacy single-Protocol summary; the console uses this vec. Empty only when the gateway is off the internet path entirely.

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

Gateway

Parameters

Try the endpoint

Code example

Response example

Response body

On this page