Equinix Fabric API v4 | Equinix Product Documentation

Create Subscription

Request

This API provides capability to create user's Stream Subscriptions

Security

BearerAuth

Path

streamIdstring, (uuid)required

Stream UUID

Example:657400f8-d360-11e9-bb65-2a2ae2dbcce5

Bodyapplication/jsonrequired

typestringrequired

Value:"STREAM_SUBSCRIPTION"

namestringrequired

Customer-provided stream subscription name

descriptionstring

Customer-provided stream subscription description

enabledboolean

Stream subscription enabled status

Default:true

Example:true

metricSelectorobject(StreamSubscriptionSelector)

eventSelectorobject(StreamSubscriptionSelector)

sinkobject(StreamSubscriptionSink)required

Create Stream destination

Payload

{
  "type": "STREAM_SUBSCRIPTION",
  "name": "splunk1",
  "description": "subscription-1",
  "enabled": true,
  "sink": {
    "uri": "https://http-inputs-<host>.splunkcloud.com:<port>/services/collector/event",
    "type": "SPLUNK_HEC",
    "credential": { … },
    "settings": { … }
  }
}

Responses

Stream Subscription object

Bodyapplication/json

hrefstring, (uri)read-only

Stream Subscription URI

Example:"https://api.equinix.com/fabric/v4/streams/d684aa26-8276-48b7-bb42-a6d9def0a418/subscriptions/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170"

uuidstring, (uuid)

Equinix-assigned access point identifier

Example:"c9b8e7a2-f3b1-4576-a4a9-1366a63df170"

typestring

type

Value:"STREAM_SUBSCRIPTION"

namestring

Customer-provided subscription name

descriptionstring

Customer-provided subscription description

statestring

Steam subscription provision state

Enum:"PROVISIONING""PROVISIONED""REPROVISIONING""DEPROVISIONING""DEPROVISIONED""FAILED"

enabledboolean

Stream subscription enabled status

metricSelectorobject(StreamSubscriptionSelector)

eventSelectorobject(StreamSubscriptionSelector)

sinkobject(StreamSubscriptionSinkResponse)

Create Stream destination

operationobject(StreamSubscriptionOperation)

Stream subscription operational information

changeLogobject(Changelog)

Change log

Response

{
  "href": "https://api.equinix.com/fabric/v4/streams/d684aa26-8276-48b7-bb42-a6d9def0a418/subscriptions/d684aa26-8276-48b7-bb42-a6d9def0a418",
  "uuid": "d684aa26-8276-48b7-bb42-a6d9def0a418",
  "type": "STREAM_SUBSCRIPTION",
  "name": "stream 1",
  "description": "stream dec 1",
  "state": "PROVISIONED",
  "enabled": true,
  "metricSelector": {
    "include": [ … ]
  },
  "eventSelector": {
    "include": [ … ]
  },
  "sink": {
    "uri": "https://http-inputs-<host>.splunkcloud.com:<port>/services/collector/event",
    "type": "SPLUNK_HEC",
    "credential": { … },
    "settings": { … },
    "batchEnabled": false,
    "batchSizeMax": 50,
    "batchWaitTimeMax": 5
  },
  "operation": {
    "eventsDeliveredCount": 0,
    "metricsDeliveredCount": 0,
    "alertsDeliveredCount": 0,
    "errors": []
  },
  "changeLog": {
    "createdDateTime": "2024-05-06T16:21:18.545214Z"
  }
}