Equinix SmartView APIs | Equinix Product Documentation

Streaming Subscription API

IBX SmartView's subscription API allows users to subscribe to near real-time message feeds for events occurring within an IBX. Users can specify the types of messages to receive for each IBX. Users are able to view all subscriptions within their organization and update any subscription to modify the message feed being received.

Operations

Retrieve all subscriptions

Request

This endpoint allows users to fetch details for all streaming subscriptions for a given organization.

Security

BearerAuth

Payload

// No request payload

Responses

Bodyapplication/json

Array [

idstring

statusstring

Enum:"PENDING""ACTIVE""FAILED""DELETE_IN_PROGRESS""DELETED"

messageTypeobject(MessageType)

Message type for a given subscription

channelobject(Channel)

Subscription can be created using one channel.

orgIdstring

createdBystring

createdDateTimestring, (date-time)

updatedBystring

updatedDateTimestring, (date-time)

]

Response

[
  {
    "id": "string",
    "status": "PENDING",
    "messageType": { … },
    "channel": { … },
    "orgId": "string",
    "createdBy": "string",
    "createdDateTime": "2019-08-24T14:15:22Z",
    "updatedBy": "string",
    "updatedDateTime": "2019-08-24T14:15:22Z"
  }
]