Environment v1 APIs

GET Environment For a Level

	GET /environment/v1/current
Method	GET
URL or End Point	/environment/v1/current
Headers	Authorization, Content-Type
Query Parameters	accountNo, ibx, levelType, levelValue
Body	Not applicable

Given an account number, IBX code, get current environment data for a single level value. returns environment info ( temperature and humidity ) for input IBX, zone, cage, sensor.

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 get assets details for the account number 1 and a JSON response containing the result.

curl -X 
GET  'https://api.equinix.com/environment/v1/current?accountNo=1&ibx=CH1&levelType=IBX&levelValue=CH1'
-H 'Authorization: Bearer vtIPc5PfMDw1mML4WzHEhb10e6V9'
-H 'Content-Type: application/json'

The description of the query parameters is as follows:

Query Parameter Name	Mandatory	Type	Example values	Applicable values	Description
accountNo	Y	string	1234		Customer account number
ibx	Y	string	AB2		Name of the IBX for which data is being requested.
levelType	Y	string	IBX	IBX, ZONE, CAGE, SENSOR	Enum value indicates the level type for which to fetch the list.
levelValue	Y	levelValue	AB2		Unique identifier for the type is ibxCode, zoneUsID, cageUsID, sensorid for levelType ibx, zone, cage, sensor respectively.

{
    "payLoad": {
        "ibx": "CH1",
        "accountNo": "1",
        "zone": "ALL",
        "cage": "ALL",
        "cabinet": "ALL",
        "sensor": "ALL",
        "temperature": "21.0",
        "humidity": "35.78",
        "timestamp": "1552275932446",
        "temperatureUom": "°C",
        "humidityUom": "%"
    },
    "status": {
        "type": "INFO",
        "statuscode": "1000",
        "msg": "OK"
    }
}

The description of the response payload is as follows:

Field name	Type	Example	Description
ibx	string	CH1	Name of the IBX.
accountNumber	number	1234	Customer account number.
zone	string	CH1:1:05:ColoArea:2	Zone unique space identifier.
cage	string	CH1:05:000550	Cage unique space identifier.
cabinet	string	CH1:05:000550:0105	Cabinet unique space identifier.
sensor	string	CH1.Colo.CH1_05_000550_0105	Sensor unique identifier.
temperature	string	20.0	Current temperature.
humidity	string	60.0	Current humidity.
timestamp	string	1506665106579	Epoch timestamp when the current reading was read.
temperatureUom	string	°C	Unit of measure for temperature values.
humidityUom	string	%	Unit of measure for humidity values.

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

GET Environment For a Level Type

	GET /environment/v1/listCurrent
Method	GET
URL or End Point	/environment/v1/listCurrent
Headers	Authorization, Content-Type
Query Parameters	accountNo, ibx, levelType
Body	Not applicable

Given an account number, IBX code, get current environment data for all level values for a level type and returns environment info ( temperature and humidity ) for input ibx, zone, cage, sensor.

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 get assets details for account number 1 and a JSON response containing the result.

curl -X 
GET  'https://api.equinix.com/environment/v1/listCurrent?accountNo=1&ibx=CH1&levelType=IBX'
-H 'Authorization: Bearer vtIPc5PfMDw1mML4WzHEhb10e6V9'
-H 'Content-Type: application/json'

The description of the query parameters is as follows:

Query Parameter Name	Mandatory	Type	Example values	Applicable values	Description
accountNo	Y	string	1234		Customer account number
ibx	Y	string	AB2		Name of the IBX for which data is being requested.
levelType	Y	string	IBX	IBX, ZONE, CAGE, SENSOR	Enum value indicates the level type for which to fetch the list.

{
    "payLoad": {
        "totalCount": 2,
        "data": [
            {
                "ibx": "CH1",
                "accountNo": "1",
                "zone": "CH1:1:05:ColoArea:2",
                "cage": "ALL",
                "cabinet": "ALL",
                "sensor": "ALL",
                "temperature": "21.1",
                "humidity": "35.50",
                "timestamp": "1552277740599",
                "temperatureUom": "°C",
                "humidityUom": "%"
            },
            {
                "ibx": "CH1",
                "accountNo": "1",
                "zone": "CH1:1:05:ColoArea:3",
                "cage": "ALL",
                "cabinet": "ALL",
                "sensor": "ALL",
                "temperature": "20.7",
                "humidity": "28.80",
                "timestamp": "1552277787927",
                "temperatureUom": "°C",
                "humidityUom": "%"
            }
        ]
    },
    "status": {
        "type": "INFO",
        "statuscode": "1000",
        "msg": "OK"
    }
}

