Smart View Hierarchy APIs (1.0)

Download OpenAPI specification:Download

URL: https://docs.equinix.com/api-support.htm Terms of Service

Empower yourself with Smart View Hierarchy APIs. Use these APIs to obtain location and power hierarchy for invoking other APIs. Given an account number, IBX code, and an asset Id, returns the corresponding location and power hierarchy of related assets. Required query parameters to obtain a valid response from these endpoints are account number and IBX code.

Smart View Hierarchy APIs

APIs to get Location, Power Hierarchy

Fetch the Location Hierarchy

The location hierarchy endpoint returns the location hierarchy. This endpoint provides data for invoking other APIs such as Environmental APIs that require location hierarchy information.

query Parameters

accountNo required	string Customer Account Number
ibx	string IBX Code

header Parameters

Authorization required	string Specify the OAuth Bearer token with prefix 'Bearer '.
Authorization required	string Specify the Access token with prefix 'Bearer'.

Responses

Response Schema: application/json

Array

levelType	string Enum: "ibx" "zone" "cage" "cabinet" "sensor" levelType indicates which level in the location hierarchy does the node belong to.
levelValue	string ibx code, zone us id, cage us id, cabinet us id, sensor number for levelType ibx, zone, cage, cabinet, sensor resp.
label	string ibx code, zone unique space id, cage unique space id, cabinet unique space id, sensor number for levelType ibx, zone, cage, cabinet, sensor resp.
children	Array of objects (HierarchyNode)

Response samples

200
default

Content type

application/json

[{"levelType": "ibx",
"levelValue": "SV5",
"label": "SV5",
"children": [{"levelType": "ZONE",
"levelValue": "XY3:1:03:LocoArea:1",
"label": "XY3:1:03:LocoArea:1",
"children": [{"levelType": "CAGE",
"levelValue": "495",
"label": "XY3:03:021720",
"children": [{"levelType": "CABINET",
"levelValue": "105734",
"label": "XY3:03:021720:V0101:0199",
"children": [ ]
}
]
},
{"levelType": "CAGE",
"levelValue": "506",
"label": "XY3:03:020900",
"children": [{"levelType": "CABINET",
"levelValue": "13781",
"label": "XY3:03:020900:1010",
"children": [ ]
},
{"levelType": "CABINET",
"levelValue": "13782",
"label": "XY3:03:020900:1012",
"children": [ ]
}
]
}
]
},
{"levelType": "ZONE",
"levelValue": "XY3:1:03:Select Room:1",
"label": "XY3:1:03:Select Room:1",
"children": [{"levelType": "CAGE",
"levelValue": "61274",
"label": "XY3:03:FE21720",
"children": [{"levelType": "CABINET",
"levelValue": "105901",
"label": "XY3:03:FE21720:9999",
"children": [ ]
}
]
},
{"levelType": "CAGE",
"levelValue": "61275",
"label": "XY3:03:FE50010",
"children": [{"levelType": "CABINET",
"levelValue": "105958",
"label": "XY3:03:FE50010:9999",
"children": [ ]
},
{"levelType": "CABINET",
"levelValue": "139905",
"label": "XY3:03:FE50010:0000",
"children": [ ]
}
]
}
]
},
{"levelType": "ZONE",
"levelValue": "XY3:2:03:LocoArea:1",
"label": "XY3:2:03:LocoArea:1",
"children": [{"levelType": "CAGE",
"levelValue": "5902",
"label": "XY3:03:021200",
"children": [{"levelType": "CABINET",
"levelValue": "102563",
"label": "XY3:03:021200:0101",
"children": [ ]
},
{"levelType": "CABINET",
"levelValue": "102564",
"label": "XY3:03:021200:0102",
"children": [ ]
}
]
}
]
}
]
}
]

Fetch the Power Hierarchy

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