Skip to main content
Index

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) sensor readings for an IBX in a paginated way. 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 to Requesting Access and Refresh tokens under the Getting Started section.

 

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 Description
ibx
string
Y IBX where the sensor is located
Example: DC2
 


The description of the query parameters is as follows:
 

Query Parameter Name Mandatory Description

type
string

N

IBX where the sensor is located
Example: DC2
 

zone
string
 

N

Type of sensor data to display
Example: "HUMIDITY" 

offset
integer
 

N

Results offset you want to retrieve
Example: 0

limit
integer
 

N

Number of records to retrieve per request
Example: 20

 

 

{

    "data": [
    {
      "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"
      }
    }
  ],
  "pagination": {
    "offset": 0,
    "limit": 0,
    "total": 0,
    "next": "string",
    "previous": "string"
  }

}

 

The description of the response payload is as follows:
 

Field Name Description
data
object array
List of data objects listing the sensor readings
Example: data[{...}]
data.sensorId
string

Sensor identifier
Example: DC2.Environmental.Colo4-ZoneHumidity1

data.zoneId
string
Zone where the sensor is placed
Example: DC2:1:06:ColoArea:1
data.ibx
string
IBX where the sensor is placed
Example: DC2
data.humidity
object
Single value with related unit in percentage
Example: humidity{...}
data.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
pagination
object
Represents pagination component of the paginated response
Example: pagination{...}
pagination.offset
integer
The number of elements to skip
Example: 0
pagination.limit
integer
Page size
Example: 0
pagination.total
integer
Total number of elements in the result set
Example: 0
pagination.next
string
Relative link to the next page - This can be empty if there is no next page available
Example: "string"
pagination.previous
string
Relative link to the previous page - This can be empty if there is no previous page available
Example: "string"

 

If you get “Access Denied” error, contact your local Equinix Service Desk for IBX SmartView 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 to Requesting Access and Refresh tokens under the Getting Started section.

 

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 IBX SmartView Portal access.