Skip to main content
Index

Subscriptions v1 APIs

GET Subscriptions

GET /feedsubscription/v1/subscribe

 Method  GET
 URL or End Point  /feedsubscription/v1/subscribe
 Headers  Authorization, Content-Type
 Query Parameters  Not applicable
 Body  Not applicable

 

This endpoint allows users to view the near real-time stream subscription details for subscriptions tied to an organization.

 

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 the subscriptions details for an organization and a JSON response containing the result. 

 

curl -X 

GET "https://api.equinix.com/feedsubscription/v1/subscribe"     

-H "content-type: application/json"                                                                            
-H "authorization: Bearer asxQMSbBwcNzI2fCCNwSwTh3phV2" 

 

{
  "alarm": [
    {
      "accountNo": "135888",
      "assetClassification": [
        "ELECTRICAL"
      ],
      "conditionName": [
        "ALARM"
      ],
      "ibx": "DE1"
    }
  ],
  "alert": [
    {
      "accountNo": "135888",
      "ibx": "DE1"
    }
  ],
  "asset": [
    {
      "accountNo": "135888",
      "ibx": "DE1"
    }
  ],
  "config": {
    "method": "PULL",
    "provider": "GOOGLE",
    "subscription": "string"
  },
  "environment": [
    {
      "accountNo": "135888",
      "granularity": [
        "IBX"
      ],
      "ibx": "DE1"
    }
  ],
  "power": [
    {
      "accountNo": "135888",
      "ibx": "DE1"
    }
  ],
  "status": "OK",
  "subscriptionId": "606349eca6171829c70d8777"
}

 

The description of the response payload is as follows:

 

Field name Type Example Description
power array power[...] Power event subscription details
accountNo string 135888 Customer account number
assetClassification array ["ELECTRICAL", "ENVIRONMENTAL", "MECHANICAL"] Classification of assets
conditionName array ["ALARM", "HIGH", "HIGH_HIGH", "LOW", "LOW_LOW", "WARNING"] Alarm condition of the asset
ibx string DE1 IBX code
asset array asset[...] Asset subscription request
alarm array alarm[...] Alarm event subscription details
alert array alert[...] Alert event subscription details
environment array environment[...] Environment event subscription details
granularity array ["IBX", "ZONE", "CAGE"] Granularity level at which data is to be streamed, if specified
subscriptionId string 606349eca6171829c70d8777 Unique identifier for the subscription
config object config{...}

Configuration to specify near real-time stream consumption parameters

provider string GOOGLE

Provider for the subscription

method string PULL

Subscription method

subscription string   Subscription URL used for pull subscriptions based on provider
status string OK, PARTIAL_SUCCESS, ERROR Response status

 

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

GET Subscriptions By Id

GET /feedsubscription/v1/subscribe/{subscriptionId}

 Method  GET
 URL or End Point  /feedsubscription/v1/subscribe/{subscriptionId}
 Headers  Authorization, Content-Type
 Query Parameters  Not applicable
 Path Parameters  subscriptionId
 Body  Not applicable

 

 

This endpoint allows users to view the near real-time stream subscription details of a specific subscription for an organization.

 

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 the details of an existing subscription for an organization and a JSON response containing the result. 

 

curl -X 

GET "https://api.equinix.com/feedsubscription/v1/subscribe/606349eca6171829c70d8777"     

-H "content-type: application/json"                                                                            
-H "authorization: Bearer asxQMSbBwcNzI2fCCNwSwTh3phV2" 

 

{
  "alarm": [
    {
      "accountNo": "135888",
      "assetClassification": [
        "ELECTRICAL"
      ],
      "conditionName": [
        "ALARM"
      ],
      "ibx": "DE1"
    }
  ],
  "alert": [
    {
      "accountNo": "135888",
      "ibx": "DE1"
    }
  ],
  "asset": [
    {
      "accountNo": "135888",
      "ibx": "DE1"
    }
  ],
  "config": {
    "method": "PULL",
    "provider": "GOOGLE",
    "subscription": "string"
  },
  "environment": [
    {
      "accountNo": "135888",
      "granularity": [
        "IBX"
      ],
      "ibx": "DE1"
    }
  ],
  "power": [
    {
      "accountNo": "135888",
      "ibx": "DE1"
    }
  ],
  "status": "OK",
  "subscriptionId": "606349eca6171829c70d8777"
}

 

