Equinix SmartView APIs | Equinix Product Documentation

Create a power alert configuration

Request

Creates a new power alert configuration for the specified account and IBX. The configuration defines the condition (event type and threshold) that triggers an alert and the list of recipients to be notified via email, SMS or API Subscription.

Assets can be scoped at the CAGE, CABINET, or CIRCUIT level.

Security

BearerAuth

Bodyapplication/jsonrequired

Request body for creating a power alert configuration

accountNostringrequired

Customer account number

Example:"123456"

ibxstringrequired

IBX code where the alert should be monitored

Example:"SV5"

sectionstringrequired

Section type for the alert. Use POWER for power-related alerts.

Example:"POWER"

conditionobject(PowerAlertCondition)required

Defines the condition that triggers a power alert

recipientsArray of objects(PowerAlertRecipient)required

List of recipients to be notified when the alert condition is met

assetsobject

Assets to monitor, scoped by level type (CAGE, CABINET, CIRCUIT)

Payload

{
  "accountNo": "123456",
  "ibx": "SV5",
  "section": "POWER",
  "condition": {
    "conditionType": "EXCEEDS",
    "eventType": "CAGE_DRAW",
    "threshold": { … }
  },
  "recipients": [
    { … }
  ],
  "assets": {
    "CAGE": [ … ]
  }
}

Responses

Configuration created successfully

Bodyapplication/json

alertConfigurationUidstring, (uuid)

Unique identifier of the newly created power alert configuration

Example:"9756a585-c3c1-4648-b2e1-7d8804912098"

Response

{
  "alertConfigurationUid": "9756a585-c3c1-4648-b2e1-7d8804912098"
}