Skip to main content
Index

Subscriptions v1 APIs

GET Subscriptions

GET /feedsubscriptions/v1/subscribe

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

 

It allows users to view their respective near real-time feeds subscription with details. Lists events currently subscribed to. Returns subscription details with a subscription ID. It includes the Power, Asset Tag, and Config information. The subscription config allows you to specify the provider [ GOOGLE, AZURE, AWS], the method [PUSH, PULL] and a push URL if the method of choice is PUSH.

 

The provider supports only PULL method. PUSH method and URL are currently not implemented.

 

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 subscriptions list for the user and a JSON response containing the result. 

 

curl -X 

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

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

 


{
    "power": [
        {
            "ucmId": null,
            "accountNo": "1",
            "ibx": "CH1"
        }
    ],
    "asset": [],
    "alarm": [],
    "alert": [],
    "environment": [],
    "subscriptionId": "5c509e8aabe10e6cda419128",
    "subscriptionName": "projects/equinix-dcim-feeds/subscriptions/joe23%40abc.com",
    "status": "OK",
    "errors": [],
    "config": {
        "method": "PULL",
        "provider": "GOOGLE"
    }
}

 

The description of the response payload is as follows:

 

Field name Type Example Description
 power object   Power events subscription details. 
accountNo string 123 Customer account number.
ibx string AB2 IBX code
asset object   Assets events subscription details.
accountNo string 123 Customer account number.
ibx string AB2 IBX code
alarm object   Alarms events subscription details.
accountNo string 123 Customer account number.
ibx string AB2 IBX code
alert object   Alerts events subscription details.
accountNo string 123 Customer account number.
ibx string AB2 IBX code
environment object   Environments events subscription details.
accountNo string 123 Customer account number.
ibx string AB2 IBX code
subscriptionId number 1234 Unique identifier for the subscription
subscriptionName string   Unique subscription name
status string CH1 IBX code for the IBX in which the asset is located.
config object  

Cloud agnostic, Pub/Sub provider information.

provider string GOOGLE, AZURE, AWS

Pub/Sub implementation to be used for consuming real-time events.

Note: Only GOOGLE is supported currently.

method string PULL, PUSH

Subscription method.

Note: Only PULL is supported currently.

pushurl string  

Push URL, this is mandatory when the method is PUSH.

Note: Not Supported currently.

status string OK, PARTIAL, SUCCESS, ERROR Response status.
error object   API error.

 

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

GET Subscriptions By Id

GET /feedsubscriptions/v1/subscribe/{subscriptionId}

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

 

 

It allows users to view their respective near real-time feeds subscription details. Lists events currently subscribed to.

 

Note: The provider supports only PULL method. PUSH method and URL are currently not implemented.

 

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

 

curl -X 

GET "https://api.equinix.com/registration/v1/subscribe/5c4f7103ce9a9d4903419128"     

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

 

{
    "power": [
        {
            "ucmId": null,
            "accountNo": "1",
            "ibx": "CH1"
        }
    ],
    "asset": [
        {
            "ucmId": null,
            "accountNo": "1",
            "ibx": "CH1"
        }
    ],
    "alarm": [],
    "alert": [],
    "environment": [],
    "subscriptionId": "5c509e8aabe10e6cda419128",
    "subscriptionName": "projects/equinix-dcim-feeds/subscriptions/joe23%40abc.com",
    "status": "OK",
    "errors": [],
    "config": {
        "method": "PULL",
        "provider": "GOOGLE"
    }
}

 

The description of the response payload is as follows:

 

Field name Type Example Description
 power object   Power events subscription details. 
accountNo string 123 Customer account number.
ibx string AB2 IBX code
asset object   Assets events subscription details.
accountNo string 123 Customer account number.
asset.ibx string AB2 IBX code
alarm object   Alarms events subscription details.
accountNo string 123 Customer account number.
ibx string AB2 IBX code
alert object   Alerts events subscription details.
accountNo string 123 Customer account number.
ibx string AB2 IBX code
environment object   Environments events subscription details.
accountNo string 123 Customer account number.
ibx string AB2 IBX code
subscriptionId number 1234 Unique identifier for the subscription
subscriptionName string   Unique subscription name
status string CH1 IBX code for the IBX in which the asset is located.
config object  

Cloud agnostic, Pub/Sub provider information.

provider string GOOGLE, AZURE, AWS

Pub/Sub implementation to be used for consuming real-time events.

method string PULL, PUSH

Subscription method.

Note: Only PULL is supported currently.

pushurl string  

Push URL, this is mandatory when the method is PUSH.

Note: Not Supported currently.

status string OK, PARTIAL, SUCCESS, ERROR Response status.
error object   API error.

 

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

POST Subscriptions

POST /feedsubscriptions/v1/subscribe

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

 

It allows users to register for near real-time feeds.

  • User will have the ability to specify the events for each account, IBX - which will be available as near real-time feeds
  • Depending on the mechanism selected for the near real-time feed integration user will have to specify configuration parameters.

 

