Equinix SmartView APIs | Equinix Product Documentation

Retrieve subscription by ID

Request

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

Security

BearerAuth

Path

idstringrequired

Payload

// No request payload

Responses

OK

Bodyapplication/json

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": {
    "asset": [ … ],
    "environmental": [ … ],
    "power": [ … ],
    "meteredPower": [ … ],
    "systemAlert": [ … ],
    "customAlert": [ … ]
  },
  "channel": {
    "channelType": "AWS_IOT_CORE",
    "awsIotCoreChannelConfiguration": { … },
    "webhookChannelConfiguration": { … },
    "azureChannelConfiguration": { … }
  },
  "orgId": "string",
  "createdBy": "string",
  "createdDateTime": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "updatedDateTime": "2019-08-24T14:15:22Z"
}