Skip to main content
Index

Power APIs

GET Power Data

GET /power/v1/current

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

 

The Get Power Current API, returns the power consumption info for all level values, given a customer account number, IBX and level type of ibx, cage, cabinet or circuit.

 

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 obtain designated ports and a JSON response containing details of port information. 

 

curl -X

GET "https://api.equinix.com/power/v1/current?accountNo=1&ibx=CH1&levelType=IBX&levelValue=CH1"

-H "accept: application/json"

-H "Authorization: Bearer PMQuChryibV7JFRfNuA3fLV8Hw1x"

 

The description of the query parameters is as follows:

 

Query Parameter Name

Mandatory

Type

Example

Applicable values

Description

accountNo

Y

string

1234

 

Customer account number.

ibx

Y

string

CH1  

Name of the IBX for which data is being requested.

levelType

Y

string

IBX

IBX, CAGE, CABINET, CIRCUIT

 Indicates which of the level types.

LevelValue

Y

string

CH1

 

Indicates the level value corresponding to the levelType - ibx code, cage unique space id, cabinet unique space id, serial number for levelType ibx, cage, cabinet, circuit respectively.

 

{
  "payLoad": {
    "ibx": "CH1",
    "accountNo": "1",
    "levelType": "IBX",
    "levelValue": "CH1",
    "isAlarm": null,
    "kva": 175.334,
    "amps": null,
    "soldKva": 1370.285,
    "cabinetRating": null,
    "contractualKva": 373.9,
    "percentageKva": 46.893,
    "comparisonData": {
      "datapoint": "percentageKva",
      "yesterday": -0.106,
      "lastweek": -0.034,
      "lastmonth": 2.379,
      "lastquarter": 2.964
    },
   "peakKvaLastSevenDays": 176.195,
    "peakKvaLastSevenDaysPercentage": 47.123,
    "peakKvaLastSevenDaysContractualKva": 373.899,
    "peakKvaLastSevenDaysTime": null,
    "soldAmps": null,
    "primaryKva": 111.586,
    "redundantKva": 63.747,
    "kw": "NA",
    "powerFactor": "NA",
    "readingTime": "1550379600000",
    "lastUpdatedTime": "1550379960000",
    "customerName": "EQUINIX"
  },
  "status": {
    "type": "INFO",
    "statuscode": "1000",
    "msg": "OK"
  }
}

 

The description of the response payload is as follows:

 

Field Name 

Type

Example

Description

 ibx

string

ABC

IBX code

accountNumber

string

ABC

Customer account number

levelType

string

ibx 

Enum:

Array [4]

Power hierarchy node levelType, linked to the power data.

levelValue

string

ABC

Power hierarchy node levelValue, linked to the power data

isAlarm

string

true

Boolean based on breaker tip alarm

kva

number

54.402

Power consumption in kva

amps

number

123

Instantaneous current amp reading on circuits

soldKva

number

598.349

Maximum amp draw, allowable on a circuit

cabinetRating

number

341.54

Maximum kVA draw allowed for the cabinet, when the levelType is cabinet. Null otherwise.

contractualKva

number

341.54

Maximum power draw contractually allowable in a private cage.

percentageKva

number

341.54

Calculated field kva divided by contractualKva

comparisonData

object

 

ComparisonData{...}

peakKvaLastSevenDays

number

55.296

 

peakKvaLastSevenDaysPercentage

number

55.296

 

peakKvaLastSevenDaysContractualKva

number

55.296

 

peakKvaLastSevenDaysTime

integer

55.296

 

soldAmps

integer

123

Circuit description when the levelType is circuit. Null otherwise.

primaryKva

number

28.31

Sum of instantaneous power draw reading on all the primary circuits within the levelType.

redundantKva

number

26.092

Sum of instantaneous power draw reading on all the redundant circuits within the levelType.

kw

string

NA

Measure of real power expressed in KiloWatt. Applicable for IBXs
that have capability of energy meter reading. The value will be “NA” for AMER and APAC regions

powerFactor

string

NA

Ratio between real power and apparent power in a circuit.(kW/kVA)|value will be “NA” for AMER and APAC regions

readingTime

string

1497410400000

Date-time when the latest value was read in (epoc - milliseconds).

