Endpoint
/api/v2/tenants/{tenantId}/alerts/search
Path Parameters
tenantId
string

Describes the client ID or msp ID of the tenant

Query Parameters
pageNo
integer

{pageNo}

pageSize
integer

{pageSize}

isDescendingOrder
boolean

{true/false}

sortName
string

{field}

queryString
string

{queryString}

viewID
string

statusHistory
string

Responses

OK

descendingOrder
boolean

nextPage
boolean

orderBy
string

pageNo
integer

pageSize
integer

previousPageNo
integer

results
object

results.acknowledged
results.actedTs
results.alertTime
results.alertType
results.clientUniqueId
results.closed
results.createdDate
results.currentState
results.device
results.elapsedTimeString
results.eventType
results.inferenceId
results.managedByOpsRamp
results.metric
results.permanentlySuppressed
results.priority
results.rba
results.repeatCount
results.resource
results.serviceName
results.status
results.statusHistory
results.subject
results.suppressed
results.tenantId
results.tenantName
results.ticketed
results.uniqueId
results.updatedTime
totalPages
integer

totalResults
integer

{
  "descendingOrder": true,
  "nextPage": false,
  "orderBy": "ts",
  "pageNo": 1,
  "pageSize": 4,
  "previousPageNo": 0,
  "results": [
    {
      "acknowledged": false,
      "actedTs": 0,
      "alertTime": "2016-02-24T01:10:00+0000",
      "alertType": "Monitoring",
      "clientUniqueId": "client_593972",
      "closed": false,
      "createdDate": "2016-02-24T01:15:00+0000",
      "currentState": "Info",
      "device": {
        "aliasName": "",
        "hostName": "",
        "id": "018e9cc1-e7ec-4833-a2b7-e17bd41e1b68",
        "ipAddress": "172.31.17.109",
        "name": "172.31.17.109",
        "resourceName": "172.31.17.109",
        "resourceType": "Linux",
        "type": "DEVICE"
      },
      "elapsedTimeString": "4d 22h 21m ",
      "eventType": "ALERT",
      "inferenceId": 0,
      "managedByOpsRamp": false,
      "metric": "Windows Event Log",
      "permanentlySuppressed": false,
      "priority": "N/A",
      "rba": false,
      "repeatCount": "1",
      "resource": {
        "aliasName": "",
        "clientId": 0,
        "consoles": [],
        "days": 0,
        "deleted": false,
        "encrypted": false,
        "frequency": 0,
        "hostName": "",
        "id": "018e9cc1-e7ec-4833-a2b7-e17bd41e1b68",
        "ipAddress": "172.31.17.109",
        "locationOffset": 0,
        "name": "172.31.17.109",
        "paused": false,
        "port": 0,
        "receiverHostPort": 0,
        "resourceName": "172.31.17.109",
        "resourceType": "Linux",
        "timeout": 0,
        "totalLocations": 0,
        "ts": 0,
        "type": "Linux",
        "validateSSL": false
      },
      "serviceName": "Windows Event Log",
      "status": "New",
      "statusHistory": {
        "createdBy": "system",
        "createdTime": "2016-02-24T01:15:00+0000"
      },
      "subject": "Testing Alert-2-info state",
      "suppressed": false,
      "tenantId": 593972,
      "tenantName": "Client_Test",
      "ticketed": false,
      "uniqueId": "389547",
      "updatedTime": "2016-02-24T09:19:47+0000"
    },
    {
      "acknowledged": false,
      "actedTs": 0,
      "alertTime": "2016-02-24T01:00:00+0000",
      "alertType": "Monitoring",
      "clientUniqueId": "client_593972",
      "closed": false,
      "createdDate": "2016-02-24T01:15:00+0000",
      "currentState": "Info",
      "device": {
        "aliasName": "",
        "hostName": "",
        "id": "e3ef168f-dbb7-43f6-ad6a-c052a85be34f",
        "ipAddress": "",
        "name": "abc",
        "resourceName": "abc",
        "resourceType": "Desktop",
        "type": "DEVICE"
      },
      "elapsedTimeString": "4d 22h 21m ",
      "eventType": "ALERT",
      "inferenceId": 0,
      "managedByOpsRamp": false,
      "metric": "Windows Event Log",
      "permanentlySuppressed": false,
      "priority": "N/A",
      "rba": false,
      "repeatCount": "1",
      "resource": {
        "aliasName": "",
        "clientId": 0,
        "consoles": [],
        "days": 0,
        "deleted": false,
        "encrypted": false,
        "frequency": 0,
        "hostName": "",
        "id": "e3ef168f-dbb7-43f6-ad6a-c052a85be34f",
        "ipAddress": "",
        "locationOffset": 0,
        "name": "abc",
        "paused": false,
        "port": 0,
        "receiverHostPort": 0,
        "resourceName": "abc",
        "resourceType": "Desktop",
        "timeout": 0,
        "totalLocations": 0,
        "ts": 0,
        "type": "Desktop",
        "validateSSL": false
      },
      "serviceName": "Windows Event Log",
      "status": "New",
      "statusHistory": {
        "createdBy": "system",
        "createdTime": "2016-02-24T01:15:00+0000"
      },
      "subject": "Testing Alert-1-info state",
      "suppressed": false,
      "tenantId": 593972,
      "tenantName": "Client_Test",
      "ticketed": false,
      "uniqueId": "389548",
      "updatedTime": "2016-02-24T09:19:47+0000"
    },
    {
      "acknowledged": false,
      "actedTs": 0,
      "alertTime": "2016-02-24T02:20:00+0000",
      "alertType": "Monitoring",
      "clientUniqueId": "client_593972",
      "closed": false,
      "createdDate": "2016-02-24T02:50:00+0000",
      "currentState": "Info",
      "device": {
        "aliasName": "",
        "hostName": "0800270B9A7A",
        "id": "34b9b0f8-66df-4681-809e-dfd06fff3fa6",
        "ipAddress": "172.24.132.131",
        "name": "0800270B9A7A",
        "resourceName": "",
        "resourceType": "OpsRamp Gateway",
        "type": "DEVICE"
      },
      "elapsedTimeString": "4d 22h 21m ",
      "eventType": "ALERT",
      "inferenceId": 0,
      "managedByOpsRamp": false,
      "metric": "Windows Event Log",
      "permanentlySuppressed": false,
      "priority": "N/A",
      "rba": false,
      "repeatCount": "1",
      "resource": {
        "aliasName": "",
        "clientId": 0,
        "consoles": [],
        "days": 0,
        "deleted": false,
        "encrypted": false,
        "frequency": 0,
        "hostName": "0800270B9A7A",
        "id": "34b9b0f8-66df-4681-809e-dfd06fff3fa6",
        "ipAddress": "172.24.132.131",
        "locationOffset": 0,
        "name": "0800270B9A7A",
        "paused": false,
        "port": 0,
        "receiverHostPort": 0,
        "resourceName": "",
        "resourceType": "OpsRamp Gateway",
        "timeout": 0,
        "totalLocations": 0,
        "ts": 0,
        "type": "OpsRamp Gateway",
        "validateSSL": false
      },
      "serviceName": "Windows Event Log",
      "status": "New",
      "statusHistory": {
        "createdBy": "system",
        "createdTime": "2016-02-24T01:15:00+0000"
      },
      "subject": "Testing Alert-3-info state",
      "suppressed": false,
      "tenantId": 593972,
      "tenantName": "Client_Test",
      "ticketed": false,
      "uniqueId": "389546",
      "updatedTime": "2016-02-24T09:19:47+0000"
    }
  ],
  "totalPages": 1,
  "totalResults": 3
}