Environment v2 APIs

GET IBX sensors current readings

	GET /smartview/v2/environmental/ibxs/{ibx}/sensors/readings
Method	GET
URL or End Point	/smartview/v2/environmental/ibxs/{ibx}/sensors/readings
Headers	Authorization
Path Parameters	ibx
Query Parameters	type, zone, offset, limit
Body	Not applicable

This API returns current environmental (temperature and humidity) readings of BMS sensors installed within an IBX in a paginated way. These BMS sensors and their data points are part of the “Data Plus” solution. To obtain readings from these sensors, they first need to be enabled by Equinix for a user, based on the agreement.

The authorization token is the only header that is passed to this API and a response is received based on the values passed.

 

If you are unaware of how to obtain an authorization token, refer Requesting Access and Refresh tokens under Getting Access Token.

The following screenshots show a sample curl request to obtain the requested environmental data for an IBX and its respective JSON response containing the result.

curl -X
GET "https://api.equinix.com/smartview/v2/environmental/ibxs/DC2/sensors/readings"
-H "authorization: Bearer 000amyyznhgQvtMSVVe1PhNLjG4K"

The description of the path parameter is as follows:

Path Parameter Name	Mandatory	Type	Example Values	Description
ibx	Y	string	DC2	IBX where the sensor is located

The description of the query parameters is as follows:

Query Parameter Name	Mandatory	Type	Example Values	Description
type	N	string	DC2	IBX where the sensor is located
zone	N	string	HUMIDITY	Type of sensor data to display
offset	N	integer	0	Results offset you want to retrieve
limit	N	integer	20	Number of records to retrieve per request

{

    "data": [
    {
      "sensorId": "DC2.Environmental.Colo4-ZoneHumidity1",
      "zoneId": "DC2:1:06:ColoArea:1",
      "ibx": "DC2",
      "humidity": {
        "value": "33.3",
        "unit": "PERCENT"
      },
      "temperature": {
        "value": "33.3",
        "unit": "CELSIUS"
      }
    }
  ],
  "pagination": {
    "offset": 0,
    "limit": 0,
    "total": 0,
    "next": "string",
    "previous": "string"
  }

}

The description of the response payload is as follows:

Field Name	Type	Example Values	Description
data	object array	data[{...}]	List of data objects listing the sensor readings
data.sensorId	string	DC2.Environmental.Colo4-ZoneHumidity1	Sensor identifier
data.zoneId	string	DC2:1:06:ColoArea:1	Zone where the sensor is placed
data.ibx	string	DC2	IBX where the sensor is placed
data.humidity	object	humidity{...}	Single value with related unit in percentage
data.temperature	object	temperature{...}	Single value with related unit in Celsius degree
value	object	33.3	Specific value, to be read together with unit
unit	object	CELSIUS, PERCENT	Unit for value
pagination	object	pagination{...}	Represents pagination component of the paginated response
pagination.offset	integer	0	The number of elements to skip
pagination.limit	integer	0	Page size
pagination.total	integer	0	Total number of elements in the result set
pagination.next	string	string	Relative link to the next page - This can be empty if there is no next page available
pagination.previous	string	string	Relative link to the previous page - This can be empty if there is no previous page available

 

If you get “Access Denied” error, contact your local Equinix Service Desk for Equinix Smart View portal access.

GET single sensor current values

	GET /smartview/v2/environmental/ibxs/{ibx}/sensors/{sensorId}/readings
Method	GET
URL or End Point	/smartview/v2/environmental/ibxs/{ibx}/sensors/{sensorId}/readings
Headers	Authorization
Path Parameters	ibx, sensorId
Body	Not applicable

This API returns current environmental sensor readings such as temperature and humidity for a requested sensor ID in an IBX. The authorization token is the only header that is passed to this API and a response is received based on the values passed.

 

If you are unaware of how to obtain an authorization token, refer Requesting Access and Refresh tokens under Getting Access Token.

The following screenshots show a sample curl request to obtain the requested environmental data for a sensor in an IBX and its respective JSON response containing the result.

curl -X
GET "https://api.equinix.com/smartview/v2/environmental/ibxs/DC2/sensors/DC2.ZoneTemperature-10/readings"
-H "authorization: Bearer 000amyyznhgQvtMSVVe1PhNLjG4K"

The description of the path parameters is as follows:

Path Parameter Name	Mandatory	Description
ibx string	Y	IBX where the sensor is located Example: DC2
sensorId string	Y	Sensor identifier Example: DC2.ZoneTemperature-10

{

  "sensorId": "DC2.Environmental.Colo4-ZoneHumidity1",
  "zoneId": "DC2:1:06:ColoArea:1",
  "ibx": "DC2",
  "humidity": {
    "value": "33.3",
    "unit": "CELSIUS"
  },
  "temperature": {
    "value": "33.3",
    "unit": "CELSIUS"
  }

}

The description of the response payload is as follows:

Field Name	Description
sensorId string	Sensor identifier Example: DC2.Environmental.Colo4-ZoneHumidity1
zoneId string	Zone where the sensor is placed Example: DC2:1:06:ColoArea:1
ibx string	IBX where the sensor is placed Example: DC2
humidity object	Single value with related unit in percentage Example: humidity{...}
temperature object	Single value with related unit in Celsius degree Example: temperature{...}
value object	Specific value, to be read together with unit Example: 33.3
unit object	Unit for value Example: CELSIUS, PERCENT

 

If you get “Access Denied” error, contact your local Equinix Service Desk for Equinix Smart View portal access.