lastUpdatedTime

string

1497410520000

Date-time when the latest value was updated (epoc - milliseconds).

customerName

string

ABC

 

 

If you get “Access Denied” error, contact your local Equinix Service Desk for Equinix IBX SmartView Portal access.

POST Power Data For a Given Level Type

POST /power/v1/current

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

 

Given a customer account number, IBX and level type of ibx, cage, cabinet or circuit, returns the power consumption info for all level values.

 

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 obtain power data for the account number 1 and a JSON response containing power data. 

 

curl -X 

POST "https://api.equinix.com/power/v1/current  

-H "content-type: application/json"
-H "authorization: Bearer R2KsiEM1ATlhBr8YdJqkHhbqZfdq"  
-d '{
     "accountNo": "1",
     "ibx": "CH1",
     "levelType": "IBX"
}'

 

The description of the request payload is as follows:

 

Body Parameter Name Mandatory Type Example 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, CAGE, CABINET, CIRCUIT Indicates which of the following level types.

 

{
    "payLoad": {
        "data": [
            {
                "ibx": "CH1",
                "accountNo": "1",
                "levelType": "IBX",
                "levelValue": "CH1",
                "isAlarm": null,
                "kva": 175.951,
                "amps": null,
                "soldKva": 1370.285,
                "cabinetRating": null,
                "contractualKva": 373.9,
                "percentageKva": 47.058,
                "comparisonData": {
                    "datapoint": "percentageKva",
                    "yesterday": 0.213,
                    "lastweek": 0.497,
                    "lastmonth": 2.751,
                    "lastquarter": 3.049
                },
                "peakKvaLastSevenDays": 176.195,
                "peakKvaLastSevenDaysPercentage": 47.123,
                "peakKvaLastSevenDaysContractualKva": 373.899,
                "peakKvaLastSevenDaysTime": null,
                "soldAmps": null,
                "primaryKva": 111.794,
                "redundantKva": 64.157,
                "kw": "NA",
                "powerFactor": "NA",
                "readingTime": "1550506500000",
                "lastUpdatedTime": "1550506860000",
                "customerName": "EQUINIX"
            }
        ]
    },
    "status": {
        "type": "INFO",
        "statuscode": "1000",
        "msg": "OK"
    }
}

 

The description of the response payload is as follows:

 

Field name Type Example Description
 ibx string AB1 IBX code
accountNo string 123 Customer account number
levelType string IBX Indicates the level type.
levelValue string AB1 Indicates the level value for the given level type.
isAlarm string true, false Boolean based on breaker trip alarm.
kva number 54.402 Power consumption in KVA
amps number 123 Instantaneous current amp reading on circuits.
soldKva number 598.349 Maximum amp draw, allowable on a circuit.
cabinetRating number 341.54

Maximum kVA draw allowed for the cabinet, when the level type is cabinet. Null otherwise.

contractualKva number 341.54 Maximum power draw contractually allowable in a power cage.
percentageKva number 341.54 Calculated field kVA divided by the contractual kVA.
comparisionData object   comparisonData{...}
peakKvaLastSevenDays number 55.296  
PeakKvaLastSevenDaysPercentage number 55.296  
PeakKvaLastSevenDaysContractualKva number 55.296  
PeakKvaLastSevenDaysTime number 55.296  
soldAmps number 123 Circuit description when the level type is circuit. Null otherwise.
primaryKva number 28.31 Sum of instantaneous power draw reading on all the primary circuits within the level type.
redundantKva number 26.092 Sum of instantaneous power draw reading on all the redundant circuits within the level type.
kw string NA Measure of real power expressed in KiloWatt. Applicable to IBXs that have the capability of energy meter reading. The value will be "NA" for AMER and APAC regions.
powerFactor string NA Ratio between the real power and apparent power in a circuit (KW/KVA). Value will be "NA" for AMER and APAC regions.
readingTime string 1497410400 Date-time when the latest value was read in (epoc - milliseconds).
lastUpdatedTime string 1497410400 Date-time when the latest value was updated in (epoc - milliseconds).
customerName string ABC Name of the customer.

 

If you get “Access Denied” error, contact your local Equinix Service Desk for Equinix IBX SmartView Portal access.