Search templates

This endpoint is used to activate a user.

Leave Feedback

URL

GET https:/{api-url}/api/v2/tenants/{tenantId}/monitoring/templates/search

Sample URLs

https://{api-url}/api/v2/tenants/client_93/monitoring/templates/search
https://{api-url}/api/v2/tenants/client_93/monitoring/templates/search?pageNo=1&pageSize=10&isDescendingOrder=true&sortName=id&queryString=id:1043+name:vTemplate+scope:Global+collectorType:AWS+status:ACTIVE+generation:1
https://{api-url}/api/v2/tenants/msp_92/monitoring/templates/search?queryString=startCreationDate:2015-11-10T10:40:20 0000+endCreationDate:2015-11-11T10:40:20 0000

Parameters

The parameters are optional:

FieldDefault Value
pageNo={pageNo}1
pageSize={pageSize}100
isDescendingOrder={true/false}true
sortName={field}id
queryString={queryString}NA

NA indicates that the value is not applicable.

Query variables

Query VariablesDescription
idTemplate ID.
nameTemplate name.
scopeTemplate scope. Example: Global [note 3]
collectorTypeCollector type.
Supported values are: Agent, Gateway, OpsRamp Cloud, AWS, GOOGLE, AZURE
statusTemplate status.
Example: ACTIVE, EOL
generationThe generation.
Example: 1, 2
startCreationDateSearch for templates created within a certain duration.
startCreationDate denotes the from date.
endCreationDateSearch for templates created within a certain duration.
endCreationDate denotes the to date.
startUpdationDateSearch for templates updated within a certain duration.
startUpdationDate denotes the from update date.
endUpdationDateSearch for templates updated within a certain duration.
endUpdationDate denotes the to update date.
sourceTypeTemplate source.
Supported values are: DEVICE, DATA_CENTER, VI_CLUSTER, VI_DATASTORE, JMX_APP_CLUSTER, JMX_APP_INSTANCE, DISTRIBUTED_VIRTUAL_SWITCH, CONTRAIL_ANALYTICS_NODE, CONTRAIL_CONFIG_NODE, CONTRAIL_CONTROL_NODE, VIRTUVAL_ROUTER, STORAGE_ARRAY_VOLUME

Status code

200 OK

Sample response

