Skip to main content

Effective 10 September 2024, API Documentation can be found on our Equinix Product Documentation site.
The content on this page will not be updated after 1 Oct 2024 and will be inaccessible after 31st Dec 2024.


API Reference

NameSummary
Hierarchy
Get Location HierarchyRetrieve the corresponding location hierarchy of related assets in Equinix Smart View.
Get Power HierarchyCollect the corresponding power hierarchy of related assets in Equinix Smart View.
Assets
Get Asset ListObtain a list of assets in an asset category of an IBX for an account.
Get Asset DetailsProcure the asset details and list of tag points in an asset category with an asset ID for an IBX of an account.
Get  Affected Locations for an AssetFetch the corresponding location hierarchy of related assets for an asset ID in an IBX of an account.
Get Asset SearchAcquire all search results matching the search string query of a given asset ID.
Get Asset Tag PointRetrieve the latest value of an asset tag point for an IBX of an account.
Get Asset Tag Point TrendingGain the corresponding trending information of an asset tag point in an IBX of an account.
Post Asset DetailsReturns the asset details and list of tag points for an asset in a category of an IBX in an account with a given asset ID.
Post Asset Tag PointsReturns the latest value of an asset tag point for an IBX of an account.
Alarm 
Get Active AlarmsObtain all active alarms and returns a list with a count specifying the number of alarms for an account.
Power
Get Power DataFetch the current power consumption information for all level values in an IBX of an account.
Get Trending Power DataCollect the trending power consumption data for an an asset.
Post Power DataReturns the power consumption data for all levels in an IBX of an account.
Environmental (V1)
Get Environmental Data for a LevelAcquire current environmental data for a single level value in an IBX of an account.
Get Environmental Data for a Level TypeObtain a list of current environmental data for all level types in an IBX of an account.
Get Environmental Trending DataGain current environmental trending data for a single level in an IBX of an account.
Environmental (V2)
Get IBX Sensors Current Readings {ibx}Procure current readings of all environmental sensors in an IBX.
Get Single Sensor Current Values {ibx} {sensorId}Fetch the current environmental readings for a requested sensor ID in an IBX.
Subscription (V1)
Get SubscriptionsView the near real-time stream subscription details of subscriptions for an organization.
Get Subscription by Id {subscriptionId}See the near real-time stream subscription details of a specific subscription for an organization.
Update SubscriptionsUpdate the near real-time feed of an existing subscription to add or remove events.
Delete SubscriptionsClose and delete the near real-time stream of a subscription.
Subscription (V2)
Post SubscriptionsDefine and create new streaming subscriptions for an organization.
Get SubscriptionsCollect the details of all streaming subscriptions for an organization.
Get Subscriptions by IDRetrieve the details of a specific streaming subscription for an organization.
Update SubscriptionsModify and update an existing streaming subscription for an organization.
Delete SubscriptionsDelete and remove an existing streaming subscription for an organization.
Subscription Data
Get Subscription DataRetrieve API Plus streaming subscription messages.
System Alerts
Retrieve System AlertsRetrieve system alerts that match provided search criteria.