Skip to main content

Effective 10 September 2024, API Documentation can be found on our Equinix Product Documentation site.
The content on this page will not be updated after 1 Oct 2024 and will be inaccessible after 31st Dec 2024.


Subscriptions v2

Subscription API enables establishing a communication channel destination for events concerning environmental and operational status of selected assets. It supports AWS IoT Core, Azure Event Hub, Webhook and REST communication channels.

 
  • You can use only one communication channel type in your organization. For example, if you create a subscription with the AWS IoT Core channel, you won't be able to create another subscription using a different channel type.
  • Only one channel is allowed for a single subscription.

While AWS IoT Core enables the connection of multiple IoT devices to the cloud without the management of server infrastructure, Webhook uses mutual TLS (mTLS) authentication.

mTLS certificate is used as an extension of the TLS (former SSL) certificate for the server and client to authenticate each other. Equinix requires this trusted signed certificate from clients, similar to that provided by our services. Our subscription services offer you the additional option of connection verification. When a new batch of events is sent with each communication attempt, our subscription services use the certificates provided by the client to validate that the service we're sending the data to is the correct one.

 

API Plus subscription doesn't accept self-signed certificates. Use a CA certificate for the mutual authentication.

See the following resources to learn more about mutual TLS and download Equinix webhook certificate:

Create Subscription​

 POST /smartview/v2/streaming/subscriptions
MethodPOST
URL or Endpoint/smartview/v2/streaming/subscriptions
HeadersAuthorization
Path ParametersNot applicable
Query ParametersNot applicable
Body ParametersmessageType, asset, accountNumber, ibx, assetClassification, assetId, environmental, level, power, meteredPower, systemAlert, conditionName, customAlert, user, channel, channelType, awsIotCoreChannelConfiguration, url, webhookChannelConfiguration, sslCertificate, numberOfRetries, batchSize, numberOfConcurrentCalls

This API request creates a new streaming subscription instance.

 

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

Sample curl request - Amazon IoT Core communication channel

 

To enable Amazon IoT Core communication channel you must download Equinix certificate and register it in AWS Management Console. For details, see Download and Register Equinix Certificate.

curl -X 
POST 'https://api.equinix.com/smartview/v2/streaming/subscriptions'
-H 'authorization: Bearer asxQMSbBwcNzI2fCCNwSwTh3phV2'
-d '{
    "messageType": {
        "asset": [
            {
                "accountNumber": "135888",
                "ibx": [
                    "DE2"
                ],
                "assetClassification": [
                    "MECHANICAL"
                ],
                "assetId": [
                    "string"
                ]
            }
        ],
        "environmental": [
            {
                "accountNumber": "135888",
                "ibx": [
                    "DE2"
                ],
                "level": [
                    "ZONE"
                ]
            }
        ],
        "power": [
            {
                "accountNumber": "135888",
                "ibx": [
                    "DE2"
                ]
            }
        ],
        "meteredPower": [
            {
                "accountNumber": "135888",
                "ibx": [
                    "DE2"
                ]
            }
        ],
        "systemAlert": [
            {
                "accountNumber": "135888",
                "ibx": [
                    "DE2"
                ]
            }
        ],
        "customAlert": [
            {
                "accountNumber": "135888",
                "ibx": [
                    "DE2"
                ],
                "user": "abc"
            }
        ]
    },
    "channel": {
        "channelType": "AWS_IOT_CORE",
        "awsIotCoreChannelConfiguration": {
            "url": "https://b4c3mzxe8syvhd-ats.iot.us-west-2.amazonaws.com"
        }
    }
}' 

Sample curl request - Webhooks communication channel

