Equinix Fabric API v4 | Equinix Product Documentation

Streams

Operations

Create Stream

Request

This API provides capability to create user's stream

Security

BearerAuth

Bodyapplication/jsonrequired

typestringrequired

Value:"TELEMETRY_STREAM"

namestringrequired

Customer-provided stream name

descriptionstring

Customer-provided stream description

projectobject(Project)required

accountobject(SimplifiedAccount)

notificationsArray of objects, <= 1 items(SimplifiedNotification)

Preferences for stream notifications. Optional; at most one entry, of type ALL, with up to 12 emails. Set at creation only.

Payload

{
  "type": "TELEMETRY_STREAM",
  "name": "splunk1",
  "description": "subscription-1",
  "project": {
    "projectId": "dadd3ab6-c0af-430c-8216-43d44f08c1c5"
  },
  "account": {
    "accountNumber": 123456
  },
  "notifications": [
    { … }
  ]
}

Responses

Stream object

Bodyapplication/json

hrefstring, (uri)read-only

Stream URI

Example:"https://api.equinix.com/fabric/v4/streams/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170"

uuidstring, (uuid)

Equinix-assigned access point identifier

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

typestring

type

Value:"TELEMETRY_STREAM"

namestring

Customer-provided stream name

descriptionstring

Customer-provided stream description

projectobject(Project)

accountobject(SimplifiedAccount)

notificationsArray of objects(SimplifiedNotification)

Preferences for stream notifications, set at creation

statestring

Stream provision state

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

assetsCountinteger

Stream assets count

Example:1

streamSubscriptionsCountinteger

Stream subscriptions count

Example:2

alertRulesCountinteger

Stream alert rules count

Example:3

changeLogobject(Changelog)

Change log

Response

{
  "href": "https://api.equinix.com/fabric/v4/streams/d684aa26-8276-48b7-bb42-a6d9def0a418",
  "uuid": "d684aa26-8276-48b7-bb42-a6d9def0a418",
  "type": "TELEMETRY_STREAM",
  "name": "stream1",
  "description": "stream 1",
  "project": {
    "projectId": "dadd3ab6-c0af-430c-8216-43d44f08c1c5"
  },
  "account": {
    "accountNumber": 123456
  },
  "notifications": [
    { … }
  ],
  "state": "PROVISIONED",
  "assetsCount": 1,
  "streamSubscriptionsCount": 2,
  "alertRulesCount": 3,
  "changeLog": {
    "createdDateTime": "2024-05-06T16:21:18.545214Z"
  }
}