Skip to main content
Index

Subscriptions v2 APIs

GET Subscriptions

GET /smartview/v2/streams/subscriptions

 Method  GET
 URL or End Point  /smartview/v2/streams/subscriptions
 Headers  Authorization
 Query Parameters  Not applicable
 Body  Not applicable

 

This endpoint allows users to view the real-time stream subscription details. (A subscription is tied to an Organization). Authorization token is the only header that is passed to this API and a response 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 view the subscriptions details for the real-time stream and a JSON response containing the result. 

 

curl -X 

GET "https://api.equinix.com/smartview/v2/streams/subscriptions"     

-H "authorization: Bearer asxQMSbBwcNzI2fCCNwSwTh3phV2" 

 


{   
  "alarm": [
    {
      "accountNo": "133724",
      "alarmType": [
        "ABSOLUTE"
      ],
      "assetClassification": [
        "ELECTRICAL"
      ],
      "conditionName": [
        "ALARM"
      ],
      "ibx": "PA4",
      "region": [
        "EMEA"
      ]
    }
  ],
  "alert": [
    {
      "accountNo": "133724",
      "ibx": "PA4"
    }
  ],
  "asset": [
    {
      "accountNo": "133724",
      "classification": [
        "ELECTRICAL"
      ],
      "ibx": "PA4"
    }
  ],
  "config": {
    "method": "PULL",
    "provider": "AWS_IOT",

    "region": "EMEA",

    "roleArnToAssume": "arn:aws:iam::CUSTOMER_AWS_ACCOUNT_ID:role/publish-from-partner-role-EQUINIX_AWS_ACCOUNT_ID",

    "subscription": "string",

    "token": "string",

    "url": "[example123]-ats.iot.us-west-1.amazonaws.com"
  },
  "connectionString": "string",
  "environment": [
    {
      "accountNo": "133724",
      "granularity": [
        "IBX"
      ],
      "ibx": "PA4"
    }
  ],
  "errors": [
    {
      "code": "string",
      "data": {},
      "message": "string",
      "more_info": "string"
    }
  ],
  "manageConnectionString": "string",
  "power": [
    {
      "accountNo": "133724",
      "ibx": "PA4"
    }
  ],
  "status": "OK",
  "subscriptionId": "5f31c7a51ab60c5ddc2fdca2",
  "subscriptionName": "projects/dcim-apps-and-apis/subscriptions/pwalia_emea"
}

 

The description of the response payload is as follows:

 

Field name Description
power
array
Power event subscription details
Example: power[{...}]
asset
array
Asset subscription request
Example: asset[{...}]
ibx
string
IBX code
Example: "PA4"
alarm
array
Alarm event subscription details
Example: alarm[{...}]
accountNo
string
Customer account number
Example: "133724"
alarmType
array
Types of alarms
Example: ["ABSOLUTE", "DEVIATION", "DIGITAL", "MULTI_STATE"]
assetClassification
array
Classification of assets
Example: ["ELECTRICAL", "MECHANICAL", "ENVIRONMENTAL", "POWER"]
classification
array
Classification of assets - Asset Classification value if specified, otherwise all allowable classifications
Example: ["ELECTRICAL", "MECHANICAL", "ENVIRONMENTAL", "POWER"]
conditionName
array
Condition of the asset
Example: ["ALARM", "HIGH", "HIGH_HIGH", "LOW", "LOW_LOW", "WARNING"]
alert
array
Alert event subscription details
Example: alert[{...}]
region
string
Region in which the asset is located
Example: "AMER", "EMEA", "APAC"
environment
array
Environment event subscription details
Example: environment[{...}]
granularity
array
Granularity value at which data is to be streamed if specified, otherwise all allowable values
Example: ["IBX", "ZONE", "CAGE"] 
subscriptionId
string
Unique identifier for the subscription
Example: "5f31c7a51ab60c5ddc2fdca2"
subscriptionName
string
Name of subscription
Example: "projects/dcim-apps-and-apis/subscriptions/pwalia_emea"
connectionString
string
Connection string to subscribe to topic (Used only when the Provider=AZURE)
Example: "string" 
status
string
Status of the requested subscription
Example: "OK"
config
object
Configuration to specify near real time stream consumption parameters
Example: config{...}
provider
string
Provider for the subscription
Example: "GOOGLE", "AWS_IOT", "AWS", "AZURE", "KAFKA"
method
string
Subscription method.
Example: "PULL", "PUSH"
roleArnToAssume
string