curl -X 
POST 'https://api.equinix.com/smartview/v2/streaming/subscriptions'
-H 'authorization: Bearer asxQMSbBwcNzI2fCCNwSwTh3phV2'
-d '{
    "messageType": {
        "asset": [
            {
                "accountNumber": "135888",
                "ibx": [
                    "DE2"
                ],
                "assetClassification": [
                    "MECHANICAL"
                ],
                "assetId": [
                    "string"
                ]
            }
        ],
        "environmental": [
            {
                "accountNumber": "135888",
                "ibx": [
                    "DE2"
                ],
                "level": [
                    "ZONE"
                ]
            }
        ],
        "power": [
            {
                "accountNumber": "135888",
                "ibx": [
                    "DE2"
                ]
            }
        ],
        "meteredPower": [
            {
                "accountNumber": "135888",
                "ibx": [
                    "DE2"
                ]
            }
        ],
        "systemAlert": [
            {
                "accountNumber": "135888",
                "ibx": [
                    "DE2"
                ]
            }
        ],
        "customAlert": [
            {
                "accountNumber": "135888",
                "ibx": [
                    "DE2"
                ],
                "user": "abc"
            }
        ]
    },
    "channel": {
        "channelType": "WEBHOOK",
        "webhookChannelConfiguration": {
            "sslCertificate": "ZkFzZLY1IGRpY31kZXI=",
            "url": "https://client/event/endpoint",
            "numberOfRetries": 1,
            "numberOfConcurrentCalls": 20,
            "batchSize": 5
        }
    }
}' 

Sample curl request - REST communication channel

curl -X 
POST 'https://api.equinix.com/smartview/v2/streaming/subscriptions'
-H 'authorization: Bearer asxQMSbBwcNzI2fCCNwSwTh3phV2'
-d '{
    "messageType": {
        "asset": [
            {
                "accountNumber": "135888",
                "ibx": [
                    "DE2"
                ],
                "assetClassification": [
                    "MECHANICAL"
                ],
                "assetId": [
                    "string"
                ]
            }
        ],
        "environmental": [
            {
                "accountNumber": "135888",
                "ibx": [
                    "DE2"
                ],
                "level": [
                    "ZONE"
                ]
            }
        ],
        "power": [
            {
                "accountNumber": "135888",
                "ibx": [
                    "DE2"
                ]
            }
        ],
        "meteredPower": [
            {
                "accountNumber": "135888",
                "ibx": [
                    "DE2"
                ]
            }
        ],
        "systemAlert": [
            {
                "accountNumber": "135888",
                "ibx": [
                    "DE2"
                ]
            }
        ],
        "customAlert": [
            {
                "accountNumber": "135888",
                "ibx": [
                    "DE2"
                ],
                "user": "abc"
            }
        ]
    },
    "channel": {
        "channelType": "REST",
        "restChannelConfiguration": {
        }
    }
}' 
 

For Microsoft Azure channel configuration, contact Equinix Service Desk.

Body parameters

Parameter
Description
messageType object
REQUIRED
Message type for the subscription that defines the IBX details from which to expect events
asset array[object]
OPTIONAL
List of asset message type to subscribe.
accountNumber string
REQUIRED
Customer account number.
Example: 135888
ibx array[string]
REQUIRED
IBX data center identifier.
Example: DE2
assetClassification array[string]
OPTIONAL
Classification of assets - Asset Classification value if specified, otherwise all allowable classifications.
Applicable values:
  • ELECTRICAL
  • MECHANICAL
  • ENVIRONMENTAL
assetId array[string]
OPTIONAL
Asset identifier.
environmental array[object]
OPTIONAL
List of environmental type events to subscribe.
accountNumber string
REQUIRED
Customer account number.
Example: 135888
ibx string
REQUIRED
IBX data center identifier.
Example: DE2
level string
OPTIONAL
If not provided in the request, subscription includes all environmental messages at the IBX, zone, and cage levels.
Applicable values:
  • IBX
  • ZONE
  • CAGE
