v1

latestOpenAPI 3.1.02026-07-245531,0212.1 MB

Alerts

List of Alerts

Returns a paginated list of all alerts

get/alerts/v1/orgs/{OrgID}/alerts

Path parameters

OrgIDinteger required

Specify the organization ID of your organization. Set it to "0" to select all organizations. Get the ID of an organization using the 'List all organizations' API.

Query parameters

workloadTypestring

Specify the type of the workload for which you want to see the alerts. This parameter can be set to one of the following values: fs, sql, nas, hyperv, vmware, or oracle.

minGeneratedOnstring

Specify the lower bound value of the time window. The time should be specified in the UTC format and must be greater than the value of (current time - 6 months). The format of this parameter is YYYY-MM-DDTHH:MM:SSZ.

maxGeneratedOnstring

Specify the upper bound value of the time window. The time should be specified in the UTC format and must be greater than the value of (current time - 6 months). The format of this parameter is YYYY-MM-DDTHH:MM:SSZ.

resourceTypestring

Specify the type of the resource. This parameter can be set to one of the following values: physicalServer, vmwareVM, hyperVM, nasShare, sqlAvailabilityGroup, sqlStandaloneInstance, or oracle.

resourceIDinteger

Specify the resource ID of the resource.

pageTokenstring

Specify the token to access the next page of results. Keep this field blank in the first request. Use the token value received in the previous response's parameter 'nextPageToken'.

Response

Result schema for 200 Response of GET ListAlerts

nextPageTokenstring

Example response

{
  "alerts": [
    {
      "id": 1,
      "type": "jobs",
      "subtype": "backupFailures",
      "generatedOn": "2019-07-09T05:08:16Z",
      "OrgID": 1,
      "workloadType": "vmware",
      "targetType": "jobs",
      "targetID": 1,
      "resourceType": "device",
      "resourceName": "hostname",
      "status": "active",
      "resolutionTime": "NA",
      "severity": "critical"
    }
  ]
}