Role to be used for IoT configuration

Example: "arn:aws:iam::CUSTOMER_AWS_ACCOUNT_ID:role/publish-from-partner-role-EQUINIX_AWS_ACCOUNT_ID"

subscription

string

Subscription URL used for pull subscriptions based on provider

Example: "string"

token

string

Token used to send push request from the pub/sub layer

Example: "string"

url

string

URL to be used for push subscription

Example: "[example123]-ats.iot.us-west-1.amazonaws.com"

manageConnectionString
string
Value as seen in response
Example: "string"
errors
array
Error descriptions for the request
Example: errors[{...}]
code
string
Error code
Example: "string"
data
object
Data related to the error
Example: data{...} 
message
string
Error message
Example: "string"
more_info
string
Additional information about the error
Example: "string"

 

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

GET Subscriptions by Id

GET /smartview/v2/streams/subscriptions/{subscriptionId}

 Method  GET
 URL or End Point  /smartview/v2/streams/subscriptions/{subscriptionId}
 Headers  Authorization
 Path Parameters  subscriptionId
 Query Parameters  Not applicable
 Body  Not applicable

 

This endpoint allows users to view the real-time stream subscription details for a specific subscription denoted by an identifier. (A subscription is tied to an Organization). Authorization token is the only header that is passed to this API and a response 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 view the requested subscriptions details for the real-time stream and a JSON response containing the result. 

 

curl -X 

GET "https://api.equinix.com/smartview/v2/streams/subscriptions/{subscriptionId}"     

-H "authorization: Bearer asxQMSbBwcNzI2fCCNwSwTh3phV2" 

 

{   
  "alarm": [
    {
      "accountNo": "133724",
      "alarmType": [
        "ABSOLUTE"
      ],
      "assetClassification": [
        "ELECTRICAL"
      ],
      "conditionName": [
        "ALARM"
      ],
      "ibx": "PA4",
      "region": [
        "EMEA"
      ]
    }
  ],
  "alert": [
    {
      "accountNo": "133724",
      "ibx": "PA4"
    }
  ],
  "asset": [
    {
      "accountNo": "133724",
      "classification": [
        "ELECTRICAL"
      ],
      "ibx": "PA4"
    }
  ],
  "config": {
    "method": "PULL",
    "provider": "AWS_IOT",

    "region": "EMEA"

    "roleArnToAssume": "arn:aws:iam::CUSTOMER_AWS_ACCOUNT_ID:role/publish-from-partner-role-EQUINIX_AWS_ACCOUNT_ID",

    "subscription": "string",

    "token": "string",

    "url": "[example123]-ats.iot.us-west-1.amazonaws.com"
  },
  "connectionString": "string",
  "environment": [
    {
      "accountNo": "133724",
      "granularity": [
        "IBX"
      ],
      "ibx": "PA4"
    }
  ],
  "errors": [
    {
      "code": "string",
      "data": {},
      "message": "string",
      "more_info": "string"
    }
  ],
  "manageConnectionString": "string",
  "power": [
    {
      "accountNo": "133724",
      "ibx": "PA4"
    }
  ],
  "status": "OK",
  "subscriptionId": "5f31c7a51ab60c5ddc2fdca2",
  "subscriptionName": "projects/dcim-apps-and-apis/subscriptions/pwalia_emea"
}

 

The description of the response payload is as follows:

 