The description of the response payload is as follows:

Field name	Type	Example	Description
totalCount	integer	2	The total number of data values.
data	array list		The array of all level values.
ibx	string	CH1	Name of the IBX.
accountNumber	number	1234	Customer account number.
zone	string	CH1:1:05:ColoArea:2	Zone unique space identifier.
cage	string	CH1:05:000550	Cage unique space identifier.
cabinet	string	CH1:05:000550:0105	Cabinet unique space identifier.
sensor	string	CH1.Colo.CH1_05_000550_0105	Sensor unique identifier.
temperature	string	20.0	Current temperature.
humidity	string	60.0	Current humidity.
timestamp	string	1506665106579	Epoch timestamp when the current reading was read.
temperatureUom	string	°C	Unit of measure for temperature values.
humidityUom	string	%	Unit of measure for humidity values.

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

	GET /environment/v1/trending
Method	GET
URL or End Point	/environment/v1/trending
Headers	Authorization, Content-Type
Query Parameters	accountNo, ibx, levelType
Body	Not applicable

Given an account number, IBX code, get current environment trending data for a given level value.

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 get assets details for the account number 1 and a JSON response containing the result.

curl -X 
GET  'https://api.equinix.com/environment/v1/trending?accountNo=1&ibx=CH1&levelType=IBX&levelValue=CH1&dataPoint=humidity&fromDate=1460429200000&toDate=1460908800000&interval=1d'
 -H 'Authorization: Bearer vtIPc5PfMDw1mML4WzHEhb10e6V9'
 -H 'Content-Type: application/json'

The description of the query parameters is as follows:

Query Parameter Name	Mandatory	Type	Example values	Applicable values	Description
accountNo	Y	string	1234		Customer account number
ibx	Y	string	AB2		Name of the IBX for which data is being requested.
levelType	Y	string	IBX	IBX, ZONE, CAGE, SENSOR	Enum value indicates the level type for which to fetch the list.
levelValue	Y	string	AB2		Level Value is ibxCode, zone, cage, sensorid for levelType ibx, zone, cage, sensor respectively.
dataPoint	Y	string	humidity	temperature, humidity	Specifies the desired data point.
fromDate	Y	long	1460429200000
toDate	Y	long	1460908800000
interval	Y	string	1d	reading, 1h, 1d	Specifies the interval at which the data is collected.

{
    "payLoad": {
        "accountNo": "323253",
        "ibx": "WA1",
        "interval": "1d",
        "uom": "%",
        "dataPoint": "humidity",
        "series": [
            {
                "datetime": "1697217492000",
                "value": "47.53",
                "modifiers": [
                    "recorded"
                ]
            },
            {
                "datetime": "1697217535000",
                "value": "48.72",
                "modifiers": [
                    "cov"
                ]
            },
            {
                "datetime": "1697217644000",
                "value": "49.70",
                "modifiers": [
                    "cov"
                ]
            }
        ]
    }
}

The description of the response payload is as follows:

Field name	Type	Example	Applicable values	Description
payLoad	object			Environment trending information dataset.
accountNo	integer	1234		Customer account number.
ibx	string	CH1		IBX data center identifier.
interval	string	1d		Data recording time interval.
uom	string	%		Unit of measure.
dataPoint	string	humidity		Environmental data type.
series	array of objects			Readings taken from the selected data point.
datetime	string	1697217492000		Data point reading timestamp (an epoch date).
value	string	60.0		Data point measured value.
modifiers	Array of strings	recorded	cov, recorded	Key modifiers: Recorded modifier - specifies the value collected or stamped at the specified trend interval. The COV (Change of Value) modifier - indicates the change of value recorded within the trend interval. Example: Previous Timestamp (TS1): 1697217492000 Current Timestamp (TS2): 1697217535000 Previous Recorded Value: 47.53 Current Recorded Value: 48.72 COV (Change of Value): +1.19 (Increase from 47.53 at TS1 to 48.72 at TS2)

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

GET Environment For a Level​

GET Environment For a Level Type​

GET Environment Trending Data​

GET Environment For a Level

GET Environment For a Level Type

GET Environment Trending Data