Equinix Fabric API v4 | Equinix Product Documentation

Create Stream Alert Rule

Request

This API provides capability to create user's Stream Alert Rules

Security

BearerAuth

Path

streamIdstring, (uuid)required

Stream UUID

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

Bodyapplication/jsonrequired

typestringrequired

Value:"METRIC_ALERT"

namestringrequired

Customer-provided stream name

descriptionstring

Customer-provided stream description

enabledboolean

Stream alert rule enabled status

Default:true

Example:true

metricSelectorobject(MetricSelector)required

resourceSelectorobject(ResourceSelector)required

detectionMethodobject(DetectionMethod)required

Payload

{
  "name": "metric-alert-1",
  "type": "METRIC_ALERT",
  "description": "metric-alert-1",
  "enabled": true,
  "metricSelector": {
    "include": [ … ]
  },
  "resourceSelector": {
    "include": [ … ]
  },
  "detectionMethod": {
    "type": "THRESHOLD",
    "windowSize": "PT15M",
    "warningThreshold": "35000000",
    "criticalThreshold": "45000000"
  }
}

Responses

Stream Alert Rules object

Bodyapplication/json

hrefstring, (uri)read-only

Stream Alert Rule URI

uuidstring, (uuid)

Equinix-assigned access point identifier

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

typestring

Stream subscription type

Value:"METRIC_ALERT"

namestring

Customer-provided stream alert rule name

descriptionstring

Customer-provided stream alert rule description

statestring

Steam subscription provision state

Enum:"ACTIVE""INACTIVE"

enabledboolean

Stream alert rule enabled status

Default:true

metricSelectorobject(MetricSelectorResponse)

resourceSelectorobject(ResourceSelectorResponse)

detectionMethodobject(DetectionMethodResponse)

changeLogobject(Changelog)

Change log

Response

{
  "href": "https://api.equinix.com/fabric/v4/streams/d684aa26-8276-48b7-bb42-a6d9def0a418/alertRules/0bbcea48-1333-4ad5-a7ea-e4d58a5fbd15",
  "uuid": "0bbcea48-1333-4ad5-a7ea-e4d58a5fbd15",
  "type": "METRIC_ALERT",
  "name": "metric-alert-1",
  "description": "metric-alert-1",
  "state": "ACTIVE",
  "enabled": true,
  "metricSelector": {
    "include": [ … ]
  },
  "resourceSelector": {
    "include": [ … ]
  },
  "detectionMethod": {
    "type": "THRESHOLD",
    "windowSize": "PT15M",
    "operand": "ABOVE",
    "warningThreshold": "35000000",
    "criticalThreshold": "45000000"
  },
  "changeLog": {
    "createdBy": "user",
    "createdDateTime": "2024-05-06T16:21:18.545214Z",
    "updatedBy": "user",
    "updatedDateTime": "2025-02-04T00:20:54.511118575Z"
  }
}