Field name Description
power
array
Power event subscription details
Example: power[{...}]
asset
array
Asset subscription request
Example: asset[{...}]
ibx
string
IBX code
Example: "PA4"
alarm
array
Alarm event subscription details
Example: alarm[{...}]
accountNo
string
Customer account number
Example: "133724"
alarmType
array
Types of alarms
Example: ["ABSOLUTE", "DEVIATION", "DIGITAL", "MULTI_STATE"]
assetClassification
array
Classification of assets
Example: ["ELECTRICAL", "MECHANICAL", "ENVIRONMENTAL", "POWER"]
classification
array
Classification of assets - Asset Classification value if specified, otherwise all allowable classifications
Example: ["ELECTRICAL", "MECHANICAL", "ENVIRONMENTAL", "POWER"]
conditionName
array
Condition of the asset
Example: ["ALARM", "HIGH", "HIGH_HIGH", "LOW", "LOW_LOW", "WARNING"]
alert
array
Alert event subscription details
Example: alert[{...}]
region
string
Region in which the asset is located
Example: "AMER", "EMEA", "APAC"
environment
array
Environment event subscription details
Example: environment[{...}]
granularity
array
Granularity value at which data is to be streamed if specified, otherwise all allowable values
Example: ["IBX", "ZONE", "CAGE"] 
subscriptionId
string
Unique identifier for the subscription
Example: "5f31c7a51ab60c5ddc2fdca2"
subscriptionName
string
Name of subscription
Example: "projects/dcim-apps-and-apis/subscriptions/pwalia_emea"
connectionString
string
Connection string to subscribe to topic (Used only when the Provider=AZURE)
Example: "string" 
status
string
Status of the requested subscription
Example: "OK"
config
object
Configuration to specify near real time stream consumption parameters
Example: config{...}
provider
string
Provider for the subscription
Example: "GOOGLE", "AWS", "AWS_IOT", "AZURE", "KAFKA"
method
string
Subscription method.
Example: "PULL", "PUSH"
roleArnToAssume
string

Role to be used for IoT configuration

Example: "arn:aws:iam::CUSTOMER_AWS_ACCOUNT_ID:role/publish-from-partner-role-EQUINIX_AWS_ACCOUNT_ID"

subscription

string

Subscription URL used for pull subscriptions based on provider

Example: "string"

token

string

Token used to send push request from the pub/sub layer

Example: "string"

url

string

URL to be used for push subscription

Example: "[example123]-ats.iot.us-west-1.amazonaws.com"

manageConnectionString
string
Value as seen in response
Example: "string"
errors
array
Error descriptions for the request
Example: errors[{...}]
code
string
Error code
Example: "string"
data
object
Data related to the error
Example: data{...} 
message
string
Error message
Example: "string"
more_info
string
Additional information about the error
Example: "string"

 

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

POST Subscriptions

POST /smartview/v2/streams/subscriptions

 Method  POST
 URL or End Point  /smartview/v2/streams/subscriptions
 Headers  Authorization
 Query Parameters  Not applicable
 Body  alarm, alert, asset, ibx, accountNo, region, alarmType, assetClassification, conditionName, classification, config, method, provider, roleArnToAssume, subscription, token, url, environment, granularity, power

 

This endpoint allows users to register for real-time streams. User can specify the events for each Account-IBX combination to be available as real-time streams, and the real-time stream integration parameters as configuration in the request. Authorization token is the only header that is passed to this API and a response 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 register and subscribe for the real-time stream and a JSON response containing the result. 

 

curl -X 

POST "https://api.equinix.com/smartview/v2/streams/subscriptions"     

-H "authorization: Bearer asxQMSbBwcNzI2fCCNwSwTh3phV2"

-d '{
"alarm": [
    {
      "accountNo": "133724",
      "alarmType": [
        "ABSOLUTE"
      ],
      "assetClassification": [
        "ELECTRICAL"
      ],
      "conditionName": [
        "ALARM"
      ],
      "ibx": "PA4",
      "region": [
        "EMEA"
      ]
    }
  ],
  "alert": [
    {
      "accountNo": "133724",
      "ibx": "PA4"
    }
  ],
  "asset": [
    {
      "accountNo": "133724",
      "classification": [
        "ELECTRICAL"
      ],
      "ibx": "PA4"
    }
  ],
  "config": {
    "method": "PULL",
    "provider": "AWS_IOT",

    "region": "EMEA",

    "roleArnToAssume": "arn:aws:iam::CUSTOMER_AWS_ACCOUNT_ID:role/publish-from-partner-role-EQUINIX_AWS_ACCOUNT_ID",

    "subscription": "string",

    "token": "string",

    "url": "[example123]-ats.iot.us-west-1.amazonaws.com"
  },
  "environment": [
    {
      "accountNo": "133724",
      "granularity": [
        "IBX"
      ],
      "ibx": "PA4"
    }
  ],
  "power": [
    {
      "accountNo": "133724",
      "ibx": "PA4"
    }
  ]
}' 

 

