Uptime: Wiki

Parameters

Path Parameters

id*integer

Entity id

Formatint64

Range0 <= value

Code example

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

Response example

{  "from_host": 0,  "to_switch": 0,  "kind": "string",  "dac_class": "string",  "color": "string",  "duplex": true,  "qsfp_end": 0,  "length_m": 0,  "id": 0,  "a": null,  "b": null,  "lag_id": 0,  "routed": true,  "mode_pinned": true,  "breakout_id": 0,  "routed_via": [    0  ],  "path": [    {      "Port": 0    }  ],  "route_slots": [    0  ],  "routed_points": [    [      0.1    ]  ],  "is_draped": true,  "is_failed": true,  "routing_side_a": "string",  "routing_side_b": "string",  "dangling_end": "string"}

Response body

200The entity

application/json

from_host*integer

Legacy host↔switch fields. Populated for host-link cables for back-compat with the pre-Phase-B renderer. New cable types (switch↔edd, future player-laid) leave these as 0.

Formatint32

Range0 <= value

to_switch*integer

Formatint32

Range0 <= value

kind*string

dac_class?string

Twinax class ("Passive" / "Active"). Only meaningful for DAC kinds; surfaced so resuming a dangling active-DAC cable client-side sees the right 15m reach (instead of the 3m passive baseline).

color?string

Player-chosen jacket colour id ("Orange" / "Blue" / …). Always a concrete colour — the projection resolves the cable's stored choice or its family default — so the renderer paints off it directly (Tokens.cable_color_for_choice). Empty only on legacy wire frames.

duplex?boolean

True for LC-duplex fibre patch cords (TX/RX strand pair). The renderer draws two parallel strands; everything else is one tube. Read directly off the cable view — no catalog/timing dependency.

Meaning CHANGED in PROTOCOL 48 (UG-207). This is now purely CableKind::is_duplex(), the property of the cable itself. It used to be additionally forced false whenever EITHER end sat in a QSFP cage, which made an SFP-to-QSFP fibre run render single-tube at BOTH ends — including the SFP end, which genuinely has two LC ferrules. Cage geometry now travels in [Self::qsfp_end] instead.

qsfp_end?integer

Which END sits in a QSFP (multi-lane) cage: 0 neither, 1 = a, 2 = b, 3 = both. A QSFP cage presents one qsfp_module.glb connector with a single boot, so the duplex strand pair converges there — the same 2-into-1 the renderer already does at a fibre patch panel. 3 means converge at both ends, i.e. render as one tube, which is correct for an MPO trunk between two QSFP cages.

Zero is "neither" deliberately: CableView derives [Default] and the field is #[serde(default)], so a legacy frame and a default-constructed view both land on the value that reproduces pre-48 rendering. A -1 sentinel would have defaulted to 0 and silently claimed end "a".

Added in PROTOCOL 48 (UG-207).

Formatint32

Range0 <= value

length_m*integer

Formatint32

Range0 <= value

id?|

Generalized endpoint metadata (Phase B+). Populated for all cables going forward, including host-links. Renderers should prefer reading a / b over the legacy from_host / to_switch fields.

Formatint32

Range0 <= value

a?null|||||||

b?null|||||||

lag_id?|

LAG (link aggregation) membership. Cables sharing this id form a bonded link. None = standalone cable.

Formatint32

Range0 <= value

routed?boolean

true when this inter-switch link runs L3/Routed (ECMP) vs L2/ Bridged (STP). Authoritative owner is Cable.link_mode. Lets the switch console show + toggle each link's forwarding mode.

mode_pinned?boolean

true when the player pinned this link's mode in the console (so it's not auto-managed). false = Auto. With routed this gives the console the tri-state Auto / L2 / L3.

breakout_id?|

Breakout membership. Legs sharing this id fan out from one QSFP trunk port — the renderer draws a single trunk run that splits to each leg's far port. None = ordinary point-to-point cable. (Tiny Option<u32> mirror of lag_id; delta/capnp treat it like any other scalar — no per-tick allocation.)

Formatint32

Range0 <= value

routed_via?array<>

Tray segments / hooks / risers this cable runs through, in order from a to b. Empty = draped (no managed path).

path?array<|||||>

Full ordered anchor sequence the cable runs through, port A → port B — sim_core::cable::RouteAnchor, THE one anchor vocabulary (client-send, engine-store, engine-emit; see the 2026-07-27 RouteAnchor/WaypointView unification). First and last anchor are always Port. Middle anchors describe in-rack management (Strip), rack-edge transitions (Edge), side-panel rail holes (RailHole), and inter-rack runs (Tray). This is already the FULL resolved route — the engine expands strip runs into their marker/channel sequence (expand_strip_chains_rack) before emitting, so the renderer only ever draws between consecutive anchors, never re-derives which ones to visit. When this is shorter than 3 entries (just the two endpoint ports), the renderer treats the cable as freely draped — same as the legacy routed_via.is_empty() case.

route_slots?array<>

Per-segment bundle slot — same length as routed_via. Each entry is this cable's slot index (0-based) inside the corresponding tray segment, computed deterministically by sorting cable ids that share the segment. Renderer combines slot + tray cross-section + layout pattern into a lateral offset so cables don't visually overlap.

routed_points?array<array<>>

Raw world-space waypoints (from RouteAnchor::Point) — scene authored tray runs the cable threads through. Spliced into path as RouteAnchor::Point.

is_draped?boolean

True iff routed_via is empty — convenience for renderers that want to draw draped cables differently without inspecting the list.

is_failed?boolean

True iff this cable is currently in a transient failed state (Cable::is_failed(now) — gates traffic engine-side). Renderer colours failed cables red.

routing_side_a?string

Player-chosen cable management path for each end — "LeftMgr" / "RightMgr" / "VertRiser" / "RackTop" per cable::RoutingSide. Each end of the cable runs through its own rack's manager strip, so the two can differ. Defaults to "RightMgr".

routing_side_b?string

dangling_end?|

Some("Source") or Some("Target") when one end of this cable has been yanked out of its terminating port. The cable stays in the world; the renderer paints the loose tip.

Cable

Parameters

Try the endpoint

Code example

Response example

Response body

On this page