Skip to main content
Index

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 key, refer Requesting Access and Refresh tokens under Getting Started.

 

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 indication the level type for which to fetch the list for.
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 oC

Unit of measure for temperature values.

humidityUom string

%

Unit of measure for humifity values.

 

If you get “Access Denied” error, contact your local Equinix Service Desk for Equinix IBX SmartView 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. returns environment info ( temperature and humidity ) for input ibx, zone, cage, sensor

 

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

 

The following screenshots show a sample curl request to get assets details for the account number 1 and a JSON response containing 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 indication the level type for which to fetch the list for.

 

{
    "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 Total number of data values.
data array list   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 oC

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