The description of the body parameters is as follows:

Body parameter name Mandatory Description
asset
array
N Asset subscription request
Example: asset[{...}]
alarm
array
N Alarm subscription request
Example: alarm[{...}]
accountNo
string
Y Customer account number
Example: "133724"
ibx
string
Y IBX code
Example: "PA4"
alarmType
array
N Types of alarms
Example: ["ABSOLUTE", "DEVIATION", "DIGITAL", "MULTI_STATE"]
assetClassification
array
N Classification of assets
Example: ["ELECTRICAL", "MECHANICAL", "ENVIRONMENTAL", "POWER"]
classification
array
N Classification of assets - Asset Classification value if specified, otherwise all allowable classifications
Example: ["ELECTRICAL", "MECHANICAL", "ENVIRONMENTAL", "POWER"]
conditionName
array
N Condition of the asset
Example: ["ALARM", "HIGH", "HIGH_HIGH", "LOW", "LOW_LOW", "WARNING"]
alert
array
N Alert subscription request
Example: alert[{...}]
region
string
N Region in which the asset is located
Example: "AMER", "EMEA", "APAC"
environment
array
N Environment event subscription details
Example: environment[{...}]
granularity
array
Y Granularity value at which data is to be streamed if specified, otherwise all allowable values
Example: ["IBX", "ZONE", "CAGE"] 
config
object
N Configuration to specify near real time stream consumption parameters
Example: config{...}
provider
string
N Provider for the subscription
Example: "GOOGLE", "AWS", "AWS_IOT", "AZURE", "KAFKA"
method
string
N Subscription method.
Example: "PULL", "PUSH"
roleArnToAssume
string
N

Role to be used for IoT configuration

Example: "arn:aws:iam::CUSTOMER_AWS_ACCOUNT_ID:role/publish-from-partner-role-EQUINIX_AWS_ACCOUNT_ID"

subscription

string

N

Subscription URL used for pull subscriptions based on provider

Example: "string"

token

string

N

Token used to send push request from the pub/sub layer

Example: "string"

url

string

N URL to be used for push subscription
Example: "[example123]-ats.iot.us-west-1.amazonaws.com"
power
array
N Power subscription request
Example: power[{...}]

 

 


{   
    "alarm": [
    {
      "accountNo": "133724",
      "alarmType": [
        "ABSOLUTE"
      ],
      "assetClassification": [
        "ELECTRICAL"
      ],
      "conditionName": [
        "ALARM"
      ],
      "ibx": "PA4",
      "region": [
        "EMEA"
      ]
    }
  ],
  "alert": [
    {
      "accountNo": "133724",
      "ibx": "PA4"
    }
  ],
  "asset": [
    {
      "accountNo": "133724",
      "classification": [
        "ELECTRICAL"
      ],
      "ibx": "PA4"
    }
  ],
  "config": {
    "method": "PULL",
    "provider": "AWS_IOT",

    "region": "EMEA",

    "roleArnToAssume": "arn:aws:iam::CUSTOMER_AWS_ACCOUNT_ID:role/publish-from-partner-role-EQUINIX_AWS_ACCOUNT_ID",

    "subscription": "string",

    "token": "string",

    "url": "[example123]-ats.iot.us-west-1.amazonaws.com"
  },
  "connectionString": "string",
  "environment": [
    {
      "accountNo": "133724",
      "granularity": [
        "IBX"
      ],
      "ibx": "PA4"
    }
  ],
  "errors": [
    {
      "code": "string",
      "data": {},
      "message": "string",
      "more_info": "string"
    }
  ],
  "manageConnectionString": "string",
  "power": [
    {
      "accountNo": "133724",
      "ibx": "PA4"
    }
  ],
  "status": "OK",
  "subscriptionId": "5f31c7a51ab60c5ddc2fdca2",
  "subscriptionName": "projects/dcim-apps-and-apis/subscriptions/pwalia_emea"
}

 

The description of the response payload is as follows:
 

