Equinix SmartView APIs | Equinix Product Documentation

Retrieve the Power Hierarchy

This endpoint returns the power hierarchy and provides data for invoking other APIs such as Power APIs that require power hierarchy information.

Security

BearerAuth

accountNostringrequired

Customer Account Number

ibxstring

IBX Code

Payload

// No request payload

Power Hierarchy Details

Bodyapplication/json

Array [

levelTypestring

levelType indicates which level in the power hierarchy does the node belong to.

Enum:"ibx""cage""cabinet""circuit"

Example:"ibx"

levelValuestring

ibx code, cage us id, cabinet us id, circuit number for levelType ibx, cage, cabinet, circuit resp.

Example:"XY1"

labelstring

ibx code, cage unique space id, cabinet unique space id, circuit label for levelType ibx, cage, cabinet, circuit resp.

Example:"XY1"

childrenArray of objects(PowerHierarchyNode)

ibx, cage, cabinet nodes can have cage, cabinet and circuit, circuit nodes as children respectively.

Example:null

]

Response

[
  {
    "levelType": "ibx",
    "levelValue": "XY1",
    "label": "XY1",
    "children": null
  }
]