Equinix SmartView APIs | Equinix Product Documentation

SmartView Hierarchy APIs

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.

Operations

Retrieve the Location Hierarchy

Request

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

Security

BearerAuth

Query

accountNostringrequired

Customer Account Number

ibxstring

IBX Code

Payload

// No request payload

Responses

Location Hierarchy Details

Bodyapplication/json

Array [

levelTypestring

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

Enum:"ibx""zone""cage""cabinet""sensor"

Example:"ibx"

levelValuestring

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

Example:"SV5"

labelstring

ibx code, zone unique space id, cage unique space id, cabinet unique space id, sensor number for levelType ibx, zone, cage, cabinet, sensor resp.

Example:"SV5"

childrenArray of objects(HierarchyNode)

Example:null

]

Response

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