v1

latestOpenAPI 3.1.02026-07-245531,0212.1 MB

Alerts

List backup failure alerts

ListAlerts returns a list of backup failure alerts with generic details, resource details, failed job IDs and the last successful job timestamp, if applicable

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

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

failureNumberSinceLastSuccessinteger

Once this parameter is specified, the API returns the nth alert (where n is the value of this parameter) in the sequence since the last successful backup job, provided it lies within the time window bound by the minGeneratedOn and maxGeneratedOn. If the time window is not specified, the minGeneratedOn gets the default value as the timestamp of the last successful backup job and maxGeneratedOn gets the default value as the current time. In addition, the alert details also include the list of consecutively failed backup job IDs and the timestamp of the last successful backup job.

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",
      "alertDetails": {
        "jobID": 1,
        "jobStartTime": "2019-07-08T03:38:22.000Z",
        "jobEndTime": "2019-07-08T05:52:36.000Z",
        "jobErrorMsg": "error message",
        "failedJobIDs": [
          1
        ],
        "lastSucceeded": "2019-07-05T03:38:22.000Z"
      },
      "resourceInfo": {
        "fsServerName": "serverName",
        "fsContentRule": "contentRule",
        "nasShare": "sharename",
        "sqlResourceType": "instance",
        "sqlResourceName": "instanceName",
        "sqlContentRule": "contentRule",
        "oracleMountPoint": "mountPoint",
        "oraclePBS": "deviceName",
        "vmName": "vmName"
      }
    }
  ]
}