A valid monitor definition in the same format as the V1 Monitor API.
tags [required]
[string]
The definition of MonitorUserTemplateTags object.
template_variables
[object]
The definition of MonitorUserTemplateTemplateVariables object.
available_values
[string]
Available values for the variable.
defaults
[string]
Default values of the template variable.
name [required]
string
The name of the template variable.
tag_key
string
The tag key associated with the variable. This works the same as dashboard template variables.
title [required]
string
The title of the monitor user template.
id [required]
string
The unique identifier.
type [required]
enum
Monitor user template resource type.
Allowed enum values: monitor-user-template
default: monitor-user-template
{"data":{"attributes":{"description":"A description.","monitor_definition":{"message":"A msg.","name":"A name example-monitor","query":"avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100","type":"query alert"},"tags":["integration:Azure"],"template_variables":[{"available_values":["value1","value2"],"defaults":["defaultValue"],"name":"regionName","tag_key":"datacenter"}],"title":"Postgres DB example-monitor"},"id":"00000000-0000-1234-0000-000000000000","type":"monitor-user-template"}}
The last modified timestamp. When the template version was created.
monitor_definition
object
A valid monitor definition in the same format as the V1 Monitor API.
tags
[string]
The definition of MonitorUserTemplateTags object.
template_variables
[object]
The definition of MonitorUserTemplateTemplateVariables object.
available_values
[string]
Available values for the variable.
defaults
[string]
Default values of the template variable.
name [required]
string
The name of the template variable.
tag_key
string
The tag key associated with the variable. This works the same as dashboard template variables.
title
string
The title of the monitor user template.
version
int64
The version of the monitor user template.
versions
[object]
All versions of the monitor user template.
created
date-time
The created timestamp of the template.
description
string
A brief description of the monitor user template.
id
string
The unique identifier. The initial version will match the template ID.
monitor_definition
object
A valid monitor definition in the same format as the V1 Monitor API.
tags
[string]
The definition of MonitorUserTemplateTags object.
template_variables
[object]
The definition of MonitorUserTemplateTemplateVariables object.
available_values
[string]
Available values for the variable.
defaults
[string]
Default values of the template variable.
name [required]
string
The name of the template variable.
tag_key
string
The tag key associated with the variable. This works the same as dashboard template variables.
title
string
The title of the monitor user template.
version
int64
The version of the monitor user template.
id
string
The unique identifier.
type
enum
Monitor user template resource type.
Allowed enum values: monitor-user-template
default: monitor-user-template
{"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","version":0,"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","version":0}]},"id":"00000000-0000-1234-0000-000000000000","type":"monitor-user-template"}}
## default
#
# Path parameters exporttemplate_id="CHANGE_ME" # Curl command curl-XPUT"https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.us2.ddog-gov.com"https://api.uk1.datadoghq.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/monitor/template/${template_id}" \
-H"Accept: application/json" \
-H"Content-Type: application/json" \
-H"DD-API-KEY: ${DD_API_KEY}" \
-H"DD-APPLICATION-KEY: ${DD_APP_KEY}" \
-d@-<<EOF{
"data": {
"attributes": {
"description": "This is a template for monitoring user activity.",
"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} \u003e 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"
}
}EOF
// Update a monitor user template to a new version returns "OK" responsepackagemainimport("context""encoding/json""fmt""os""github.com/DataDog/datadog-api-client-go/v2/api/datadog""github.com/DataDog/datadog-api-client-go/v2/api/datadogV2")funcmain(){// there is a valid "monitor_user_template" in the systemMonitorUserTemplateDataID:=os.Getenv("MONITOR_USER_TEMPLATE_DATA_ID")body:=datadogV2.MonitorUserTemplateUpdateRequest{Data:datadogV2.MonitorUserTemplateUpdateData{Attributes:datadogV2.MonitorUserTemplateRequestAttributes{Description:*datadog.NewNullableString(datadog.PtrString("A description.")),MonitorDefinition:map[string]interface{}{"message":"A msg.","name":"A name example-monitor","query":"avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100","type":"query alert",},Tags:[]string{"integration:Azure",},TemplateVariables:[]datadogV2.MonitorUserTemplateTemplateVariablesItems{{AvailableValues:[]string{"value1","value2",},Defaults:[]string{"defaultValue",},Name:"regionName",TagKey:datadog.PtrString("datacenter"),},},Title:"Postgres DB example-monitor",},Id:MonitorUserTemplateDataID,Type:datadogV2.MONITORUSERTEMPLATERESOURCETYPE_MONITOR_USER_TEMPLATE,},}ctx:=datadog.NewDefaultContext(context.Background())configuration:=datadog.NewConfiguration()configuration.SetUnstableOperationEnabled("v2.UpdateMonitorUserTemplate",true)apiClient:=datadog.NewAPIClient(configuration)api:=datadogV2.NewMonitorsApi(apiClient)resp,r,err:=api.UpdateMonitorUserTemplate(ctx,MonitorUserTemplateDataID,body)iferr!=nil{fmt.Fprintf(os.Stderr,"Error when calling `MonitorsApi.UpdateMonitorUserTemplate`: %v\n",err)fmt.Fprintf(os.Stderr,"Full HTTP response: %v\n",r)}responseContent,_:=json.MarshalIndent(resp,""," ")fmt.Fprintf(os.Stdout,"Response from `MonitorsApi.UpdateMonitorUserTemplate`:\n%s\n",responseContent)}
// Update a monitor user template to a new version returns "OK" responseimportcom.datadog.api.client.ApiClient;importcom.datadog.api.client.ApiException;importcom.datadog.api.client.v2.api.MonitorsApi;importcom.datadog.api.client.v2.model.MonitorUserTemplateRequestAttributes;importcom.datadog.api.client.v2.model.MonitorUserTemplateResourceType;importcom.datadog.api.client.v2.model.MonitorUserTemplateResponse;importcom.datadog.api.client.v2.model.MonitorUserTemplateTemplateVariablesItems;importcom.datadog.api.client.v2.model.MonitorUserTemplateUpdateData;importcom.datadog.api.client.v2.model.MonitorUserTemplateUpdateRequest;importjava.util.Arrays;importjava.util.Collections;importjava.util.Map;publicclassExample{publicstaticvoidmain(String[]args){ApiClientdefaultClient=ApiClient.getDefaultApiClient();defaultClient.setUnstableOperationEnabled("v2.updateMonitorUserTemplate",true);MonitorsApiapiInstance=newMonitorsApi(defaultClient);// there is a valid "monitor_user_template" in the systemStringMONITOR_USER_TEMPLATE_DATA_ID=System.getenv("MONITOR_USER_TEMPLATE_DATA_ID");MonitorUserTemplateUpdateRequestbody=newMonitorUserTemplateUpdateRequest().data(newMonitorUserTemplateUpdateData().attributes(newMonitorUserTemplateRequestAttributes().description("A description.").monitorDefinition(Map.ofEntries(Map.entry("message","A msg."),Map.entry("name","A name example-monitor"),Map.entry("query","avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100"),Map.entry("type","query alert"))).tags(Collections.singletonList("integration:Azure")).templateVariables(Collections.singletonList(newMonitorUserTemplateTemplateVariablesItems().availableValues(Arrays.asList("value1","value2")).defaults(Collections.singletonList("defaultValue")).name("regionName").tagKey("datacenter"))).title("Postgres DB example-monitor")).id(MONITOR_USER_TEMPLATE_DATA_ID).type(MonitorUserTemplateResourceType.MONITOR_USER_TEMPLATE));try{MonitorUserTemplateResponseresult=apiInstance.updateMonitorUserTemplate(MONITOR_USER_TEMPLATE_DATA_ID,body);System.out.println(result);}catch(ApiExceptione){System.err.println("Exception when calling MonitorsApi#updateMonitorUserTemplate");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace();}}}
"""
Update a monitor user template to a new version returns "OK" response
"""fromosimportenvironfromdatadog_api_clientimportApiClient,Configurationfromdatadog_api_client.v2.api.monitors_apiimportMonitorsApifromdatadog_api_client.v2.model.monitor_user_template_request_attributesimportMonitorUserTemplateRequestAttributesfromdatadog_api_client.v2.model.monitor_user_template_resource_typeimportMonitorUserTemplateResourceTypefromdatadog_api_client.v2.model.monitor_user_template_template_variables_itemsimport(MonitorUserTemplateTemplateVariablesItems,)fromdatadog_api_client.v2.model.monitor_user_template_update_dataimportMonitorUserTemplateUpdateDatafromdatadog_api_client.v2.model.monitor_user_template_update_requestimportMonitorUserTemplateUpdateRequest# there is a valid "monitor_user_template" in the systemMONITOR_USER_TEMPLATE_DATA_ID=environ["MONITOR_USER_TEMPLATE_DATA_ID"]body=MonitorUserTemplateUpdateRequest(data=MonitorUserTemplateUpdateData(attributes=MonitorUserTemplateRequestAttributes(description="A description.",monitor_definition=dict([("message","A msg."),("name","A name example-monitor"),("query","avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100"),("type","query alert"),]),tags=["integration:Azure",],template_variables=[MonitorUserTemplateTemplateVariablesItems(available_values=["value1","value2",],defaults=["defaultValue",],name="regionName",tag_key="datacenter",),],title="Postgres DB example-monitor",),id=MONITOR_USER_TEMPLATE_DATA_ID,type=MonitorUserTemplateResourceType.MONITOR_USER_TEMPLATE,),)configuration=Configuration()configuration.unstable_operations["update_monitor_user_template"]=TruewithApiClient(configuration)asapi_client:api_instance=MonitorsApi(api_client)response=api_instance.update_monitor_user_template(template_id=MONITOR_USER_TEMPLATE_DATA_ID,body=body)print(response)
# Update a monitor user template to a new version returns "OK" responserequire"datadog_api_client"DatadogAPIClient.configuredo|config|config.unstable_operations["v2.update_monitor_user_template".to_sym]=trueendapi_instance=DatadogAPIClient::V2::MonitorsAPI.new# there is a valid "monitor_user_template" in the systemMONITOR_USER_TEMPLATE_DATA_ID=ENV["MONITOR_USER_TEMPLATE_DATA_ID"]body=DatadogAPIClient::V2::MonitorUserTemplateUpdateRequest.new({data:DatadogAPIClient::V2::MonitorUserTemplateUpdateData.new({attributes:DatadogAPIClient::V2::MonitorUserTemplateRequestAttributes.new({description:"A description.",monitor_definition:{"message":"A msg.","name":"A name example-monitor","query":"avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100","type":"query alert",},tags:["integration:Azure",],template_variables:[DatadogAPIClient::V2::MonitorUserTemplateTemplateVariablesItems.new({available_values:["value1","value2",],defaults:["defaultValue",],name:"regionName",tag_key:"datacenter",}),],title:"Postgres DB example-monitor",}),id:MONITOR_USER_TEMPLATE_DATA_ID,type:DatadogAPIClient::V2::MonitorUserTemplateResourceType::MONITOR_USER_TEMPLATE,}),})papi_instance.update_monitor_user_template(MONITOR_USER_TEMPLATE_DATA_ID,body)
// Update a monitor user template to a new version returns "OK" response
usedatadog_api_client::datadog;usedatadog_api_client::datadogV2::api_monitors::MonitorsAPI;usedatadog_api_client::datadogV2::model::MonitorUserTemplateRequestAttributes;usedatadog_api_client::datadogV2::model::MonitorUserTemplateResourceType;usedatadog_api_client::datadogV2::model::MonitorUserTemplateTemplateVariablesItems;usedatadog_api_client::datadogV2::model::MonitorUserTemplateUpdateData;usedatadog_api_client::datadogV2::model::MonitorUserTemplateUpdateRequest;useserde_json::Value;usestd::collections::BTreeMap;#[tokio::main]asyncfnmain(){// there is a valid "monitor_user_template" in the system
letmonitor_user_template_data_id=std::env::var("MONITOR_USER_TEMPLATE_DATA_ID").unwrap();letbody=MonitorUserTemplateUpdateRequest::new(MonitorUserTemplateUpdateData::new(MonitorUserTemplateRequestAttributes::new(BTreeMap::from([("message".to_string(),Value::from("A msg.")),("name".to_string(),Value::from("A name example-monitor")),("query".to_string(),Value::from("avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100"),),("type".to_string(),Value::from("query alert")),]),vec!["integration:Azure".to_string()],"Postgres DB example-monitor".to_string(),).description(Some("A description.".to_string())).template_variables(vec![MonitorUserTemplateTemplateVariablesItems::new("regionName".to_string(),).available_values(vec!["value1".to_string(),"value2".to_string()]).defaults(vec!["defaultValue".to_string()]).tag_key("datacenter".to_string())]),monitor_user_template_data_id.clone(),MonitorUserTemplateResourceType::MONITOR_USER_TEMPLATE,));letmutconfiguration=datadog::Configuration::new();configuration.set_unstable_operation_enabled("v2.UpdateMonitorUserTemplate",true);letapi=MonitorsAPI::with_config(configuration);letresp=api.update_monitor_user_template(monitor_user_template_data_id.clone(),body).await;ifletOk(value)=resp{println!("{:#?}",value);}else{println!("{:#?}",resp.unwrap_err());}}
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com"DD_API_KEY="<API-KEY>"DD_APP_KEY="<APP-KEY>"cargo run
/**
* Update a monitor user template to a new version returns "OK" response
*/import{client,v2}from"@datadog/datadog-api-client";constconfiguration=client.createConfiguration();configuration.unstableOperations["v2.updateMonitorUserTemplate"]=true;constapiInstance=newv2.MonitorsApi(configuration);// there is a valid "monitor_user_template" in the system
constMONITOR_USER_TEMPLATE_DATA_ID=process.env.MONITOR_USER_TEMPLATE_DATA_IDasstring;constparams: v2.MonitorsApiUpdateMonitorUserTemplateRequest={body:{data:{attributes:{description:"A description.",monitorDefinition:{message:"A msg.",name:"A name example-monitor",query:"avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100",type:"query alert",},tags:["integration:Azure"],templateVariables:[{availableValues:["value1","value2"],defaults:["defaultValue"],name:"regionName",tagKey:"datacenter",},],title:"Postgres DB example-monitor",},id: MONITOR_USER_TEMPLATE_DATA_ID,type:"monitor-user-template",},},templateId: MONITOR_USER_TEMPLATE_DATA_ID,};apiInstance.updateMonitorUserTemplate(params).then((data: v2.MonitorUserTemplateResponse)=>{console.log("API called successfully. Returned data: "+JSON.stringify(data));}).catch((error: any)=>console.error(error));