The description of the response payload is as follows:

 

Field name Type Example Description
power array power[...] Power event subscription details
accountNo string 135888 Customer account number
assetClassification array ["ELECTRICAL", "ENVIRONMENTAL", "MECHANICAL"] Classification of assets
conditionName array ["ALARM", "HIGH", "HIGH_HIGH", "LOW", "LOW_LOW", "WARNING"] Alarm condition of the asset
ibx string DE1 IBX code
asset array asset[...] Asset subscription request
alarm array alarm[...] Alarm event subscription details
alert array alert[...] Alert event subscription details
environment array environment[...] Environment event subscription details
granularity array ["IBX", "ZONE", "CAGE"] Granularity level at which data is to be streamed, if specified
subscriptionId string 606349eca6171829c70d8777 Unique identifier for the subscription
config object config{...}

Configuration to specify near real-time stream consumption parameters

provider string GOOGLE

Provider for the subscription

method string PULL

Subscription method

subscription string   Subscription URL used for pull subscriptions based on provider
status string OK, PARTIAL_SUCCESS, ERROR Response status

 

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

PUT Subscriptions

PUT /feedsubscription/v1/subscribe/{subscriptionId}

 Method  PUT
 URL or End Point  /feedsubscription/v1/subscribe/{subscriptionId}
 Headers  Authorization, Content-Type
 Query Parameters  Not applicable
 Path Parameters  subscriptionId
 Body  Not applicable

 

This endpoint allows users to update the near real-time feed of an existing subscription to add or remove events.

 

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 update an existing subscription for the user and a JSON response containing the result. 

 

curl -X 

PUT https://api.equinix.com/feedsubscription/v1/subscribe/606349eca6171829c70d8777 

-H 'content-type: application/json' 

-H 'authorization: Bearer ea28LIRkdIEjIDpIHo9B40seYIWs' 
-d '{
  "alarm": [
    {
      "accountNo": "135888",
      "assetClassification": [
        "ELECTRICAL"
      ],
      "conditionName": [
        "ALARM"
      ],
      "ibx": "DE1"
    }
  ],
  "alert": [
    {
      "accountNo": "135888",
      "ibx": "DE1"
    }
  ],
  "asset": [
    {
      "accountNo": "135888",
      "ibx": "DE1"
    }
  ],
  "config": {
    "method": "PULL",
    "provider": "GOOGLE",
    "subscription": "string"
  },
  "environment": [
    {
      "accountNo": "135888",
      "granularity": [
        "IBX"
      ],
      "ibx": "DE1"
    }
  ],
  "power": [
    {
      "accountNo": "135888",
      "ibx": "DE1"
    }
  ]
}'         

 

The description of the request payload is as follows:

 

Body parameter name Mandatory Type Example Description
power N array power[...] Power subscription request
accountNo Y string 135888 Customer account number
assetClassification N array ["ELECTRICAL", "ENVIRONMENTAL", "MECHANICAL"] Classification of assets
conditionName N array ["ALARM", "HIGH", "HIGH_HIGH", "LOW", "LOW_LOW", "WARNING"] Alarm condition of the asset
ibx Y string DE1 IBX code
asset N array asset[...] Asset subscription request
alarm N array alarm[...] Alarm subscription request
alert N array alert[...] Alert subscription request
environment N array environment[...] Environment event subscription details
granularity N array ["IBX", "ZONE", "CAGE"] Granularity level at which data is to be streamed, if specified
config N object config{...}

Configuration to specify near real-time stream consumption parameters

provider N string GOOGLE

Provider for the subscription

method N string PULL

Subscription method

subscription N string   Subscription URL used for pull subscriptions based on provider

 

{
  "alarm": [
    {
      "accountNo": "135888",
      "assetClassification": [
        "ELECTRICAL"
      ],
      "conditionName": [
        "ALARM"
      ],
      "ibx": "DE1"
    }
  ],
  "alert": [
    {
      "accountNo": "135888",
      "ibx": "DE1"
    }
  ],
  "asset": [
    {
      "accountNo": "135888",
      "ibx": "DE1"
    }
  ],
  "config": {
    "method": "PULL",
    "provider": "GOOGLE",
    "subscription": "string"
  },
  "environment": [
    {
      "accountNo": "135888",
      "granularity": [
        "IBX"
      ],
      "ibx": "DE1"
    }
  ],
  "power": [
    {
      "accountNo": "135888",
      "ibx": "DE1"
    }
  ],
  "status": "OK",
  "subscriptionId": "606349eca6171829c70d8777"
}

 