power array[object]
OPTIONAL
List of power message type to subscribe.
accountNumber string
REQUIRED
Customer account number.
Example: 135888
ibx array[string]
REQUIRED
IBX data center identifier.
Example: DE2
meteredPower array[object]
OPTIONAL
Metered power type messages subscription.
accountNumber string
REQUIRED
Customer account number.
Example: 135888
ibx array[string]
REQUIRED
IBX data center identifier.
Example: DE2
systemAlert array[object]
OPTIONAL
List of system alert type events to subscribe.
accountNumber string
REQUIRED
Customer account number.
Example: 135888
ibx array[string]
REQUIRED
IBX data center identifier.
Example: DE2
customAlert array[object]
OPTIONAL
List of custom alert type events to subscribe.
accountNumber string
REQUIRED
Customer account number.
Example: 135888
ibx array[string]
REQUIRED
IBX data center identifier.
Example: DE2
user string
OPTIONAL
User associated with the subscription.
Example: JohnDoe
channel object
OPTIONAL
Defines the event messages destination.
channelType string
REQUIRED
Type of communication channel used for the subscription.
Applicable values:
  • AWS_IOT_CORE
  • AZURE
  • WEBHOOK
  • REST
AWS IoT Core
awsIotCoreChannelConfiguration object
OPTIONAL
AWS IoT Core channel configuration.
url string
REQUIRED
AWS IoT Core device endpoint URL.
Example: https://b4c3mzxe8syvhd-ats.iot.us-west-2.amazonaws.com
Webhooks
webhookChannelConfiguration object
OPTIONAL
Webhook channel configuration.
sslCertificate string
OPTIONAL
Base64 form of client public certificate chain in PEM format.
Example: ZkFzZLY1IGRpY31kZXI
url string
REQUIRED
Webhook endpoint url.
Example: https://client/event/endpoint
numberOfRetries integer
OPTIONAL
Number of times the subscription tries to send a message until it's marked as Retried (no longer near real-time). Our system attempts to resend the message later and if the destination remains unreachable, the message is moved to DLQ.
Applicable values: [1..5]
Default value: 3
numberOfConcurrentCalls integer
OPTIONAL
Upper bound of concurrent workers sending messages to the given url.
Applicable values: [20..50]
Default value: 25
batchSize integer
OPTIONAL
Upper (soft) bound for number of messages in a single payload.
Applicable values: [5..20]
Default value: 10
REST
restChannelConfiguration object
OPTIONAL
REST channel configuration.
Microsoft Azure

For Microsoft Azure channel configuration, contact Equinix Service Desk.


Sample response

HTTP/1.1 201 Created
Location: /smartview/v2/streaming/subscriptions/607460c5e4a78360425bca63
 

If you get “Access Denied” error, contact your local Equinix Service Desk for Equinix Smart View portal access.

Get All Subscriptions​

 GET /smartview/v2/streaming/subscriptions
MethodGET
URL or Endpoint/smartview/v2/streaming/subscriptions
HeadersAuthorization
Path ParametersNot applicable
Query ParametersNot applicable
Body ParametersNot applicable

This API request returns all streaming subscription instances.

 

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

Sample curl request

curl -X 
GET 'https://api.equinix.com/smartview/v2/streaming/subscriptions'
-H 'authorization: Bearer asxQMSbBwcNzI2fCCNwSwTh3phV2'

Sample response - AWS IoT Core channel

[
    {
        "id": "606349eca6171829c70d8777",
        "status": "PENDING",
        "messageType": {
            "asset": [
                {
                    "accountNumber": "135888",
                    "ibx": [
                        "DE2"
                    ],
                    "assetClassification": [
                        "MECHANICAL"
                    ],
                    "assetId": [
                        "string"
                    ]
                }
            ],
            "environmental": [
                {
                    "accountNumber": "135888",
                    "ibx": [
                        "DE2"
                    ],
                    "level": [
                        "ZONE"
                    ]
                }
            ],
            "power": [
                {
                    "accountNumber": "135888",
                    "ibx": [
                        "DE2"
                    ]
                }
            ],
            "meteredPower": [
                {
                    "accountNumber": "135888",
                    "ibx": [
                        "DE2"
                    ]
                }
            ],
            "systemAlert": [
                {
                    "accountNumber": "135888",
                    "ibx": [
                        "DE2"
                    ]
                }
            ],
            "customAlert": [
                {
                    "accountNumber": "135888",
                    "ibx": [
                        "DE2"
                    ],
                    "user": "abc"
                }
            ]
        },
        "channel": {
            "channelType": "AWS_IOT_CORE",
            "awsIotCoreChannelConfiguration": {
                "url": "https://b4c3mzxe8syvhd-ats.iot.us-west-2.amazonaws.com"
            }
        },
        "orgId": "123",
        "createdBy": "abc",
        "createdDateTime": "2019-08-24T14:15:22Z",
        "updatedBy": "abc",
        "updatedDateTime": "2019-08-24T14:15:22Z"
    }
]

