templates/{id}
Get,Update and delete client scoped Templates
Get template details
Path Parameters
- id
Template uuid
- clientId
Describes the client unique identifier of the tenant
Responses
- id
Template uuid
- name
Template name
- description
Template details
- collectorType
Collector Type
- resourceType
Template applicable for native type resources.
- generation
Template generation
- tags
Tag
- createdDate
- updatedDate
- templateFamily
Template family
- notes
Brief details
- monitors
Template monitors
- status
Update a template configuration
Path Parameters
- id
Template uuid
- clientId
Describes the client unique identifier of the tenant
Request Body
application/json
- name
Template name
- description
Template Details
- status
- tags
Template tag
- templateFamily
Template family
- notes
- monitors
Template monitors
Request Body Samples
{
"name": "OpsRamp Gateway Performance Template",
"description": "Monitors basic UNIX parameters like UNIXCPU, UNIXSTORAGE, UNIXUPTIME, UNIXMEMORY, UNIXLOAD and UNIXStats",
"status": {
"state": "ACTIVE",
"eolDate": "DATE"
},
"tags": "Performance Monitors",
"templateFamily": "Performance Monitors Family",
"notes": "Sample notes related to performance monitors",
"monitors": [
{
"name": "CPU Stats - UCD-SNMP-MIB",
"frequency": 1,
"thresholdType": "Static",
"metricName": "system.unix.cpu.stats.idle",
"operation": "REMOVE"
},
{
"name": "Host System Uptime",
"frequency": 5,
"thresholdType": "Static",
"metricName": "system.uptime",
"operation": "UPDATE",
"thresholds": [
{
"criticalThreshold": 1800,
"warningThreshold": 10,
"criticalRepeatCount": 1,
"warningRepeatCount": 1,
"criticalOperator": "LESS_THAN_EQUAL",
"warningOperator": "NONE",
"raiseAlert": true,
"availability": true,
"levelType": "TEMPLATE"
}
]
}
]
}
Responses
- id
Template uuid
- name
Template name
- description
Template details
- collectorType
Collector Type
- resourceType
Template applicable for native type resources.
- generation
Template generation
- tags
Tag
- createdDate
- updatedDate
- templateFamily
Template family
- notes
Brief details
- monitors
Template monitors
- status
Response Samples
{
"id": "80724599-90e9-4055-bc95-b9316671f942",
"name": "Test_synthetics_template",
"description": "test",
"resourceType": "SYNTHETIC",
"collectorType": "Synthetics",
"checkType": "HTTPS",
"status": {
"state": "ACTIVE"
},
"generation": 2,
"tags": "",
"createdDate": "2023-02-08T09:27:21+0000",
"updatedDate": "2023-02-08T10:31:51+0000",
"scope": "Partner",
"templateFamily": "Synthetics",
"notes": "",
"monitors": [
{
"name": "Synthetics - HTTPS",
"frequency": 1,
"thresholdType": "Static",
"metricName": "synthetic.response.time",
"unit": "ms",
"thresholds": [
{
"criticalThreshold": 200,
"warningThreshold": 100,
"criticalRepeatCount": 1,
"warningRepeatCount": 1,
"criticalOperator": "GREATER_THAN_EQUAL",
"warningOperator": "GREATER_THAN_EQUAL",
"raiseAlert": false,
"availability": false,
"state": "Active",
"levelType": "TEMPLATE"
},
{
"criticalThreshold": 20,
"warningThreshold": 10,
"repeatCount": 1,
"raiseAlert": true,
"levelType": "TEMPLATE_COMPONENT",
"location": "synthetic-public"
}
]
},
{
"name": "Synthetics - HTTPS",
"frequency": 1,
"thresholdType": "Static",
"metricName": "synthetic.response.redirecttime",
"unit": "ms",
"thresholds": [
{
"criticalThreshold": 200,
"warningThreshold": 100,
"criticalRepeatCount": 1,
"warningRepeatCount": 1,
"criticalOperator": "GREATER_THAN_EQUAL",
"warningOperator": "GREATER_THAN_EQUAL",
"raiseAlert": false,
"availability": false,
"state": "Active",
"levelType": "TEMPLATE"
}
]
},
{
"name": "Synthetics - HTTPS",
"frequency": 1,
"thresholdType": "Static",
"metricName": "ssl.cert.expiry.check",
"unit": "Days",
"thresholds": [
{
"criticalThreshold": 5,
"warningThreshold": 10,
"criticalRepeatCount": 1,
"warningRepeatCount": 1,
"criticalOperator": "LESS_THAN_EQUAL",
"warningOperator": "LESS_THAN_EQUAL",
"raiseAlert": false,
"availability": false,
"state": "Active",
"levelType": "TEMPLATE"
}
]
},
{
"name": "Synthetics - HTTPS",
"frequency": 1,
"thresholdType": "Static",
"metricName": "availability.down.locations.count",
"unit": "count",
"thresholds": [
{
"criticalThreshold": 1,
"warningThreshold": 0,
"criticalRepeatCount": 1,
"warningRepeatCount": 1,
"criticalOperator": "GREATER_THAN_EQUAL",
"warningOperator": "GREATER_THAN_EQUAL",
"raiseAlert": false,
"availability": false,
"state": "Active",
"levelType": "TEMPLATE"
},
{
"criticalThreshold": 80,
"warningThreshold": 50,
"repeatCount": 1,
"raiseAlert": true,
"levelType": "TEMPLATE_COMPONENT",
"location": "ALL"
}
]
}
]
}
Deletes a template or removes template attributes
Notes
- Users cannot delete assigned templates.
- Removes unassigned templates only.
Path Parameters
- id
Template uuid
- clientId
Describes the client unique identifier of the tenant
Responses
200OK
Response Samples
{
"code": "code",
"message": "Delete failed"
}