The description of the response payload is as follows:

 

Field name Type Example Description
power array power[...] Power event subscription details
accountNo string 135888 Customer account number
assetClassification array ["ELECTRICAL", "ENVIRONMENTAL", "MECHANICAL"] Classification of assets
conditionName array ["ALARM", "HIGH", "HIGH_HIGH", "LOW", "LOW_LOW", "WARNING"] Alarm condition of the asset
ibx string DE1 IBX code
asset array asset[...] Asset subscription request
alarm array alarm[...] Alarm event subscription details
alert array alert[...] Alert event subscription details
environment array environment[...] Environment event subscription details
granularity array ["IBX", "ZONE", "CAGE"] Granularity level at which data is to be streamed, if specified
subscriptionId string 606349eca6171829c70d8777 Unique identifier for the subscription
config object config{...}

Configuration to specify near real-time stream consumption parameters

provider string GOOGLE

Provider for the subscription

method string PULL

Subscription method

subscription string   Subscription URL used for pull subscriptions based on provider
status string OK, PARTIAL_SUCCESS, ERROR Response status

 

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

DELETE Subscriptions

DELETE /feedsubscription/v1/subscribe/{subscriptionId}

 Method  DELETE
 URL or End Point  /feedsubscription/v1/subscribe/{subscriptionId}
 Headers  Authorization, Content-Type
 Query Parameters  Not applicable
 Body  Not applicable

 

The endpoint allows users to close and delete the near real-time stream of a subscription. The topic itself may not be closed, but events will no longer be published to the topic once a delete request is received.

 

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 delete a subscription for an organization and a JSON response containing the result. 

 

curl -X 

DELETE "https://api.equinix.com/feedsubscription/v1/subscribe/606349eca6171829c70d8777"     

-H "content-type: application/json"                                                                            
-H "authorization: Bearer asxQMSbBwcNzI2fCCNwSwTh3phV2" 

 

{
  "alarm": [
    {
      "accountNo": "135888",
      "assetClassification": [
        "ELECTRICAL"
      ],
      "conditionName": [
        "ALARM"
      ],
      "ibx": "DE1"
    }
  ],
  "alert": [
    {
      "accountNo": "135888",
      "ibx": "DE1"
    }
  ],
  "asset": [
    {
      "accountNo": "135888",
      "ibx": "DE1"
    }
  ],
  "config": {
    "method": "PULL",
    "provider": "GOOGLE",
    "subscription": "string"
  },
  "environment": [
    {
      "accountNo": "135888",
      "granularity": [
        "IBX"
      ],
      "ibx": "DE1"
    }
  ],
  "power": [
    {
      "accountNo": "135888",
      "ibx": "DE1"
    }
  ],
  "status": "OK",
  "subscriptionId": "606349eca6171829c70d8777"
}

 

The description of the response payload is as follows:

 

Field name Type Example Description
power array power[...] Power event subscription details
accountNo string 135888 Customer account number
assetClassification array ["ELECTRICAL", "ENVIRONMENTAL", "MECHANICAL"] Classification of assets
conditionName array ["ALARM", "HIGH", "HIGH_HIGH", "LOW", "LOW_LOW", "WARNING"] Alarm condition of the asset
ibx string DE1 IBX code
asset array asset[...] Asset subscription request
alarm array alarm[...] Alarm event subscription details
alert array alert[...] Alert event subscription details
environment array environment[...] Environment event subscription details
granularity array ["IBX", "ZONE", "CAGE"] Granularity level at which data is to be streamed, if specified
subscriptionId string 606349eca6171829c70d8777 Unique identifier for the subscription
config object config{...}

Configuration to specify near real-time stream consumption parameters

provider string GOOGLE

Provider for the subscription

method string PULL

Subscription method

subscription string   Subscription URL used for pull subscriptions based on provider
status string OK, PARTIAL_SUCCESS, ERROR Response status

 

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