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

Describes the clientId or mspId of tenant

Query Parameters
pageNo
integer

pageSize
integer

isDescendingOrder
boolean

sortName
string

queryString
string

Responses

OK

descendingOrder
boolean

nextPage
boolean

nextPageNo
integer

orderBy
string

pageNo
integer

pageSize
integer

previousPageNo
integer

results
array

results.appliedTime
results.assignedInterfaces
results.assignedTime
results.collectorType
results.configParameters
results.createdDate
results.description
results.generation
results.id
results.monitors
results.name
results.status
results.tags
results.templateType
results.uniqueId
results.updatedDate
totalPages
integer

totalResults
integer

{
  "descendingOrder": true,
  "nextPage": false,
  "nextPageNo": 0,
  "orderBy": "id",
  "pageNo": 1,
  "pageSize": 10,
  "previousPageNo": 0,
  "results": [
    {
      "appliedTime": "2021-01-20T11:13:16+0000",
      "assignedTime": "2021-01-20T11:12:20+0000",
      "collectorType": "Gateway",
      "configParameters": [
        {
          "parameter": {
            "description": "Port number that you want to monitor",
            "id": 592,
            "name": "Port",
            "type": "String"
          }
        }
      ],
      "createdDate": "2016-06-06T08:25:06+0000",
      "description": "Template testing",
      "generation": 2,
      "id": 6738,
      "monitors": [
        {
          "availability": true,
          "criticalOperator": "EQUAL",
          "criticalRepeatCount": 1,
          "criticalThreshHold": "90",
          "frequency": 15,
          "metricName": "testing.dynamic.metric",
          "name": "testing form ui latest",
          "raiseAlert": true,
          "state": "Active",
          "warningOperator": "GREATER_THAN_EQUAL",
          "warningRepeatCount": 2,
          "warningThreshHold": "70"
        },
        {
          "availability": true,
          "criticalOperator": "GREATER_THAN_EQUAL",
          "criticalRepeatCount": 1,
          "criticalThreshHold": "90",
          "frequency": 15,
          "metricName": "cisco.memory.pool.util.percent",
          "name": "Cisco Memory-2",
          "raiseAlert": true,
          "state": "Active",
          "warningOperator": "GREATER_THAN_EQUAL",
          "warningRepeatCount": 1,
          "warningThreshHold": "80"
        },
        {
          "availability": true,
          "criticalOperator": "LESS_THAN_EQUAL",
          "criticalRepeatCount": 1,
          "criticalThreshHold": "500",
          "frequency": 15,
          "metricName": "cisco.memory.pool.largest.free",
          "name": "Cisco Memory-2",
          "raiseAlert": true,
          "state": "Active",
          "warningOperator": "LESS_THAN_EQUAL",
          "warningRepeatCount": 1,
          "warningThreshHold": "600"
        }
      ],
      "name": "Second generation Gateway Template",
      "notes": "test cases",
      "resourceType": "DEVICE",
      "status": "ACTIVE",
      "tags": "testing",
      "uniqueId": "1463daa4-9c75-4911-8994-09cac072374a",
      "updatedDate": "2016-06-06T08:25:06+0000"
    },
    {
      "appliedTime": "2021-01-20T11:13:16+0000",
      "assignedTime": "2021-01-20T11:12:20+0000",
      "collectorType": "Gateway",
      "createdDate": "2016-05-24T13:34:34+0000",
      "description": "",
      "generation": 2,
      "id": 6736,
      "monitors": [
        {
          "availability": true,
          "criticalOperator": "NONE",
          "criticalRepeatCount": 0,
          "frequency": 15,
          "metricName": "metric for vmware",
          "name": "testing from API",
          "raiseAlert": false,
          "state": "Active",
          "warningOperator": "NONE",
          "warningRepeatCount": 1
        }
      ],
      "name": "Testing with gateway Monitors",
      "resourceType": "DEVICE",
      "status": "ACTIVE",
      "uniqueId": "6f5efafc-c00e-4406-ba80-de89aaf931b7",
      "updatedDate": "2016-05-24T13:34:34+0000"
    },
    {
      "appliedTime": "2021-01-20T11:13:16+0000",
      "assignedTime": "2021-01-20T11:12:20+0000",
      "collectorType": "Gateway",
      "createdDate": "2016-05-24T13:32:32+0000",
      "description": "testing",
      "generation": 1,
      "id": 6735,
      "monitors": [
        {
          "availability": false,
          "frequency": 15,
          "name": "EVENTLOGS",
          "raiseAlert": false
        },
        {
          "availability": false,
          "criticalThreshHold": "1000,100%!3",
          "frequency": 15,
          "name": "PING",
          "raiseAlert": false,
          "repeatCount": 1,
          "repeatFrequency": 1,
          "warningThreshHold": "900,90%"
        },
        {
          "availability": false,
          "criticalThreshHold": "1000,100%!3",
          "frequency": 15,
          "name": "PING",
          "raiseAlert": false,
          "repeatCount": 1,
          "repeatFrequency": 1,
          "warningThreshHold": "900,90%"
        },
        {
          "availability": false,
          "criticalThreshHold": "95",
          "frequency": 15,
          "name": "WINDOWSCPU",
          "raiseAlert": false,
          "repeatCount": 1,
          "repeatFrequency": 1,
          "warningThreshHold": "90"
        },
        {
          "availability": false,
          "criticalThreshHold": "95",
          "frequency": 15,
          "name": "WINDOWSDISK",
          "raiseAlert": false,
          "repeatCount": 1,
          "repeatFrequency": 1,
          "warningThreshHold": "90"
        },
        {
          "availability": false,
          "criticalThreshHold": "96",
          "frequency": 15,
          "name": "WINDOWSDISK",
          "raiseAlert": false,
          "repeatCount": 1,
          "repeatFrequency": 1,
          "warningThreshHold": "90"
        },
        {
          "availability": false,
          "criticalThreshHold": "94",
          "frequency": 15,
          "name": "WINDOWSDISK",
          "raiseAlert": false,
          "repeatCount": 1,
          "repeatFrequency": 1,
          "warningThreshHold": "90"
        },
        {
          "availability": false,
          "criticalThreshHold": "95",
          "frequency": 15,
          "name": "WINDOWSMEMORY",
          "raiseAlert": false,
          "repeatCount": 1,
          "repeatFrequency": 1,
          "warningThreshHold": "90"
        },
        {
          "availability": false,
          "criticalThreshHold": "1",
          "frequency": 15,
          "name": "WINDOWSUPTIME",
          "raiseAlert": false,
          "repeatCount": 1,
          "repeatFrequency": 1,
          "warningThreshHold": "5"
        }
      ],
      "name": "Testing Template with Gateway",
      "resourceType": "DEVICE",
      "status": "ACTIVE",
      "uniqueId": "c2996225-0cee-47bc-b347-9f1e98ad4fbc",
      "updatedDate": "2016-05-24T13:32:32+0000"
    },
    {
      "appliedTime": "2021-01-20T11:13:16+0000",
      "assignedTime": "2021-01-20T11:12:20+0000",
      "collectorType": "OpsRamp Cloud",
      "createdDate": "2014-11-18T07:51:14+0000",
      "description": "",
      "generation": 1,
      "id": 6706,
      "monitors": [
        {
          "availability": false,
          "criticalThreshHold": "",
          "frequency": 15,
          "name": "Agent Status",
          "raiseAlert": false,
          "repeatCount": 1,
          "repeatFrequency": 1,
          "warningThreshHold": ""
        }
      ],
      "name": "GATEWAY DEVICE MONITOR TEMPLATE",
      "resourceType": "DEVICE",
      "status": "ACTIVE",
      "uniqueId": "ELRZM98FIAWNKWQ2XK4QFW9G",
      "updatedDate": "2014-12-01T14:26:09+0000"
    }
  ],
  "totalPages": 1,
  "totalResults": 4
}
{
  "descendingOrder": true,
  "nextPage": true,
  "nextPageNo": 3,
  "orderBy": "t.id",
  "pageNo": 2,
  "pageSize": 3,
  "previousPageNo": 1,
  "results": [
    {
      "appliedTime": "2021-01-20T11:13:16+0000",
      "assignedInterfaces": [
        {
          "adminStatus": "UP",
          "confLinkSpeed": "10 Mbps",
          "id": 243935,
          "ifAlias": "VL31",
          "ifDescription": "VLAN31",
          "ifName": "VL31",
          "ifTxType": "IFTXTYPE_AUTO",
          "ifType": "ETHERNETCSMACD",
          "macAddress": "00:05:33:92:63:E4",
          "networkName": "VLAN31",
          "operationalStatus": "UP",
          "speed": "10 Mbps",
          "status": "UP"
        },
        {
          "adminStatus": "DOWN",
          "confLinkSpeed": "1000 Mbps",
          "id": 243751,
          "ifDescription": "eth1",
          "ifName": "eth1",
          "networkName": "eth1",
          "operationalStatus": "DOWN",
          "speed": "1000 Mbps",
          "status": "DOWN"
        }
      ],
      "assignedTime": "2021-01-20T11:12:20+0000",
      "collectorType": "OpsRamp Gateway",
      "createdDate": "2012-02-24T07:29:59+0000",
      "description": "*Do not use* This can be applied on all interfaces having the 64 bit counter OIDS and in the Full Duplex Transmission mode",
      "generation": 1,
      "id": 971,
      "monitors": [
        {
          "availability": false,
          "criticalThreshHold": "80,80",
          "frequency": 5,
          "name": "interface health",
          "raiseAlert": true,
          "repeatCount": 1,
          "repeatFrequency": 1,
          "warningThreshHold": "70,70"
        }
      ],
      "name": "*Do not use* Standard Interface - IFMIB - Full Duplex",
      "resourceType": "DEVICE",
      "status": "ACTIVE",
      "tags": "Monitors Status, Errors and Discards",
      "templateType": "INTERFACE",
      "uniqueId": "7EJFJGNXPPG6EIC00JX2EXE9",
      "updatedDate": "2012-09-10T11:22:52+0000"
    },
    {
      "appliedTime": "2021-01-20T11:12:16+0000",
      "assignedTime": "2021-01-20T11:11:20+0000",
      "collectorType": "Agent",
      "createdDate": "2013-11-08T12:50:53+0000",
      "description": "asdfsdaf",
      "generation": 1,
      "id": 6650,
      "monitors": [
        {
          "availability": false,
          "criticalThreshHold": "90",
          "frequency": 5,
          "name": "TotalDirectories",
          "raiseAlert": false,
          "repeatCount": 1,
          "repeatFrequency": 1,
          "warningThreshHold": "80"
        }
      ],
      "name": "agent test template",
      "resourceType": "DEVICE",
      "status": "ACTIVE",
      "tags": "oid",
      "uniqueId": "7VTJ7AWNILGJ0QXFCE21XJY6",
      "updatedDate": "2014-01-27T09:08:56+0000"
    },
    {
      "appliedTime": "2021-01-20T11:11:16+0000",
      "assignedTime": "2021-01-20T11:10:20+0000",
      "collectorType": "Agent",
      "createdDate": "2013-02-27T07:02:52+0000",
      "description": "Monitor basic performance monitors",
      "generation": 1,
      "id": 6632,
      "monitors": [
        {
          "availability": false,
          "criticalThreshHold": "90",
          "frequency": 5,
          "name": "CPU",
          "raiseAlert": true,
          "repeatCount": 1,
          "repeatFrequency": 1,
          "warningThreshHold": "60"
        },
        {
          "availability": false,
          "criticalThreshHold": "90",
          "frequency": 5,
          "name": "DISK",
          "raiseAlert": true,
          "repeatCount": 1,
          "repeatFrequency": 1,
          "warningThreshHold": "60"
        },
        {
          "availability": false,
          "criticalThreshHold": "90",
          "frequency": 5,
          "name": "MEMORY",
          "raiseAlert": true,
          "repeatCount": 1,
          "repeatFrequency": 1,
          "warningThreshHold": "60"
        },
        {
          "availability": false,
          "criticalThreshHold": "90",
          "frequency": 5,
          "name": "NETWORK",
          "raiseAlert": true,
          "repeatCount": 1,
          "repeatFrequency": 1,
          "warningThreshHold": "60"
        },
        {
          "availability": false,
          "criticalThreshHold": "20",
          "frequency": 5,
          "name": "FREEDISK",
          "raiseAlert": true,
          "repeatCount": 1,
          "repeatFrequency": 1,
          "warningThreshHold": "70"
        },
        {
          "availability": false,
          "criticalThreshHold": "90",
          "frequency": 5,
          "name": "MessagesReceived",
          "raiseAlert": false,
          "repeatCount": 1,
          "repeatFrequency": 1,
          "warningThreshHold": "80"
        }
      ],
      "name": "Agent_Basic_NCI_template",
      "resourceType": "DEVICE",
      "status": "ACTIVE",
      "uniqueId": "LBU9LAOHEIDCKSB00IVQ6GW3",
      "updatedDate": "2013-03-13T11:14:10+0000"
    }
  ],
  "totalPages": 3,
  "totalResults": 9
}