Response payload body description

Parameter
Description
id string
Subscription identifier.
Example: 606349eca6171829c70d8777
status string
Subscription status.
  • PENDING - Streaming subscription is being set up. It takes a few minutes to initiate a streaming subscription instance.
  • ACTIVE - Streaming subscription is active.
  • FAILED - Streaming subscription activation has failed. Contact Equinix Service Desk.
messageType object
Message type for the subscription that defines the IBX details from which to expect events
asset array[object]
List of asset message type to subscribe.
accountNumber string
Customer account number.
Example: 135888
ibx array[string]
IBX data center identifier.
Example: DE2
assetClassification array[string]
Classification of assets - Asset Classification value if specified, otherwise all allowable classifications.
Example:
  • ELECTRICAL
  • MECHANICAL
  • ENVIRONMENTAL
assetId array[string]
Asset identifier.
environmental array[object]
List of environmental type events to subscribe.
accountNumber string
Customer account number.
Example: 135888
ibx string
IBX data center identifier.
Example: DE2
level string
If not provided in the request, subscription includes all environmental messages at the IBX, zone, and cage levels.
Example:
  • IBX
  • ZONE
  • CAGE
power array[object]
List of power message type to subscribe.
accountNumber string
Customer account number.
Example: 135888
ibx array[string]
IBX data center identifier.
Example: DE2
meteredPower array[object]
Metered power type messages subscription.
accountNumber string
Customer account number.
Example: 135888
ibx array[string]
IBX data center identifier.
Example: DE2
systemAlert array[object]
List of system alert type events to subscribe.
accountNumber string
Customer account number.
Example: 135888
ibx array[string]
IBX data center identifier.
Example: DE2
customAlert array[object]
List of custom alert type events to subscribe.
accountNumber string
Customer account number.
Example: 135888
ibx array[string]
IBX data center identifier.
Example: DE2
user string
User associated with the subscription.
Example: JohnDoe
channel object
Defines the event messages destination.
channelType string
Type of communication channel used for the subscription.
Possible values:
  • AWS_IOT_CORE
  • AZURE
  • WEBHOOK
  • REST
AWS IoT Core
awsIotCoreChannelConfiguration object
AWS IoT Core channel configuration.
url string
AWS IoT Core device endpoint URL.
Example: https://b4c3mzxe8syvhd-ats.iot.us-west-2.amazonaws.com
Webhooks
webhookChannelConfiguration object
Webhook channel configuration.
sslCertificate string
Base64 form of client public certificate chain in PEM format.
Example: ZkFzZLY1IGRpY31kZXI
url string
Webhook endpoint url.
Example: https://client/event/endpoint
numberOfRetries integer
Number of times the subscription tries to send a message until it's marked as Retried (no longer near real-time). Our system attempts to resend the message later and if the destination remains unreachable, the message is moved to DLQ.
Example: 3
numberOfConcurrentCalls integer
Upper bound of concurrent workers sending messages to the given url.
Example: 25
batchSize integer
Upper (soft) bound for number of messages in a single payload.
Example: 10
REST
restChannelConfiguration object
REST channel configuration.
 

If you get “Access Denied” error, contact your local Equinix Service Desk for Equinix Smart View portal access.

Get Specified Subscription​

 GET /smartview/v2/streaming/subscriptions/{id}
MethodGET
URL or Endpoint/smartview/v2/streaming/subscriptions/{id}
HeadersAuthorization
Path Parametersid
Query ParametersNot applicable
Body ParametersNot applicable