Field name Description
power
array
Power event subscription details
Example: power[{...}]
asset
array
Asset subscription request
Example: asset[{...}]
ibx
string
IBX code
Example: "PA4"
alarm
array
Alarm event subscription details
Example: alarm[{...}]
accountNo
string
Customer account number
Example: "133724"
alarmType
array
Types of alarms
Example: ["ABSOLUTE", "DEVIATION", "DIGITAL", "MULTI_STATE"]
assetClassification
array
Classification of assets
Example: ["ELECTRICAL", "MECHANICAL", "ENVIRONMENTAL", "POWER"]
classification
array
Classification of assets - Asset Classification value if specified, otherwise all allowable classifications
Example: ["ELECTRICAL", "MECHANICAL", "ENVIRONMENTAL", "POWER"]
conditionName
array
Condition of the asset
Example: ["ALARM", "HIGH", "HIGH_HIGH", "LOW", "LOW_LOW", "WARNING"]
alert
array
Alert event subscription details
Example: alert[{...}]
region
string
Region in which the asset is located
Example: "AMER", "EMEA", "APAC"
environment
array
Environment event subscription details
Example: environment[{...}]
granularity
array
Granularity value at which data is to be streamed if specified, otherwise all allowable values
Example: ["IBX", "ZONE", "CAGE"] 
subscriptionId
string
Unique identifier for the subscription request
Example: "5f31c7a51ab60c5ddc2fdca2"
subscriptionName
string
Name of subscription
Example: "projects/dcim-apps-and-apis/subscriptions/pwalia_emea"
connectionString
string
Connection string to subscribe to topic (Used only when the Provider=AZURE)
Example: "string" 
status
string
Status of the requested subscription
Example: "OK"
config
object
Configuration to specify near real time stream consumption parameters
Example: config{...}
provider
string
Provider for the subscription
Example: "GOOGLE", "AWS", "AWS_IOT", "AZURE", "KAFKA"
method
string
Subscription method.
Example: "PULL", "PUSH"

roleArnToAssume

string

Role to be used for IoT configuration

Example: "arn:aws:iam::CUSTOMER_AWS_ACCOUNT_ID:role/publish-from-partner-role-EQUINIX_AWS_ACCOUNT_ID"

subscription 

string

Subscription URL used for pull subscriptions based on provider

Example: "string"

token

string

Token used to send push request from the pub/sub layer

Example: "string"

url

string

URL to be used for push subscription

Example: "[example123]-ats.iot.us-west-1.amazonaws.com"

manageConnectionString
string
Value as seen in response
Example: "string"
errors
array
Error descriptions for the request
Example: errors[{...}]
code
string
Error code
Example: "string"
data
object
Data related to the error
Example: data{...} 
message
string
Error message
Example: "string"
more_info
string
Additional information about the error
Example: "string"

 

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

PUT Subscriptions

PUT /smartview/v2/streams/subscriptions/{subscriptionId}

 Method  PUT
 URL or End Point  /smartview/v2/streams/subscriptions/{subscriptionId}
 Headers  Authorization
 Query Parameters  Not applicable
 Path Parameters  subscriptionId
 Body alarm, alert, asset, ibx, accountNo, region, alarmType, assetClassification, conditionName, classification, config, method, provider, roleArnToAssume, subscription, token, url, environment, granularity, power

 

This endpoint allows users to update an existing subscription in real-time stream to add or remove events. Authorization token is the only header that is passed to this API and a response is received based on the parameters passed.

 

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 the details of an identified subscription for the real-time stream and a JSON response containing the result. 

 

curl -X 

PUT "https://api.equinix.com/smartview/v2/streams/subscriptions/{subscriptionId}"     

-H "authorization: Bearer asxQMSbBwcNzI2fCCNwSwTh3phV2"

