Skip to main content
GET
Get topology group graph

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

facet
enum<string>
required

Topology facet whose slice to return.

  • networking - networking
  • power - power
Available options:
networking,
power
site_id
string<uuid>
required

Site whose topology slice to return.

Response

OpenAPI shape of one topology graph node.

Schema only: the response is assembled and rendered as pydantic (topology_graph.TopologyGraphNode), and this exists so the spec publishes a named component whose non-recursive fields stay generated from one declaration.

id
string<uuid>
required
read-only
label
string
required
read-only
Pattern: ^[-a-zA-Z0-9_]+$
type
enum<string>
required
  • root - root
  • super-spine - super-spine groups multiple spines together
  • spine - spine groups multiple pods together
  • pod - pod groups either multiple devices or multiple nvlink-domains together
  • nvlink-domain - nvlink-domain groups multiple devices together (min: 1)
  • unknown - unknown
Available options:
root,
super-spine,
spine,
pod,
nvlink-domain,
unknown
device_ids
string<uuid>[]
required
read-only
children
array
required
read-only