It includes the Power, Asset Tag, and Config information. The subscription config allows you to specify the provider [ GOOGLE, AZURE, AWS], the method [PUSH, PULL] and a push URL if the method of choice is PUSH.

 

Note: The provider supports only PULL method. PUSH method and URL are currently not implemented.

 

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 create a new subscription for the user and a JSON response containing the result. 

 

curl -X 

POST https://api.equinix.com/registration/v1/subscribe 

-H 'content-type: application/json' 

-H 'authorization: Bearer ea28LIRkdIEjIDpIHo9B40seYIWs' 
-d '{
    "power": [
    {
      "accountNo": "1",
      "ibx": "CH1"
    }
  ],
  "config": {
    "provider": "GOOGLE",
    "method": "PULL"
  }
}'                     

 

The description of the request payload is as follows:

 

Body Parameter Name Mandatory Type Example values Applicable values Description
power N object     Power events subscription details.
accountNo N string   123 Customer account number
ibx N string   AB2

Name of the IBX for which data is being requested.

asset N object     Assets events subscription details.
accountNo N string   123 Customer account number.
ibx N string   AB2 Name of the IBX for which data is being requested.
alarm N object     Alarms events subscription details.
accountNo N string   123 Customer account number.
ibx N string   AB2 Name of the IBX for which data is being requested.
alert N object     Alerts events subscription details.
accountNo N string   123 Customer account number.
ibx N string   AB2 Name of the IBX for which data is being requested.
environment N object      
accountNo N string   123 Customer account number.
ibx N string   AB2 Name of the IBX for which data is being requested.
config Y object     Subscription configuration.
provider Y string   GOOGLE, AZURE, AWS

Pub/Sub implementation to be used for consuming real-time events.

method Y string   PULL, PUSH

Subscription method.

Note: Only PULL is supported currently.

pushurl N string    

Push URL, this is mandatory when the method is PUSH.

Note: Not Supported currently.

 

{
    "power": [
        {
            "ucmId": null,
            "accountNo": "1",
            "ibx": "CH1"
        }
    ],
    "asset": [],
    "alarm": [],
    "alert": [],
    "environment": [],
    "subscriptionId": "5c509e8aabe10e6cda419128",
    "subscriptionName": "projects/equinix-dcim-feeds/subscriptions/joe23%40abc.com",
    "status": "OK",
    "errors": [],
    "config": {
        "method": "PULL",
        "provider": "GOOGLE"
    }
}

 

The description of the response payload is as follows:

 

Field name Type Example Description
 power object   Power events subscription details. 
accountNo string 123 Customer account number.
ibx string AB2 IBX code
asset object   Assets events subscription details.
accountNo string 123 Customer account number.
ibx string AB2 IBX code
alarm object   Alarms events subscription details.
accountNo string 123 Customer account number.
ibx string AB2 IBX code
alert object   Alerts events subscription details.
accountNo string 123 Customer account number.
ibx string AB2 IBX code
environment object   Environments events subscription details.
accountNo string 123 Customer account number.
ibx string AB2 IBX code
subscriptionId number 1234 Unique identifier for the subscription
subscriptionName string   Unique subscription name
status string CH1 IBX code for the IBX in which the asset is located.
config object  

Cloud agnostic, Pub/Sub provider information.

provider string GOOGLE, AZURE, AWS

Pub/Sub implementation to be used for consuming real-time events.

Note: Only GOOGLE is supported currently.

method string PULL, PUSH

Subscription method.

Note: Only PULL is supported currently.

pushurl string  

Push URL, this is mandatory when the method is PUSH.

Note: Not Supported currently.

status string OK, PARTIAL, SUCCESS, ERROR Response status.
error object   API error.

 

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

PUT Subscriptions

PUT /feedsubscriptions/v1/subscribe

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

 

It allows users to update an existing subscription to near real-time feed to add or remove events. It includes the Power, Asset Tag, and Config information.

The subscription config allows you to specify the provider [ GOOGLE, AZURE, AWS], the method [PUSH, PULL] and a push URL if the method of choice is PUSH.

 

Note: The provider supports only PULL method. PUSH method and URL are currently not implemented.

 

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/registration/v1/subscribe/5c4f7103ce9a9d4903419128 

-H 'content-type: application/json' 

-H 'authorization: Bearer ea28LIRkdIEjIDpIHo9B40seYIWs' 
-d '{
  "power": [
  {
  "accountNo": "1",
  "ibx": "CH1"
  }
  ],
  "asset": [
  {
  "accountNo": "1",
  "ibx": "CH1"
  }
  ],
  "config": {
  "method": "PULL",
  "provider": "GOOGLE"
  }
}'
         

 

The description of the request payload is as follows:

 

Body Parameter Name Mandatory Type Example values Applicable values Description
power N object     Power events subscription details.
accountNo N string   123 Customer account number
ibx N string   AB2

