Skip to main content
API docs by Redocly

Smart View Environmental API (2.0)

Download OpenAPI specification:Download

URL: https://docs.equinix.com/api-support.htm Terms of Service

Empower yourself with Environmental APIs. The API makes it possible to fetch current environmental data including humidity and temperature for a single sensor (identified by IBX code and sensor ID) or for all the sensors within an IBX (identified by IBX code) in a paginated way. When fetching all sensor readings you can apply additional sort criteria.

Smart View Environmental

IBX sensors current readings

Returns current environmental (temperature and humidity) sensor readings for the given IBX code in a paginated way.

path Parameters
ibx
required
string
Example: CH2

IBX where the sensor is located.

query Parameters
type
string
Example: type=HUMIDITY

Type of sensor data to display, e.g. specifying 'HUMIDITY' means only sensor readings with HUMIDITY value will be included

zone
string
Example: zone=CH2:1:06:ColoArea:1

Zone name. Adding this parameter limits the query to sensors in the specified zone

offset
integer
Default: 0

Results offset you want to retrieve (0..N)

limit
integer
Default: 20

Number of records to retrieve per request.

header Parameters
Authorization
required
string

The OAuth Bearer token. Please add the prefix 'Bearer ' before the token.

Responses

Response Schema: application/json
required
Array of objects (Sensor_reading)

List of data objects

Array
sensorId
required
string

The sensor identifier.

zoneId
required
string

The zone where the sensor is placed.

ibx
required
string

The ibx identifier where the sensor is placed.

object (ValueWithUnit)

Single value with related unit (e.g. percentage for humidity or Celsius degree for temperature).

object (ValueWithUnit)

Single value with related unit (e.g. percentage for humidity or Celsius degree for temperature).

required
object (Pagination)

Represents pagination component of the paginated response

offset
required
integer <int64>

The number of elements to skip.

limit
required
integer <int64>

The page size.

total
required
integer <int64>

The total number of elements in the result set.

next
string

Represents a relative link to the next page. This can be empty if there is no next page available.

previous
string

Represents a relative link to the previous page. This can be empty if there is no previous page available.

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Single sensor current value(s)

Returns current environmental sensor readings such as temperature and humidity for the given sensor ID and IBX code.

path Parameters
ibx
required
string
Example: SV2

IBX where the sensor is located.

sensorId
required
string
Example: CH2.Environmental.MbusColo3Mod5.MOD35.C3TS03

Id of sensor to read.

header Parameters
Authorization
required
string

The OAuth Bearer token. Please add the prefix 'Bearer ' before the token.

Responses

Response Schema: application/json
sensorId
required
string

The sensor identifier.

zoneId
required
string

The zone where the sensor is placed.

ibx
required
string

The ibx identifier where the sensor is placed.

object (ValueWithUnit)

Single value with related unit (e.g. percentage for humidity or Celsius degree for temperature).

value
required
object

Specific value, to be read together with unit.

unit
required
object

Unit for value.

object (ValueWithUnit)

Single value with related unit (e.g. percentage for humidity or Celsius degree for temperature).

value
required
object

Specific value, to be read together with unit.

unit
required
object

Unit for value.

Response samples

Content type
application/json
{
  • "sensorId": "SV2.Environmental.Colo4-ZoneHumidity1",
  • "zoneId": "CH2:1:06:ColoArea:1",
  • "ibx": "SV2",
  • "humidity": {
    },
  • "temperature": {
    }
}