- How to Guide
- API Reference
What is Equinix IBX SmartView?
Equinix IBX SmartView is a Data Center Infrastructure Monitoring (DCIM) solution. It allows customers to have real-time access to environmental and operating information relevant to the IBX footprint as if those cages were all in-house. It provides the ability to get information for the Environmental, Mechanical, Electrical assets and Power draw. For more information, see Equinix Product Documentation.
The picture below provides a high-level overview of IBX SmartView.
IBX SmartView High-Level Overview
Equinix IBX SmartView is offered to customers via web applications and via REST and Near real-time APIs. IBX SmartView API architecture is powered by the DCIM platform. For information on what's new and what's changed, see Equinix Product Release Readiness.
Our SAAS application provides unmatched visibility into core infrastructure at the local zone, cage and cabinet-levels. It provides data that is relevant to customers, presented the same way for all IBX SmartView IBXs globally. It also offers you actionable insights that allow you to react to important events and proactively plan via configurable reports & alerts.
IBX SmartView APIs
Through a comprehensive set of REST Application Programming Interfaces (APIs) and supportive Near real-time APIs for partners as an extension of IBX SmartView, customers have greater flexibility to utilize data through near real-time and pragmatic REST APIs. They can also use IBX SmartView APIs to integrate core IBX SmartView data (environmental, power draw, mechanical and electrical) into third-party monitoring systems.
What are Equinix IBX SmartView APIs?
IBX SmartView APIs allow customers to build real-time dashboards and integrate real-time feeds with their automation systems. These APIs are classified into two categories:
- Near real-time APIs
- RESTful APIs
Near real-time APIs provide real-time, actionable information for both API and IBX SmartView users. APIs are defined in the form of events and objects. API developers can integrate APIs into their existing applications via secure subscription channels that integrate with multiple clouds. Integrating with near real-time events allows customers to respond to critical updates related to their core infrastructure in near real-time.
REST APIs are ideal for developers looking to build applications that leverage IBX SmartView data. Customers who use REST APIs can seamlessly integrate the data into third-party applications. The APIs allow developers to retrieve data for core infrastructure components such as power draw, environmental and infrastructure assets, as well as, alarms, alerts, and notifications.
Both REST as well as Near real-time APIs allow developers to interact with Equinix IBX SmartView programmatically to monitor their data center infrastructure. (Refer to the API reference section or Catalog for more details.) The diagram below presents an overview of the API architecture.
IBX SmartView Rest APIs
The REST APIs provide customers the ability to fetch information about their assets from every IBX location. There are APIs for all the different asset classifications, alerts, and power.
- Hierarchy API - Provides access to all IBX infrastructure asset details directly supporting a customer's cage, cabinet, or power circuit. Given an IBX, it allows retrieval of the cage, cabinet or circuit information which are deployed at the location.
- Assets API - Provides visibility into the core mechanical or electrical assets and their operating status, for each customer's IBX footprint. Given an IBX, it allows retrieval of all information about the Equinix assets that are serving the colocation footprint at the location.
- Power API - Provides the power usage data for all cabinets and circuits. Given an IBX, it allows retrieval of all information about the power assets at the location.
- Environmental API - Provides access to the environmental and operating information as if those cages were managed in-house. Given an IBX, it allows retrieval of all information about the environmental assets at the location.
- Alarm API - Provides the ability to get all the alarms that have triggered at the various IBX locations.
- Alert API - Provides the ability to get all the configured push notification alerts. Configurable alerts ensure customers are notified when important events occur.
The REST APIs are useful for getting assets' metadata for Equinix assets powering the infrastructure for a given customer. They also provide the ability to get the historical data collected from these assets over a period of time.
IBX SmartView Near Real-Time APIs
The Near-Real-Time streaming APIs are shown on the right-hand side of the diagram depicting IBX SmartView API-Architecture. These allow for streaming the data to an asynchronous channel. This data is collected from various IBX locations. The data that is collected from the different IBX locations is streamed in near real-time to the subscriber. Data streaming is currently available on Google pub-sub, Amazon Web Services SNS and Microsoft Azure Service Bus channels via subscription.
Streaming data can also be retrieved in a machine native protocol such as SNMP and OPC, via a private async channel. This allows customers to integrate the data streams with their existing on-premise applications. Please reach out to email@example.com for more details.
- Subscription API - APIs for creating and managing near real-time feed subscriptions.
- Tagpoint updated event - An asset tagpoint value was updated/received.
- Power updated event - A power usage value was updated/received.
- Environment updated event - An environment value for temperature or humidity was updated/received.
- Streaming API subscription for environmental sensors - Temperature and humidity events for environmental sensors were received.
- Alarm updated event - An alarm was updated/received.
- Alert updated event - An alert was updated/received.
- Heartbeat notifications for all alerts - Weekly events to view details of heartbeat notifications on all alerts subscribed to were received.
The developer portal is a platform for accessing the customer-facing APIs across all Equinix product lines. It allows developers to test drive their APIs using the playground features. It is intuitive and easy to use, allowing developers to explore and dive deep into the individual APIs. It provides a preview of any upcoming APIs as well.
How Equinix IBX SmartView APIs work?
When a client is on-boarded, they are provided with user credentials.
The client must use these credentials to connect to the Equinix Developer Portal to generate a Consumer key and Consumer secret.
The Consumer key and Consumer secret are essential for obtaining access and refresh tokens to authenticate API calls as described in the subsequent section.
The Time To Live (TTL) for access tokens is 3,599 seconds and that for refresh tokens is 5,182,560 seconds.
Refer to Generating Client ID and Client Secret key under Getting Started for instructions on how to generate Consumer key and Consumer secret.
Step 1 - Request access and refresh token information by calling the Equinix OAuth API (/oauth2/v1/token) with the Consumer key, Consumer secret, and user credentials.
Refer to Requesting Access and Refresh tokens under Getting Started for instructions on how to obtain an Authorization Token.
Step 2 - The API gateway makes an OAuth2 call to the identity provider using the submitted credentials.
Step 3 - The identity provider returns an OAuth2Access token to the API gateway.
Step 4 - The API gateway sends back the authorization token details to the client.
REST APIs consumption flow
Step 5 - The client submits an API request with the obtained authorization token and respective API request payload.
Refer to the How-to Guide section for instructions on how to call Equinix IBX SmartView APIs to establish connections.
Step 6 - API gateway validates the request and calls the relevant API.
Step 7 - The response is received by the API gateway.
Step 8 - The response is sent back to the client.
Step 9 - The client accepts the connection and processes the IBX SmartView API response.
Near Real-Time APIs consumption flow
Step 10 - Repeat steps 1 - 9 above to subscribe to a near real-time feed.
Step 11 - Create a client to consume the near real-time feed.