This API request returns a specified streaming subscription instance.

 

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

Sample curl request

curl -X 
GET 'https://api.equinix.com/smartview/v2/streaming/subscriptions/606349eca6171829c70d8777'     
-H 'authorization: Bearer asxQMSbBwcNzI2fCCNwSwTh3phV2 '

Path parameters

ParameterDescription
id string
REQUIRED		Subscription identifier.
Example: 606349eca6171829c70d8777

Sample response

{
    "id": "606349eca6171829c70d8777",
    "status": "ACTIVE",
    "messageType": {
        "asset": [
            {
                "accountNumber": "135888",
                "ibx": [
                    "DE2"
                ],
                "assetClassification": [
                    "MECHANICAL"
                ],
                "assetId": [
                    "string"
                ]
            }
        ],
        "environmental": [
            {
                "accountNumber": "135888",
                "ibx": [
                    "DE2"
                ],
                "level": [
                    "ZONE"
                ]
            }
        ],
        "power": [
            {
                "accountNumber": "135888",
                "ibx": [
                    "DE2"
                ]
            }
        ],
        "meteredPower": [
            {
                "accountNumber": "135888",
                "ibx": [
                    "DE2"
                ]
            }
        ],
        "systemAlert": [
            {
                "accountNumber": "135888",
                "ibx": [
                    "DE2"
                ]
            }
        ],
        "customAlert": [
            {
                "accountNumber": "135888",
                "ibx": [
                    "DE2"
                ],
                "user": "abc"
            }
        ]
    },
    "channel": {
        "channelType": "AWS_IOT_CORE",
        "awsIotCoreChannelConfiguration": {
            "url": "https://b4c3mzxe8syvhd-ats.iot.us-west-2.amazonaws.com"
        }
    },
    "orgId": "123",
    "createdBy": "abc",
    "createdDateTime": "2019-08-24T14:15:22Z",
    "updatedBy": "abc",
    "updatedDateTime": "2019-08-24T14:15:22Z"
}

Response payload body description

Parameter
Description
id string
Subscription identifier.
Example: 606349eca6171829c70d8777
status string
Subscription status.
  • PENDING - Streaming subscription is being set up. It takes a few minutes to initiate a streaming subscription instance.
  • ACTIVE - Streaming subscription is active.
  • FAILED - Streaming subscription activation has failed. Contact Equinix Service Desk.
messageType object
Message type for the subscription that defines the IBX details from which to expect events
asset array[object]
List of asset message type to subscribe.
accountNumber string
Customer account number.
Example: 135888
ibx array[string]
IBX data center identifier.
Example: DE2
assetClassification array[string]
Classification of assets - Asset Classification value if specified, otherwise all allowable classifications.
Example:
  • ELECTRICAL
  • MECHANICAL
  • ENVIRONMENTAL
assetId array[string]
Asset identifier.
environmental array[object]
List of environmental type events to subscribe.
accountNumber string
Customer account number.
Example: 135888
string
IBX data center identifier.
Example: DE2
level string
If not provided in the request, subscription includes all environmental messages at the IBX, zone, and cage levels.
Example:
  • IBX
  • ZONE
  • CAGE
power array[object]
List of power message type to subscribe.
accountNumber string
Customer account number.
Example: 135888
ibx array[string]
IBX data center identifier.
Example: DE2
meteredPower array[object]
Metered power type messages subscription.
accountNumber string
Customer account number.
Example: 135888
ibx array[string]
IBX data center identifier.
Example: DE2
systemAlert array[object]
List of system alert type events to subscribe.
accountNumber string
Customer account number.
Example: 135888
ibx array[string]
IBX data center identifier.
Example: DE2
customAlert array[object]
List of custom alert type events to subscribe.
accountNumber string
Customer account number.
Example: 135888
ibx array[string]
IBX data center identifier.
Example: DE2
user string
User associated with the subscription.
Example: JohnDoe
channel object
Defines the event messages destination.
channelType string
Type of communication channel used for the subscription.
Example:
  • AWS_IOT_CORE
  • AZURE
  • WEBHOOK
  • REST
