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
array

results.acknowledged
results.actedTs
results.alertTime
results.alertType
results.app
results.availability
results.clientTechnology
results.clientUniqueId
results.closed
results.component
results.createdDate
results.currentState
results.customFields
results.description
results.device
results.elapsedTimeString
results.entityType
results.eventType
results.extAlertId
results.ignoreRecoveryNoise
results.inferenceAlert
results.inferenceId
results.isRecoveryAlert
results.managedByOpsRamp
results.metric
results.metricTime
results.monitorName
results.mspName
results.oldState
results.permanentlySuppressed
results.priority
results.problemArea
results.rba
results.repeatCount
results.resource
results.rtype
results.serviceName
results.snoozeDuration
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": 100,
  "previousPageNo": 0,
  "results": [
    {
      "acknowledged": false,
      "actedTs": 0,
      "alertTime": "2021-07-24T17:19:12+0000",
      "alertType": "Monitoring",
      "app": "OpsRamp",
      "availability": false,
      "clientTechnology": "OpsRamp",
      "clientUniqueId": "client_22568",
      "closed": false,
      "component": "C",
      "createdDate": "2021-07-24T17:19:13+0000",
      "currentState": "Critical",
      "customFields": [],
      "device": {
        "aliasName": "",
        "hostName": "jmeter-pv-us-ctl-vm01",
        "id": "9297503",
        "ipAddress": "",
        "name": "jmeter-pv-us-ctl-vm01",
        "resourceName": "",
        "resourceType": "Other",
        "type": "DEVICE"
      },
      "elapsedTimeString": "59m ",
      "entityType": "RESOURCE",
      "eventType": "ALERT",
      "extAlertId": "",
      "ignoreRecoveryNoise": false,
      "inferenceAlert": false,
      "inferenceId": 0,
      "isRecoveryAlert": false,
      "managedByOpsRamp": false,
      "metric": "Network2",
      "metricTime": 0,
      "monitorName": "Network2",
      "mspName": "SQALab",
      "permanentlySuppressed": false,
      "priority": "N/A",
      "problemArea": "Network2",
      "rba": false,
      "repeatCount": "2",
      "resource": {
        "agentInstalled": false,
        "aliasName": "",
        "alternateIp": "",
        "clientId": 0,
        "clientUniqueId": "client_22568",
        "cloudInstance": false,
        "consoles": [],
        "deleted": false,
        "description": "",
        "device": false,
        "dns": "",
        "encrypted": false,
        "excludeIndexing": false,
        "frequency": 0,
        "generalInfo": {
          "aliasName": "",
          "assetManagedTime": "2021-05-23T13:39:12+0000",
          "createdTime": "2021-05-23T13:39:12+0000",
          "firstAssetManagedTime": "2021-05-23T13:39:12+0000",
          "hostName": "jmeter-pv-us-ctl-vm01",
          "name": "jmeter-pv-us-ctl-vm01",
          "resourceName": "",
          "resourcePath": "Other",
          "resourceType": "Other",
          "updatedTime": ""
        },
        "hostName": "jmeter-pv-us-ctl-vm01",
        "id": "336a5197-c8d8-46d0-9953-ebf95dd8046b",
        "ipAddress": "",
        "locationOffset": 0,
        "make": "",
        "name": "jmeter-pv-us-ctl-vm01",
        "osName": "",
        "paused": false,
        "port": 0,
        "receiverHostPort": 0,
        "resourceName": "",
        "resourcePath": "Other",
        "resourceType": "Other",
        "saId": 0,
        "source": "ALERT",
        "state": "active",
        "status": "UNDEFINED",
        "tags": [],
        "timeout": 0,
        "topologyEnabled": false,
        "totalLocations": 0,
        "ts": 0,
        "type": "Other",
        "validateSSL": false
      },
      "rtype": "RESOURCE",
      "serviceName": "Network2",
      "snoozeDuration": 0,
      "status": "New",
      "statusHistory": {
        "createdBy": "system",
        "createdTime": "2021-07-24T17:19:13+0000"
      },
      "subject": "workflow alert Validation For Maintenance schedule Using JM-vas",
      "suppressed": false,
      "tenantId": 22568,
      "tenantName": "JMClient1605551845209",
      "ticketed": false,
      "uniqueId": "122620538",
      "updatedTime": "2021-07-24T17:40:01+0000"
    },
    {
      "acknowledged": false,
      "actedTs": 0,
      "alertTime": "2021-07-24T17:09:07+0000",
      "alertType": "Monitoring",
      "app": "OpsRamp",
      "availability": false,
      "clientTechnology": "OpsRamp",
      "clientUniqueId": "client_22568",
      "closed": false,
      "component": "MEMORY",
      "createdDate": "2021-07-24T17:09:07+0000",
      "currentState": "Critical",
      "customFields": [],
      "device": {
        "aliasName": "",
        "hostName": "jmeter-pv-us-ctl-vm01",
        "id": "9297503",
        "ipAddress": "",
        "name": "jmeter-pv-us-ctl-vm01",
        "resourceName": "",
        "resourceType": "Other",
        "type": "DEVICE"
      },
      "elapsedTimeString": "1h 9m ",
      "entityType": "RESOURCE",
      "eventType": "ALERT",
      "extAlertId": "",
      "ignoreRecoveryNoise": false,
      "inferenceAlert": false,
      "inferenceId": 0,
      "isRecoveryAlert": false,
      "managedByOpsRamp": false,
      "metric": "MEMORY",
      "metricTime": 0,
      "monitorName": "MEMORY",
      "mspName": "SQALab",
      "permanentlySuppressed": false,
      "priority": "N/A",
      "problemArea": "MEMORY",
      "rba": false,
      "repeatCount": "1",
      "resource": {
        "agentInstalled": false,
        "aliasName": "",
        "alternateIp": "",
        "clientId": 0,
        "clientUniqueId": "client_22568",
        "cloudInstance": false,
        "consoles": [],
        "deleted": false,
        "description": "",
        "device": false,
        "dns": "",
        "encrypted": false,
        "excludeIndexing": false,
        "frequency": 0,
        "generalInfo": {
          "aliasName": "",
          "assetManagedTime": "2021-05-23T13:39:12+0000",
          "createdTime": "2021-05-23T13:39:12+0000",
          "firstAssetManagedTime": "2021-05-23T13:39:12+0000",
          "hostName": "jmeter-pv-us-ctl-vm01",
          "name": "jmeter-pv-us-ctl-vm01",
          "resourceName": "",
          "resourcePath": "Other",
          "resourceType": "Other",
          "updatedTime": ""
        },
        "hostName": "jmeter-pv-us-ctl-vm01",
        "id": "336a5197-c8d8-46d0-9953-ebf95dd8046b",
        "ipAddress": "",
        "locationOffset": 0,
        "make": "",
        "name": "jmeter-pv-us-ctl-vm01",
        "osName": "",
        "paused": false,
        "port": 0,
        "receiverHostPort": 0,
        "resourceName": "",
        "resourcePath": "Other",
        "resourceType": "Other",
        "saId": 0,
        "source": "ALERT",
        "state": "active",
        "status": "UNDEFINED",
        "tags": [],
        "timeout": 0,
        "topologyEnabled": false,
        "totalLocations": 0,
        "ts": 0,
        "type": "Other",
        "validateSSL": false
      },
      "rtype": "RESOURCE",
      "serviceName": "MEMORY",
      "snoozeDuration": 0,
      "status": "New",
      "statusHistory": {
        "createdBy": "system",
        "createdTime": "2021-07-24T17:09:07+0000"
      },
      "subject": "The Physical Memory Usage on the device is 56%.The Virtual Memory Usage on the device is 43%.",
      "suppressed": false,
      "tenantId": 22568,
      "tenantName": "JMClient1605551845209",
      "ticketed": false,
      "uniqueId": "122620193",
      "updatedTime": "2021-07-24T17:09:07+0000"
    },
    {
      "acknowledged": false,
      "actedTs": 0,
      "alertTime": "2021-05-23T13:39:11+0000",
      "alertType": "Monitoring",
      "app": "OpsRamp",
      "availability": false,
      "clientTechnology": "OpsRamp",
      "clientUniqueId": "client_22568",
      "closed": false,
      "component": "Test",
      "createdDate": "2021-05-23T13:39:12+0000",
      "currentState": "Critical",
      "customFields": [],
      "device": {
        "aliasName": "",
        "hostName": "jmeter-pv-us-ctl-vm01",
        "id": "9297503",
        "ipAddress": "",
        "name": "jmeter-pv-us-ctl-vm01",
        "resourceName": "",
        "resourceType": "Other",
        "type": "DEVICE"
      },
      "elapsedTimeString": "62d 4h 39m ",
      "entityType": "RESOURCE",
      "eventType": "ALERT",
      "extAlertId": "",
      "ignoreRecoveryNoise": false,
      "inferenceAlert": false,
      "inferenceId": 0,
      "isRecoveryAlert": false,
      "managedByOpsRamp": false,
      "metric": "Network2",
      "metricTime": 0,
      "monitorName": "Network2",
      "mspName": "SQALab",
      "permanentlySuppressed": false,
      "priority": "N/A",
      "problemArea": "Network2",
      "rba": false,
      "repeatCount": "11",
      "resource": {
        "agentInstalled": false,
        "aliasName": "",
        "alternateIp": "",
        "clientId": 0,
        "clientUniqueId": "client_22568",
        "cloudInstance": false,
        "consoles": [],
        "deleted": false,
        "description": "",
        "device": false,
        "dns": "",
        "encrypted": false,
        "excludeIndexing": false,
        "frequency": 0,
        "generalInfo": {
          "aliasName": "",
          "assetManagedTime": "2021-05-23T13:39:12+0000",
          "createdTime": "2021-05-23T13:39:12+0000",
          "firstAssetManagedTime": "2021-05-23T13:39:12+0000",
          "hostName": "jmeter-pv-us-ctl-vm01",
          "name": "jmeter-pv-us-ctl-vm01",
          "resourceName": "",
          "resourcePath": "Other",
          "resourceType": "Other",
          "updatedTime": ""
        },
        "hostName": "jmeter-pv-us-ctl-vm01",
        "id": "336a5197-c8d8-46d0-9953-ebf95dd8046b",
        "ipAddress": "",
        "locationOffset": 0,
        "make": "",
        "name": "jmeter-pv-us-ctl-vm01",
        "osName": "",
        "paused": false,
        "port": 0,
        "receiverHostPort": 0,
        "resourceName": "",
        "resourcePath": "Other",
        "resourceType": "Other",
        "saId": 0,
        "source": "ALERT",
        "state": "active",
        "status": "UNDEFINED",
        "tags": [],
        "timeout": 0,
        "topologyEnabled": false,
        "totalLocations": 0,
        "ts": 0,
        "type": "Other",
        "validateSSL": false
      },
      "rtype": "RESOURCE",
      "serviceName": "Network2",
      "snoozeDuration": 0,
      "status": "New",
      "statusHistory": {
        "createdBy": "system",
        "createdTime": "2021-05-23T13:39:12+0000"
      },
      "subject": "workflow alert Validation For Maintenance schedule Using JM-vas",
      "suppressed": false,
      "tenantId": 22568,
      "tenantName": "JMClient1605551845209",
      "ticketed": false,
      "uniqueId": "117891648",
      "updatedTime": "2021-05-23T16:44:40+0000"
    },
    {
      "acknowledged": false,
      "actedTs": 0,
      "alertTime": "2021-05-23T16:39:58+0000",
      "alertType": "Monitoring",
      "app": "OpsRamp",
      "availability": false,
      "clientTechnology": "OpsRamp",
      "clientUniqueId": "client_22568",
      "closed": false,
      "component": "Test",
      "createdDate": "2021-05-23T16:39:58+0000",
      "currentState": "Critical",
      "customFields": [],
      "device": {
        "aliasName": "",
        "hostName": "jmeter-pv-us-ctl-vm01",
        "id": "9297503",
        "ipAddress": "",
        "name": "jmeter-pv-us-ctl-vm01",
        "resourceName": "",
        "resourceType": "Other",
        "type": "DEVICE"
      },
      "elapsedTimeString": "62d 1h 38m ",
      "entityType": "RESOURCE",
      "eventType": "ALERT",
      "extAlertId": "",
      "ignoreRecoveryNoise": false,
      "inferenceAlert": false,
      "inferenceId": 0,
      "isRecoveryAlert": false,
      "managedByOpsRamp": false,
      "metric": "Network1",
      "metricTime": 0,
      "monitorName": "Network1",
      "mspName": "SQALab",
      "permanentlySuppressed": false,
      "priority": "N/A",
      "problemArea": "Network1",
      "processIds": [
        "PROCESS_e1d7b813-4808-495a-a6b5-a4ed37507d97"
      ],
      "rba": false,
      "repeatCount": "2",
      "resource": {
        "agentInstalled": false,
        "aliasName": "",
        "alternateIp": "",
        "clientId": 0,
        "clientUniqueId": "client_22568",
        "cloudInstance": false,
        "consoles": [],
        "deleted": false,
        "description": "",
        "device": false,
        "dns": "",
        "encrypted": false,
        "excludeIndexing": false,
        "frequency": 0,
        "generalInfo": {
          "aliasName": "",
          "assetManagedTime": "2021-05-23T13:39:12+0000",
          "createdTime": "2021-05-23T13:39:12+0000",
          "firstAssetManagedTime": "2021-05-23T13:39:12+0000",
          "hostName": "jmeter-pv-us-ctl-vm01",
          "name": "jmeter-pv-us-ctl-vm01",
          "resourceName": "",
          "resourcePath": "Other",
          "resourceType": "Other",
          "updatedTime": ""
        },
        "hostName": "jmeter-pv-us-ctl-vm01",
        "id": "336a5197-c8d8-46d0-9953-ebf95dd8046b",
        "ipAddress": "",
        "locationOffset": 0,
        "make": "",
        "name": "jmeter-pv-us-ctl-vm01",
        "osName": "",
        "paused": false,
        "port": 0,
        "receiverHostPort": 0,
        "resourceName": "",
        "resourcePath": "Other",
        "resourceType": "Other",
        "saId": 0,
        "source": "ALERT",
        "state": "active",
        "status": "UNDEFINED",
        "tags": [],
        "timeout": 0,
        "topologyEnabled": false,
        "totalLocations": 0,
        "ts": 0,
        "type": "Other",
        "validateSSL": false
      },
      "rtype": "RESOURCE",
      "serviceName": "Network1",
      "snoozeDuration": 0,
      "status": "New",
      "statusHistory": {
        "createdBy": "system",
        "createdTime": "2021-05-23T16:39:58+0000"
      },
      "subject": "test workflow alert Validation For Maintenance schedule Using JM-vas",
      "suppressed": false,
      "tenantId": 22568,
      "tenantName": "JMClient1605551845209",
      "ticketed": false,
      "uniqueId": "117898523",
      "updatedTime": "2021-05-23T16:43:38+0000"
    }
  ],
  "totalPages": 1,
  "totalResults": 4
}