v1
latestOpenAPI 3.0.02026-07-141,4077,1665.2 MBMonitors
Get a monitor user template
Retrieve a monitor user template by its ID.
get/api/v2/monitor/template/{template_id}
Path parameters
template_idstring required
Example:00000000-0000-1234-0000-000000000000
ID of the monitor user template.
Query parameters
with_all_versionsboolean
Whether to include all versions of the template in the response in the versions field.
Response
OK
Example response
{
"data": {
"attributes": {
"created": "2024-01-02T03:04:23.274966+00:00",
"description": "This is a template for monitoring user activity.",
"modified": "2024-02-02T03:04:23.274966+00:00",
"monitor_definition": {
"message": "You may need to add web hosts if this is consistently high.",
"name": "Bytes received on host0",
"query": "avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100",
"type": "query alert"
},
"tags": [
"product:Our Custom App",
"integration:Azure"
],
"template_variables": [
{
"available_values": [
"value1",
"value2"
],
"defaults": [
"defaultValue"
],
"name": "regionName",
"tag_key": "datacenter"
}
],
"title": "Postgres CPU Monitor",
"versions": [
{
"created": "2024-01-02T03:04:23.274966+00:00",
"description": "This is a template for monitoring user activity.",
"id": "00000000-0000-1234-0000-000000000000",
"monitor_definition": {
"message": "You may need to add web hosts if this is consistently high.",
"name": "Bytes received on host0",
"query": "avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100",
"type": "query alert"
},
"tags": [
"product:Our Custom App",
"integration:Azure"
],
"template_variables": [
{
"available_values": [
"value1",
"value2"
],
"defaults": [
"defaultValue"
],
"name": "regionName",
"tag_key": "datacenter"
}
],
"title": "Postgres CPU Monitor"
}
]
},
"id": "00000000-0000-1234-0000-000000000000",
"type": "monitor-user-template"
}
}