AWS IoT Core
awsIotCoreChannelConfiguration object
AWS IoT Core channel configuration.
url string
AWS IoT Core device endpoint URL.
Example: https://b4c3mzxe8syvhd-ats.iot.us-west-2.amazonaws.com
Webhooks
webhookChannelConfiguration object
Webhook channel configuration.
sslCertificate string
Base64 form of client public certificate chain in PEM format.
Example: ZkFzZLY1IGRpY31kZXI
url string
Webhook endpoint url.
Example: https://client/event/endpoint
numberOfRetries integer
Number of times the subscription tries to send a message until it's marked as Retried (no longer near real-time). Our system attempts to resend the message later and if the destination remains unreachable, the message is moved to DLQ.
Example: 3
numberOfConcurrentCalls integer
Upper bound of concurrent workers sending messages to the given url.
Example: 25
batchSize integer
Upper (soft) bound for number of messages in a single payload.
Example: 10
REST
restChannelConfiguration object
REST channel configuration.
 

If you get “Access Denied” error, contact your local Equinix Service Desk for Equinix Smart View portal access.

Update Subscription​

 PUT /smartview/v2/streaming/subscriptions/{id}
MethodPUT
URL or Endpoint/smartview/v2/streaming/subscriptions/{id}
HeadersAuthorization
Path Parametersid
Query ParametersNot applicable
Body ParametersmessageType, asset, accountNumber, ibx, assetClassification, assetId, environmental, level, power, meteredPower, systemAlert, conditionName, customAlert, user, channel, channelType, awsIotCoreChannelConfiguration, url, webhookChannelConfiguration, sslCertificate, numberOfRetries, batchSize, numberOfConcurrentCalls

This API request modifies a given streaming subscription.

 

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

Sample curl request

curl -X 
PUT 'https://api.equinix.com/smartview/v2/streaming/subscriptions/{id}'
-H 'authorization: Bearer asxQMSbBwcNzI2fCCNwSwTh3phV2'
-d '{
    "messageType": {
        "asset": [
            {
                "accountNumber": "135888",
                "ibx": [
                    "DE2"
                ],
                "assetClassification": [
                    "MECHANICAL"
                ],
                "assetId": [
                    "string"
                ]
            }
        ],
        "environmental": [
            {
                "accountNumber": "135888",
                "ibx": [
                    "DE2"
                ],
                "level": [
                    "ZONE"
                ]
            }
        ],
        "power": [
            {
                "accountNumber": "135888",
                "ibx": [
                    "DE2"
                ]
            }
        ],
        "meteredPower": [
            {
                "accountNumber": "135888",
                "ibx": [
                    "DE2"
                ]
            }
        ],
        "systemAlert": [
            {
                "accountNumber": "135888",
                "ibx": [
                    "DE2"
                ]
            }
        ],
        "customAlert": [
            {
                "accountNumber": "135888",
                "ibx": [
                    "DE2"
                ],
                "user": "abc"
            }
        ]
    },
    "channel": {
        "channelType": "AWS_IOT_CORE",
        "awsIotCoreChannelConfiguration": {
            "url": "https://b4c3mzxe8syvhd-ats.iot.us-west-2.amazonaws.com"
        }
    }
}' 

Path parameters

ParameterDescription
id string
REQUIRED		Subscription identifier.
Example: 606349eca6171829c70d8777

Body parameters

Parameter
Description
messageType object
REQUIRED
Message type for the subscription that defines the IBX details from which to expect events
asset array[object]<br/OPTIONAL
List of asset message type to subscribe.
accountNumber string
REQUIRED
Customer account number.
Example: 135888
ibx array[string]
REQUIRED
IBX data center identifier.
Example: DE2
assetClassification array[string]
OPTIONAL
Classification of assets - Asset Classification value if specified, otherwise all allowable classifications.
Applicable values:
  • ELECTRICAL
  • MECHANICAL
  • ENVIRONMENTAL