-d '{
  "alarm": [
    {
      "accountNo": "133724",
      "alarmType": [
        "ABSOLUTE"
      ],
      "assetClassification": [
        "ELECTRICAL"
      ],
      "conditionName": [
        "ALARM"
      ],
      "ibx": "string",
      "region": [
        "EMEA"
      ]
    }
  ],
  "alert": [
    {
      "accountNo": "133724",
      "ibx": "PA4"
    }
  ],
  "asset": [
    {
      "accountNo": "133724",
      "classification": [
        "ELECTRICAL"
      ],
      "ibx": "PA4"
    }
  ],
  "config": {
    "method": "PULL",
    "provider": "AWS_IOT",

    "region": "EMEA",

    "roleArnToAssume": "arn:aws:iam::CUSTOMER_AWS_ACCOUNT_ID:role/publish-from-partner-role-EQUINIX_AWS_ACCOUNT_ID",

    "subscription": "string",

    "token": "string",

    "url": "[example123]-ats.iot.us-west-1.amazonaws.com" 
  },
  "environment": [
    {
      "accountNo": "133724",
      "granularity": [
        "IBX"
      ],
      "ibx": "PA4"
    }
  ],
  "power": [
    {
      "accountNo": "133724",
      "ibx": "PA4"
    }
  ]
}' 

 

The description of the body parameters is as follows:

Body parameter name Mandatory Description
asset
array
N Asset subscription request
Example: asset[{...}]
alarm
array
N Alarm subscription request
Example: alarm[{...}]
accountNo
string
Y Customer account number
Example: "133724"
ibx
string
Y IBX code
Example: "PA4"
alarmType
array
N Types of alarms
Example: ["ABSOLUTE", "DEVIATION", "DIGITAL", "MULTI_STATE"]
assetClassification
array
N Classification of assets
Example: ["ELECTRICAL", "MECHANICAL", "ENVIRONMENTAL", "POWER"]
classification
array
N Classification of assets - Asset Classification value if specified, otherwise all allowable classifications
Example: ["ELECTRICAL", "MECHANICAL", "ENVIRONMENTAL", "POWER"]
conditionName
array
N Condition of the asset
Example: ["ALARM", "HIGH", "HIGH_HIGH", "LOW", "LOW_LOW", "WARNING"]
alert
array
N Alert subscription request
Example: alert[{...}]
region
string
N Region in which the asset is located
Example: "AMER", "EMEA", "APAC"
environment
array
N Environment event subscription details
Example: environment[{...}]
granularity
array
Y Granularity value at which data is to be streamed if specified, otherwise all allowable values
Example: ["IBX", "ZONE", "CAGE"] 
config
object
N Configuration to specify near real time stream consumption parameters
Example: config{...}
provider
string
N Provider for the subscription
Example: "GOOGLE", "AWS", "AWS_IOT", "AZURE", "KAFKA"
method
string
N Subscription method.
Example: "PULL", "PUSH"
roleArnToAssume
string
N

Role to be used for IoT configuration

Example: "arn:aws:iam::CUSTOMER_AWS_ACCOUNT_ID:role/publish-from-partner-role-EQUINIX_AWS_ACCOUNT_ID"

subscription

string

N

Subscription URL used for pull subscriptions based on provider

Example: "string"

token

string

N

Token used to send push request from the pub/sub layer

Example: "string"

url

string

N URL to be used for push subscription
Example: "[example123]-ats.iot.us-west-1.amazonaws.com"
power
array
N Power subscription request
Example: power[{...}]

 

 


{
     "alarm": [
    {
      "accountNo": "133724",
      "alarmType": [
        "ABSOLUTE"
      ],
      "assetClassification": [
        "ELECTRICAL"
      ],
      "conditionName": [
        "ALARM"
      ],
      "ibx": "PA4",
      "region": [
        "EMEA"
      ]
    }
  ],
  "alert": [
    {
      "accountNo": "133724",
      "ibx": "PA4"
    }
  ],
  "asset": [
    {
      "accountNo": "133724",
      "classification": [
        "ELECTRICAL"
      ],
      "ibx": "PA4"
    }
  ],
  "config": {
    "method": "PULL",
    "provider": "AWS_IOT",

    "region": "EMEA",

    "roleArnToAssume": "arn:aws:iam::CUSTOMER_AWS_ACCOUNT_ID:role/publish-from-partner-role-EQUINIX_AWS_ACCOUNT_ID",

    "subscription": "string",

    "token": "string",

    "url": "[example123]-ats.iot.us-west-1.amazonaws.com"
  },
  "connectionString": "string",
  "environment": [
    {
      "accountNo": "133724",
      "granularity": [
        "IBX"
      ],
      "ibx": "PA4"
    }
  ],
  "errors": [
    {
      "code": "string",
      "data": {},
      "message": "string",
      "more_info": "string"
    }
  ],
  "manageConnectionString": "string",
  "power": [
    {
      "accountNo": "133724",
      "ibx": "PA4"
    }
  ],
  "status": "OK",
  "subscriptionId": "5f31c7a51ab60c5ddc2fdca2",
  "subscriptionName": "projects/dcim-apps-and-apis/subscriptions/pwalia_emea"
}

 

