Uptime: Wiki | Subnet

Parameters

Path Parameters

id*integer

Entity id

Formatint64

Range0 <= value

Code example

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

Response example

{  "id": 0,  "l2vni": 0,  "vrf_id": 0,  "service": "string",  "member_count": 0,  "dedicated_host_ids": [    0  ],  "carrier_host_ids": [    0  ],  "routes_via": "string"}

An L2 broadcast domain (subnet) — the finer isolation grain BELOW the VRF: a VRF is the routed L3 boundary, a subnet is one L2 segment within it, keyed one-per-ServiceClass (so a tenant running VMs + Functions + K8s + a managed DB has four sibling subnets, each independently dedicatable). Small top-level list on WorldSnapshot (msgpack keyframe-only, exactly like segments / host_pools; subnets change rarely, so they never ride the per-tick capnp delta). Empty until the network-isolation model mints any subnet.

id*integer

Formatint32

Range0 <= value

l2vni*integer

L2 VXLAN Network Identifier for this subnet's broadcast domain (minted from a range disjoint from the VRF L3 VNIs).

Formatint32

Range0 <= value

vrf_id*integer

The VRF this subnet routes within. 0 is the Default shared VRF.

Formatint32

Range0 <= value

service*string

The resident service class this subnet carries — the isolation grain, as a ServiceClass tag ("vm"/"fn"/"obj"/"db"/"cdn"/"k8s"/"lb").

member_count?integer

Count of resident UNITS currently homed to this subnet — one per placed unit whose Engine::unit_subnet is this one, whatever its product.

Generic since 2026-08-10 (PROTOCOL 46). This mixed three grains before: one per VM allocation, one per database CUSTOMER and one per cluster CUSTOMER, so a 5-node cluster read 1, a database's copies were counted twice, and a Functions subnet read 0 while its containers ran in it.

Formatint32

Range0 <= value

dedicated_host_ids?array<>

Hosts physically dedicated to this subnet — those whose admit filter is exactly this subnet's (vrf, class) ({scope: L3vni(vrf), service: Service(class)}). Empty when the subnet is logical-only.

carrier_host_ids?array<>

Hosts physically CARRYING this subnet's members — the distinct host ids running the resident UNITS homed to this subnet, every product included (function containers were missing until 2026-08-10). The L2VNI (service-subnet) analog of NetworkSegmentView.carrier_host_ids (the VRF-grain equivalent); lets the netview overlay colour hosts by which L2VNI they carry, not just which VRF. Sorted ascending, deduped. Empty until members are homed.

routes_via?string

How this subnet's cross-subnet (east-west) traffic is ROUTED out of its L2VNI — the first-hop router serving its carrier hosts (Engine:: first_hop_router on the lowest-id carrier). One of:

"switch" — a distributed anycast L3 leaf routes it LOCALLY (resilient: survives an edge-gateway death);
"gateway" — CENTRALIZED at the edge gateway (a pure-L2 fabric hairpins cross-subnet traffic up to it, so a non-HA gateway is the SPOF for the tenant's tier-to-tier traffic);
"" — no live L3 router on the path (cross-subnet traffic is PARTITIONED), or a logical-only subnet with no carrier hosts yet. Lets the segments/isolation lens show a tenant WHERE their tiers route and flag the pure-L2 cross-subnet SPOF proactively, not just via the InterSubnetPartition incident once it breaks.

Subnet

Parameters

Try the endpoint

Code example

Response example

Response body

On this page