assetId array[string]
OPTIONAL
Asset identifier.
environmental array[object]
OPTIONAL
List of environmental type events to subscribe.
accountNumber string
REQUIRED
Customer account number.
Example: 135888
ibx string
REQUIRED
IBX data center identifier.
Example: DE2
level string
OPTIONAL
If not provided in the request, subscription includes all environmental messages at the IBX, zone, and cage levels.
Applicable values:
  • IBX
  • ZONE
  • CAGE
power array[object]
OPTIONAL
List of power message type to subscribe.
accountNumber string
REQUIRED
Customer account number.
Example: 135888
ibx array[string]
REQUIRED
IBX data center identifier.
Example: DE2
meteredPower array[object]
OPTIONAL
Metered power type messages subscription.
accountNumber string
REQUIRED
Customer account number.
Example: 135888
ibx array[string]
REQUIRED
IBX data center identifier.
Example: DE2
systemAlert array[object]
OPTIONAL
List of system alert type events to subscribe.
accountNumber string
REQUIRED
Customer account number.
Example: 135888
ibx array[string]
REQUIRED
IBX data center identifier.
Example: DE2
customAlert array[object]
OPTIONAL
List of custom alert type events to subscribe.
accountNumber string
REQUIRED
Customer account number.
Example: 135888
ibx array[string]
REQUIRED
IBX data center identifier.
Example: DE2
user string
OPTIONAL
User associated with the subscription.
Example: JohnDoe
channel object
OPTIONAL
Defines the event messages destination.
channelType string
REQUIRED
Type of communication channel used for the subscription.
Applicable values:
  • AWS_IOT_CORE
  • AZURE
  • WEBHOOK
  • REST
AWS IoT Core
awsIotCoreChannelConfiguration object
OPTIONAL
AWS IoT Core channel configuration.
url string
REQUIRED
AWS IoT Core device endpoint URL.
Example: https://b4c3mzxe8syvhd-ats.iot.us-west-2.amazonaws.com
Webhooks
webhookChannelConfiguration object
OPTIONAL
Webhook channel configuration.
sslCertificate string
OPTIONAL
Base64 form of client public certificate chain in PEM format.
Example: ZkFzZLY1IGRpY31kZXI
url string
REQUIRED
Webhook endpoint url.
Example: https://client/event/endpoint
numberOfRetries integer
OPTIONAL
Number of times the subscription tries to send a message until it's marked as Retried (no longer near real-time). Our system attempts to resend the message later and if the destination remains unreachable, the message is moved to DLQ.
Applicable values: [1..5]
Default value: 3
numberOfConcurrentCalls integer
OPTIONAL
Upper bound of concurrent workers sending messages to the given url.
Applicable values: [20..50]
Default value: 25
batchSize integer
OPTIONAL
Upper (soft) bound for number of messages in a single payload.
Applicable values: [5..20]
Default value: 10
Microsoft Azure

For Microsoft Azure channel configuration, contact Equinix Service Desk.

REST
restChannelConfiguration object
REST channel configuration.
 

If you get “Access Denied” error, contact your local Equinix Service Desk for Equinix Smart View portal access.

Delete Subscription​

 DELETE /smartview/v2/streaming/subscriptions/{id}
MethodDELETE
URL or Endpoint/smartview/v2/streaming/subscriptions/{id}
HeadersAuthorization
Path Parametersid
Query ParametersNot applicable
Body ParametersNot applicable

This API request deletes a given streaming subscription. Events will no longer be available for the subscription once a delete request is received.

 

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

Sample curl request

curl -X 
DELETE 'https://api.equinix.com/smartview/v2/streaming/subscriptions/606349eca6171829c70d8777'
-H 'authorization: Bearer asxQMSbBwcNzI2fCCNwSwTh3phV2'

Path parameters

ParameterDescription
id string
REQUIRED		Subscription identifier.
Example: 606349eca6171829c70d8777
 

If you get “Access Denied” error, contact your local Equinix Service Desk for Equinix Smart View portal access.