Name of the IBX for which data is being requested.

asset N object     Assets events subscription details.
accountNo N string   123 Customer account number.
ibx N string   AB2 Name of the IBX for which data is being requested.
alarm N object     Alarms events subscription details.
accountNo N string   123 Customer account number.
ibx N string   AB2 Name of the IBX for which data is being requested.
alert N object     Alerts events subscription details.
accountNo N string   123 Customer account number.
ibx N string   AB2 Name of the IBX for which data is being requested.
environment N object      
accountNo N string   123 Customer account number.
ibx N string   AB2 Name of the IBX for which data is being requested.
config Y object     Subscription configuration.
provider Y string   GOOGLE, AZURE, AWS

Pub/Sub implementation to be used for consuming real-time events.

method Y string   PULL, PUSH

Subscription method.

Note: Only PULL is supported currently.

pushurl N string    

Push URL, this is mandatory when the method is PUSH.

Note: Not Supported currently.

 

{
    "power": [
        {
            "ucmId": null,
            "accountNo": "1",
            "ibx": "CH1"
        }
    ],
    "asset": [
        {
            "ucmId": null,
            "accountNo": "1",
            "ibx": "CH1"
        }
    ],
    "alarm": [],
    "alert": [],
    "environment": [],
    "subscriptionId": "5c509e8aabe10e6cda419128",
    "subscriptionName": "projects/equinix-dcim-feeds/subscriptions/joe23%40abc.com",
    "status": "OK",
    "errors": [],
    "config": {
        "method": "PULL",
        "provider": "GOOGLE"
    }
}

 

The description of the response payload is as follows:

 

Field name Type Example Description
 power object   Power events subscription details. 
accountNo string 123 Customer account number.
ibx string AB2 IBX code
asset object   Assets events subscription details.
accountNo string 123 Customer account number.
ibx string AB2 IBX code
alarm object   Alarms events subscription details.
accountNo string 123 Customer account number.
ibx string AB2 IBX code
alert object   Alerts events subscription details.
accountNo string 123 Customer account number.
alert.ibx string AB2 IBX code
environment object   Environments events subscription details.
accountNo string 123 Customer account number.
ibx string AB2 IBX code
subscriptionId number 1234 Unique identifier for the subscription
subscriptionName string   Unique subscription name
status string CH1 IBX code for the IBX in which the asset is located.
config object  

Cloud agnostic, Pub/Sub provider information.

provider string GOOGLE, AZURE, AWS

Pub/Sub implementation to be used for consuming the real time events.

Note: Only GOOGLE is supported currently.

method string PULL, PUSH

Subscription method.

Note: Only PULL is supported currently.

pushurl string  

Push URL, this is mandatory when the method is PUSH.

Note: Not Supported currently.

status string OK, PARTIAL, SUCCESS, ERROR Response status.
error object   API error.

 

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

DELETE Subscriptions

DELETE /feedsubscriptions/v1/subscribe

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

 

The API allows users to delete their near real-time feeds subscription. 

 

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 the subscriptions list for the user and a JSON response containing the result. 

 

curl -X 

DELETE "https://api.equinix.com/registration/v1/subscribe"     

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

 


{
    "power": [
        {
            "ucmId": null,
            "accountNo": "1",
            "ibx": "CH1"
        }
    ],
    "asset": [],
    "alarm": [],
    "alert": [],
    "environment": [],
    "subscriptionId": "5c509e8aabe10e6cda419128",
    "subscriptionName": "projects/equinix-dcim-feeds/subscriptions/joe23%40abc.com",
    "status": "OK",
    "errors": [],
    "config": {
        "method": "PULL",
        "provider": "GOOGLE"
    }
}

 

The description of the response payload is as follows:

 

Field name Type Example Description
 power object   Power events subscription details. 
accountNo string 123 Customer account number.
ibx string AB2 IBX code
asset object   Assets events subscription details.
accountNo string 123 Customer account number.
ibx string AB2 IBX code
alarm object   Alarms events subscription details.
accountNo string 123 Customer account number.
ibx string AB2 IBX code
alert object   Alerts events subscription details.
accountNo string 123 Customer account number.
ibx string AB2 IBX code
environment object   Environments events subscription details.
accountNo string 123 Customer account number.
ibx string AB2 IBX code
subscriptionId number 1234 Unique identifier for the subscription
subscriptionName string   Unique subscription name
status string CH1 IBX code for the IBX in which the asset is located.
config object  

Cloud agnostic, Pub/Sub provider information.

provider string GOOGLE, AZURE, AWS

Pub/Sub implementation to be used for consuming real-time events.

method string PULL, PUSH

Subscription method.

Note: Only PULL is supported currently.

pushurl string  

Push URL, this is mandatory when the method is PUSH.

Note: Not Supported currently.

status string OK, PARTIAL, SUCCESS, ERROR Response status.
error object   API error.

 

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