Equinix SmartView APIs | Equinix Product Documentation

DCIM System Alert

Empower yourself with IBX SmartView System Alert APIs to access information on the alarms, now \nknown as system alerts. Given a multiple criteria, this API retrieves all the system alerts.\nWe recommend customers utilize the POST call, however both calls are supported and functional.

Operations

System alerts search

Request

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

Allowed search filters.

Security

BearerAuth

Query

limitintegerrequired

Number of records to retrieve per request.

Example:limit=100

offsetintegerrequired

Record Number you want start to retrieve from (0..N)

Example:offset=0

statusstring

Alert status - ACTIVE or INACTIVE

Example:status=ACTIVE

assetClassificationstring

The class of assets this asset belongs to - Mechanical/Electrical/Environmental

Example:assetClassification=Mechanical

edgeCollectedOnstring

Returns the alarms after the passed time

Example:edgeCollectedOn=2023-11-30T05:08:39.345Z

Payload

// No request payload

Responses

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"
  }
}