Search Templates

Searching for template based on query parameters

scope query parameter lets user to filter templates based on Template Scope

scope = Global , Filters the templates which are globally available across the platform for all customers.
scope = Service Provider,Filters the templates which are provided by Service Provider.
scope = Client , Filters the templates which are created by the tenant.
scope = Partner, Filters the templates which are created by the provider who manage the tenant.

Using scope filter in queryString with authentication

With client authentication keys (example urls valid only with clientdid)
- https://<server.com>/api/v2/tenants/<clientid>/monitoring/templates/search?queryString=scope:Global
- https://<server.com>/api/v2/tenants/<clientid>/monitoring/templates/search?queryString=scope:Service Provider
- https://<server.com>/api/v2/tenants/<clientid>/monitoring/templates/search?queryString=scope:Partner
- https://<server.com>/api/v2/tenants/<clientid>/monitoring/templates/search?queryString=scope:Client
With partner authentication keys (example urls valid with both clientid or partnerId)
- https://<server.com>/api/v2/tenants/<clientid>/monitoring/templates/search?queryString=scope:Global
- https://<server.com>/api/v2/tenants/<clientid>/monitoring/templates/search?queryString=scope:Service Provider
- https://<server.com>/api/v2/tenants/<partnerid>/monitoring/templates/search?queryString=scope:Global
- https://<server.com>/api/v2/tenants/<partnerid>/monitoring/templates/search?queryString=scope:Service Provider
- https://<server.com>/api/v2/tenants/<clientid>/monitoring/templates/search?queryString=scope:Partner
- https://<server.com>/api/v2/tenants/<clientid>/monitoring/templates/search?queryString=scope:Client
- https://<server.com>/api/v2/tenants/<partnerid>/monitoring/templates/search?queryString=scope:Partner
- https://<server.com>/api/v2/tenants/<partnerid>/monitoring/templates/search?queryString=scope:Client

Path Parameters

tenantIdstringrequired
Describes the clientId or mspId of tenant

Query Parameters

pageNointeger
Resultset page no
Default: 1
pageSizeinteger
Records in each page
Default: 100
isDescendingOrderboolean
Resultset order
sortNamestring
Sort the resultset based on the given field name (groupBy)
Default: id
queryStringstring
Query String to filter resultset based on different parameter values
idstring
Template ID
namestring
Template name
scopestring
Scope of the template. Please refer notes below for details
Enum:
GlobalService ProviderClientPartner
collectorTypestring
Monitoring metric data Collector type. Supported values as given.
Enum:
AgentGatewayOpsRamp CloudAWSGOOGLEAZURESaas Application
statusstring
Template status
Enum:
ACTIVEEOL
generationstring
Template Generation
Enum:
12
startCreationDatestring
Search for templates created within a certain duration. startCreationDate denotes the from date.
endCreationDatestring
Search for templates created within a certain duration. endCreationDate denotes the to date.
startUpdationDatestring
Search for templates updated within a certain duration. startUpdationDate denotes the from update date.
endUpdationDatestring
Search for templates updated within a certain duration. endUpdationDate denotes the to update date.
sourceTypestring
Filter to get the available templates at the given resource level type .For eg filter for available templates at resouce i..e sourceType=DEVICE. User can filter out templates required for given resource type.
Enum:
DEVICEDATA_CENTERVI_CLUSTERVI_DATASTOREJMX_APP_CLUSTERJMX_APP_INSTANCEDISTRIBUTED_VIRTUAL_SWITCHCONTRAIL_ANALYTICS_NODECONTRAIL_CONFIG_NODECONTRAIL_CONTROL_NODEVIRTUVAL_ROUTERSTORAGE_ARRAY_VOLUME

Responses

resultsarray
totalResultsinteger
orderBystring
pageNointeger
pageSizeinteger
totalPagesinteger
nextPageboolean
nextPageNointeger
previousPageNointeger
descendingOrderboolean

Response Samples

{
  "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",
      "assignedTime": "2021-01-20T11:12:20+0000",
      "appliedTime": "2021-01-20T11:13:16+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",
      "assignedTime": "2021-01-20T11:12:20+0000",
      "appliedTime": "2021-01-20T11:13:16+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",
      "assignedTime": "2021-01-20T11:12:20+0000",
      "appliedTime": "2021-01-20T11:13:16+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",
      "assignedTime": "2021-01-20T11:12:20+0000",
      "appliedTime": "2021-01-20T11:13:16+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
}

Path Parameters

Query Parameters

Responses

200OK

Response Samples