The description of the response payload is as follows:
 

Field name Description
power
array
Power event subscription details
Example: power[{...}]
asset
array
Asset subscription request
Example: asset[{...}]
ibx
string
IBX code
Example: "PA4"
alarm
array
Alarm event subscription details
Example: alarm[{...}]
accountNo
string
Customer account number
Example: "133724"
alarmType
array
Types of alarms
Example: ["ABSOLUTE", "DEVIATION", "DIGITAL", "MULTI_STATE"]
assetClassification
array
Classification of assets
Example: ["ELECTRICAL", "MECHANICAL", "ENVIRONMENTAL", "POWER"]
classification
array
Classification of assets - Asset Classification value if specified, otherwise all allowable classifications
Example: ["ELECTRICAL", "MECHANICAL", "ENVIRONMENTAL", "POWER"]
conditionName
array
Condition of the asset
Example: ["ALARM", "HIGH", "HIGH_HIGH", "LOW", "LOW_LOW", "WARNING"]
alert
array
Alert event subscription details
Example: alert[{...}]
region
string
Region in which the asset is located
Example: "AMER", "EMEA", "APAC"
environment
array
Environment event subscription details
Example: environment[{...}]
granularity
array
Granularity value at which data is to be streamed if specified, otherwise all allowable values
Example: ["IBX", "ZONE", "CAGE"] 
subscriptionId
string
Unique identifier for the subscription request
Example: "5f31c7a51ab60c5ddc2fdca2"
subscriptionName
string
Name of subscription
Example: "projects/dcim-apps-and-apis/subscriptions/pwalia_emea"
connectionString
string
Connection string to subscribe to topic (Used only when the Provider=AZURE)
Example: "string" 
status
string
Status of the requested subscription
Example: "OK"
config
object
Configuration to specify near real time stream consumption parameters
Example: config{...}
provider
string
Provider for the subscription
Example: "GOOGLE", "AWS", "AWS_IOT", "AZURE", "KAFKA"
method
string
Subscription method.
Example: "PULL", "PUSH"
roleArnToAssume
string

Role to be used for IoT configuration

Example: "arn:aws:iam::CUSTOMER_AWS_ACCOUNT_ID:role/publish-from-partner-role-EQUINIX_AWS_ACCOUNT_ID"

subscription

string

Subscription URL used for pull subscriptions based on provider

Example: "string"

token

string

Token used to send push request from the pub/sub layer

Example: "string"

url

string

URL to be used for push subscription

Example: "[example123]-ats.iot.us-west-1.amazonaws.com"

manageConnectionString
string
Value as seen in response
Example: "string"
errors
array
Error descriptions for the request
Example: errors[{...}]
code
string
Error code
Example: "string"
data
object
Data related to the error
Example: data{...} 
message
string
Error message
Example: "string"
more_info
string
Additional information about the error
Example: "string"

 

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

DELETE Subscriptions

DELETE /smartview/v2/streams/subscriptions

 Method  DELETE
 URL or End Point  /smartview/v2/streams/subscriptions
 Headers  Authorization
 Query Parameters  Not applicable
 Body  Not applicable

 

This API allows users to close a real-time stream. Events will no longer be available for the subscription once a delete request is received. Authorization token is the only header that is passed to this API and a response 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 the subscriptions details for the real-time stream and a JSON response containing the result. 

 

curl -X 

DELETE "https://api.equinix.com/smartview/v2/streams/subscriptions"     

-H "authorization: Bearer asxQMSbBwcNzI2fCCNwSwTh3phV2" 

 


