URL
GET https://{api-url}/api/v2/tenants/{tenantId}/resources/{resourceId}/templates/search
Sample URLs
https://{api-url}/api/v2/tenants/client_93/monitoring/templates/search
https://{api-url}/api/v2/tenants/client_93/resources/94e52e7b-7100-4b2a-883e-b638fd5f2884/templates/search?pageNo=1&pageSize=10&isDescendingOrder=true&sortName=t.id
Parameters
The parameters are optional:
Field | Default Value |
---|---|
pageNo={pageNo} | 1 |
pageSize={pageSize} | 100 |
isDescendingOrder={true/false} | true |
sortName={field} | id |
Notes
There are special characters that can be used in a query string:
- (+) represents the next field and must be URL-encoded.
- (:) represents equals. An example is
key : value
. - Space characters must be URL-encoded.
- Date format must be yyyy-MM-ddTHH:mm:ssZ (GMT).
Status code
200 OK
Sample response
{
"results": [{
"id": 971,
"uniqueId": "7EJFJGNXPPG6EIC00JX2EXE9",
"name": "*Do not use* Standard Interface - IFMIB - Full Duplex",
"description": "*Do not use* This can be applied on all interfaces having the 64 bit counter OIDS and in the Full Duplex Transmission mode",
"templateType": "INTERFACE",
"collectorType": "Gateway",
"status": "ACTIVE",
"generation": 1,
"resourceType": "DEVICE",
"tags": "Monitors Status, Errors and Discards",
"createdDate": "2012-02-24T07:29:59+0000",
"updatedDate": "2012-09-10T11:22:52+0000",
"monitors": [{
"name": "interface health",
"frequency": 5,
"repeatFrequency": 1,
"repeatCount": 1,
"warningThreshHold": "70,70",
"criticalThreshHold": "80,80",
"raiseAlert": true,
"availability": false
}],
"assignedInterfaces": [{
"id": 243935,
"networkName": "VLAN31",
"status": "UP",
"ifName": "VL31",
"ifAlias": "VL31",
"ifDescription": "VLAN31",
"ifTxType": "IFTXTYPE_AUTO",
"ifType": "ETHERNETCSMACD",
"macAddress": "00:05:33:92:63:E4",
"speed": "10 Mbps",
"confLinkSpeed": "10 Mbps",
"adminStatus": "UP",
"operationalStatus": "UP"
},
{
"id": 243751,
"networkName": "eth1",
"status": "DOWN",
"ifName": "eth1",
"ifDescription": "eth1",
"speed": "1000 Mbps",
"confLinkSpeed": "1000 Mbps",
"adminStatus": "DOWN",
"operationalStatus": "DOWN"
}
]
},
{
"id": 6650,
"uniqueId": "7VTJ7AWNILGJ0QXFCE21XJY6",
"name": "agent test template",
"description": "asdfsdaf",
"collectorType": "Agent",
"status": "ACTIVE",
"generation": 1,
"resourceType": "DEVICE",
"tags": "oid",
"createdDate": "2013-11-08T12:50:53+0000",
"updatedDate": "2014-01-27T09:08:56+0000",
"monitors": [{
"name": "TotalDirectories",
"frequency": 5,
"repeatFrequency": 1,
"repeatCount": 1,
"warningThreshHold": "80",
"criticalThreshHold": "90",
"raiseAlert": false,
"availability": false
}]
},
{
"id": 6632,
"uniqueId": "LBU9LAOHEIDCKSB00IVQ6GW3",
"name": "Agent_Basic_NCI_template",
"description": "Monitor basic performance monitors",
"collectorType": "Agent",
"status": "ACTIVE",
"generation": 1,
"resourceType": "DEVICE",
"createdDate": "2013-02-27T07:02:52+0000",
"updatedDate": "2013-03-13T11:14:10+0000",
"monitors": [{
"name": "CPU",
"frequency": 5,
"repeatFrequency": 1,
"repeatCount": 1,
"warningThreshHold": "60",
"criticalThreshHold": "90",
"raiseAlert": true,
"availability": false
},
{
"name": "DISK",
"frequency": 5,
"repeatFrequency": 1,
"repeatCount": 1,
"warningThreshHold": "60",
"criticalThreshHold": "90",
"raiseAlert": true,
"availability": false
},
{
"name": "MEMORY",
"frequency": 5,
"repeatFrequency": 1,
"repeatCount": 1,
"warningThreshHold": "60",
"criticalThreshHold": "90",
"raiseAlert": true,
"availability": false
},
{
"name": "NETWORK",
"frequency": 5,
"repeatFrequency": 1,
"repeatCount": 1,
"warningThreshHold": "60",
"criticalThreshHold": "90",
"raiseAlert": true,
"availability": false
},
{
"name": "FREEDISK",
"frequency": 5,
"repeatFrequency": 1,
"repeatCount": 1,
"warningThreshHold": "70",
"criticalThreshHold": "20",
"raiseAlert": true,
"availability": false
},
{
"name": "MessagesReceived",
"frequency": 5,
"repeatFrequency": 1,
"repeatCount": 1,
"warningThreshHold": "80",
"criticalThreshHold": "90",
"raiseAlert": false,
"availability": false
}
]
}
],
"totalResults": 9,
"orderBy": "t.id",
"pageNo": 2,
"pageSize": 3,
"totalPages": 3,
"nextPage": true,
"nextPageNo": 3,
"previousPageNo": 1,
"descendingOrder": true
}