Equinix SmartView APIs | Equinix Product Documentation

System alerts search

This endpoint returns all system alerts in a paginated way allows narrowing returned results by submitting additional search filters.

Allowed search filters:

Property	Operator	Description
/status	=, IN	Alert status, INACTIVE or ACTIVE
/assetTagUid	=, IN	Asset tag point unique id, example: PA8A.CB-CRITICAL-DB2:tripped
/assetTagDisplayName	=, IN	Active tag reading display value, example: ALARM
/configuration/thresholdType	=, IN	Example: DIGITAL
/configuration/conditionName	=, IN	Name given to the alarm condition. Example: ALARM
/asset/ibx	=, IN	Name of the IBX for which data is being requested, example: PA8A
/asset/assetUid	=, IN, LIKE	Asset unique ID, example: PA8A.CB-CRITICAL-DB2:tripped#DIGITAL:ALARM
/activeProcessing/edgeCollectedOn	=, >=, <=	When tag reading was collected on source, example: 2022-09-23T13:40:53.449276Z
/asset/assetUnderMaintenance	=, IN	Asset was under maintenance during alert processing, example: false
/asset/assetType	=, IN	Indicates the template name for the asset, example: Circuit Breaker with Metering
/asset/assetClassification	=, IN	The class of assets this asset belongs to. Asset classification is electrical or mechanical, example: Electrical

Allowed search request sort options:

Security

BearerAuth

Bodyapplication/jsonrequired

filterobject(SearchFilter)

paginationobject(SearchPagination)

sortArray of objects(SearchSort)

Array of sorting conditions.

Payload

{
  "filter": {
    "and": [ … ]
  },
  "pagination": {
    "offset": 0,
    "limit": 50
  }
}

OK

Bodyapplication/json

dataArray of objects(AlertReadModel)

Array of the alerts.

paginationobject(Pagination)

Represents pagination component of the paginated response

Response

{
  "data": [
    { … }
  ],
  "pagination": {
    "offset": 0,
    "limit": 0,
    "total": 0,
    "next": "string",
    "previous": "string"
  }
}