{   
   "alarm": [
    {
      "accountNo": "133724",
      "alarmType": [
        "ABSOLUTE"
      ],
      "assetClassification": [
        "ELECTRICAL"
      ],
      "conditionName": [
        "ALARM"
      ],
      "ibx": "PA4",
      "region": [
        "EMEA"
      ]
    }
  ],
  "alert": [
    {
      "accountNo": "133724",
      "ibx": "PA4"
    }
  ],
  "asset": [
    {
      "accountNo": "133724",
      "classification": [
        "ELECTRICAL"
      ],
      "ibx": "PA4"
    }
  ],
  "config": {
    "method": "PULL",
    "provider": "AWS_IOT",

    "region": "EMEA",

    "roleArnToAssume": "arn:aws:iam::CUSTOMER_AWS_ACCOUNT_ID:role/publish-from-partner-role-EQUINIX_AWS_ACCOUNT_ID",

    "subscription": "string",

    "token": "string",

    "url": "[example123]-ats.iot.us-west-1.amazonaws.com"
  },
  "connectionString": "string",
  "environment": [
    {
      "accountNo": "133724",
      "granularity": [
        "IBX"
      ],
      "ibx": "PA4"
    }
  ],
  "errors": [
    {
      "code": "string",
      "data": {},
      "message": "string",
      "more_info": "string"
    }
  ],
  "manageConnectionString": "string",
  "power": [
    {
      "accountNo": "133724",
      "ibx": "PA4"
    }
  ],
  "status": "OK",
  "subscriptionId": "5f31c7a51ab60c5ddc2fdca2",
  "subscriptionName": "projects/dcim-apps-and-apis/subscriptions/pwalia_emea"
}

 

The description of the response payload is as follows:

 

Field name Description
power
array
Power event subscription details
Example: power[{...}]
asset
array
Asset subscription request
Example: asset[{...}]
ibx
string
IBX code
Example: "PA4"
alarm
array
Alarm event subscription details
Example: alarm[{...}]
accountNo
string
Customer account number
Example: "133724"
alarmType
array
Types of alarms
Example: ["ABSOLUTE", "DEVIATION", "DIGITAL", "MULTI_STATE"]
assetClassification
array
Classification of assets
Example: ["ELECTRICAL", "MECHANICAL", "ENVIRONMENTAL", "POWER"]
classification
array
Classification of assets - Asset Classification value if specified, otherwise all allowable classifications
Example: ["ELECTRICAL", "MECHANICAL", "ENVIRONMENTAL", "POWER"]
conditionName
array
Condition of the asset
Example: ["ALARM", "HIGH", "HIGH_HIGH", "LOW", "LOW_LOW", "WARNING"]
alert
array
Alert event subscription details
Example: alert[{...}]
region
string
Region in which the asset is located
Example: "AMER", "EMEA", "APAC"
environment
array
Environment event subscription details
Example: environment[{...}]
granularity
array
Granularity value at which data is to be streamed if specified, otherwise all allowable values
Example: ["IBX", "ZONE", "CAGE"] 
subscriptionId
string
Unique identifier for the subscription
Example: "5f31c7a51ab60c5ddc2fdca2"
subscriptionName
string
Name of subscription
Example: "projects/dcim-apps-and-apis/subscriptions/pwalia_emea"
connectionString
string
Connection string to subscribe to topic (Used only when the Provider=AZURE)
Example: "string" 
status
string
Status of the requested subscription
Example: "OK"
config
object
Configuration to specify near real time stream consumption parameters
Example: config{...}
provider
string
Provider for the subscription
Example: "GOOGLE", "AWS", "AWS_IOT", "AZURE", "KAFKA"
method
string
Subscription method.
Example: "PULL", "PUSH"

roleArnToAssume

string

Role to be used for IoT configuration

Example: "arn:aws:iam::CUSTOMER_AWS_ACCOUNT_ID:role/publish-from-partner-role-EQUINIX_AWS_ACCOUNT_ID"

subscription

string

Subscription URL used for pull subscriptions based on provider

Example: "string"

token

string

Token used to send push request from the pub/sub layer

Example: "string"

url

string

URL to be used for push subscription

Example: "[example123]-ats.iot.us-west-1.amazonaws.com"

manageConnectionString
string
Value as seen in response
Example: "string"
errors
array
Error descriptions for the request
Example: errors[{...}]
code
string
Error code
Example: "string"
data
object
Data related to the error
Example: data{...} 
message
string
Error message
Example: "string"
more_info
string
Additional information about the error
Example: "string"

 

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