{
	"results": [{
			"id": 6738,
			"uniqueId": "1463daa4-9c75-4911-8994-09cac072374a",
			"name": "Second generation Gateway Template",
			"description": "Template testing",
			"collectorType": "Gateway",
			"status": "ACTIVE",
			"generation": 2,
			"resourceType": "DEVICE",
			"tags": "testing",
			"notes": "test cases",
			"createdDate": "2016-06-06T08:25:06+0000",
			"updatedDate": "2016-06-06T08:25:06+0000",
			"monitors": [{
					"name": "testing form ui latest",
					"metricName": "testing.dynamic.metric",
					"frequency": 15,
					"warningThreshHold": "70",
					"warningOperator": "GREATER_THAN_EQUAL",
					"warningRepeatCount": 2,
					"criticalThreshHold": "90",
					"criticalOperator": "EQUAL",
					"criticalRepeatCount": 1,
					"raiseAlert": true,
					"availability": true,
					"state": "Active"
				},
				{
					"name": "Cisco Memory-2",
					"metricName": "cisco.memory.pool.util.percent",
					"frequency": 15,
					"warningThreshHold": "80",
					"warningOperator": "GREATER_THAN_EQUAL",
					"warningRepeatCount": 1,
					"criticalThreshHold": "90",
					"criticalOperator": "GREATER_THAN_EQUAL",
					"criticalRepeatCount": 1,
					"raiseAlert": true,
					"availability": true,
					"state": "Active"
				},
				{
					"name": "Cisco Memory-2",
					"metricName": "cisco.memory.pool.largest.free",
					"frequency": 15,
					"warningThreshHold": "600",
					"warningOperator": "LESS_THAN_EQUAL",
					"warningRepeatCount": 1,
					"criticalThreshHold": "500",
					"criticalOperator": "LESS_THAN_EQUAL",
					"criticalRepeatCount": 1,
					"raiseAlert": true,
					"availability": true,
					"state": "Active"
				}
			],
			"configParameters" : [
				{
					"parameter" : {
						"id" : 592,
						"name" : "Port",
						"description" : "Port number that you want to monitor",
						"type" : "String"
					}
				}
			]
		},
		{
			"id": 6736,
			"uniqueId": "6f5efafc-c00e-4406-ba80-de89aaf931b7",
			"name": "Testing with gateway Monitors",
			"description": "",
			"collectorType": "Gateway",
			"status": "ACTIVE",
			"generation": 2,
			"resourceType": "DEVICE",
			"createdDate": "2016-05-24T13:34:34+0000",
			"updatedDate": "2016-05-24T13:34:34+0000",
			"monitors": [{
				"name": "testing from API",
				"metricName": "metric for vmware",
				"frequency": 15,
				"warningOperator": "NONE",
				"warningRepeatCount": 1,
				"criticalOperator": "NONE",
				"criticalRepeatCount": 0,
				"raiseAlert": false,
				"availability": true,
				"state": "Active"
			}]
		},
		{
			"id": 6735,
			"uniqueId": "c2996225-0cee-47bc-b347-9f1e98ad4fbc",
			"name": "Testing Template with Gateway",
			"description": "testing",
			"collectorType": "Gateway",
			"status": "ACTIVE",
			"generation": 1,
			"resourceType": "DEVICE",
			"createdDate": "2016-05-24T13:32:32+0000",
			"updatedDate": "2016-05-24T13:32:32+0000",
			"monitors": [{
					"name": "EVENTLOGS",
					"frequency": 15,
					"raiseAlert": false,
					"availability": false
				},
				{
					"name": "PING",
					"frequency": 15,
					"repeatFrequency": 1,
					"repeatCount": 1,
					"warningThreshHold": "900,90%",
					"criticalThreshHold": "1000,100%!3",
					"raiseAlert": false,
					"availability": false
				},
				{
					"name": "PING",
					"frequency": 15,
					"repeatFrequency": 1,
					"repeatCount": 1,
					"warningThreshHold": "900,90%",
					"criticalThreshHold": "1000,100%!3",
					"raiseAlert": false,
					"availability": false
				},
				{
					"name": "WINDOWSCPU",
					"frequency": 15,
					"repeatFrequency": 1,
					"repeatCount": 1,
					"warningThreshHold": "90",
					"criticalThreshHold": "95",
					"raiseAlert": false,
					"availability": false
				},
				{
					"name": "WINDOWSDISK",
					"frequency": 15,
					"repeatFrequency": 1,
					"repeatCount": 1,
					"warningThreshHold": "90",
					"criticalThreshHold": "95",
					"raiseAlert": false,
					"availability": false
				},
				{
					"name": "WINDOWSDISK",
					"frequency": 15,
					"repeatFrequency": 1,
					"repeatCount": 1,
					"warningThreshHold": "90",
					"criticalThreshHold": "96",
					"raiseAlert": false,
					"availability": false
				},
				{
					"name": "WINDOWSDISK",
					"frequency": 15,
					"repeatFrequency": 1,
					"repeatCount": 1,
					"warningThreshHold": "90",
					"criticalThreshHold": "94",
					"raiseAlert": false,
					"availability": false
				},
				{
					"name": "WINDOWSMEMORY",
					"frequency": 15,
					"repeatFrequency": 1,
					"repeatCount": 1,
					"warningThreshHold": "90",
					"criticalThreshHold": "95",
					"raiseAlert": false,
					"availability": false
				},
				{
					"name": "WINDOWSUPTIME",
					"frequency": 15,
					"repeatFrequency": 1,
					"repeatCount": 1,
					"warningThreshHold": "5",
					"criticalThreshHold": "1",
					"raiseAlert": false,
					"availability": false
				}
			]
		},
		{
			"id": 6706,
			"uniqueId": "ELRZM98FIAWNKWQ2XK4QFW9G",
			"name": "GATEWAY DEVICE MONITOR TEMPLATE",
			"description": "",
			"collectorType": "OpsRamp Cloud",
			"status": "ACTIVE",
			"generation": 1,
			"resourceType": "DEVICE",
			"createdDate": "2014-11-18T07:51:14+0000",
			"updatedDate": "2014-12-01T14:26:09+0000",
			"monitors": [{
				"name": "Agent Status",
				"frequency": 15,
				"repeatFrequency": 1,
				"repeatCount": 1,
				"warningThreshHold": "",
				"criticalThreshHold": "",
				"raiseAlert": false,
				"availability": false
			}]
		}
	],
	"totalResults": 4,
	"orderBy": "id",
	"pageNo": 1,
	"pageSize": 10,
	"totalPages": 1,
	"nextPage": false,
	"nextPageNo": 0,
	"previousPageNo": 0,
	"descendingOrder": true
}