--- title: Validate an existing monitor user template description: Datadog, the leading service for cloud-scale monitoring. breadcrumbs: Docs > API Reference > Monitors --- # Validate an existing monitor user template{% #validate-an-existing-monitor-user-template %} Copy pageCopied {% tab title="v2" %} **Note**: This endpoint is in Preview. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). | Datadog site | API endpoint | | ----------------- | --------------------------------------------------------------------------------- | | ap1.datadoghq.com | POST https://api.ap1.datadoghq.com/api/v2/monitor/template/{template_id}/validate | | ap2.datadoghq.com | POST https://api.ap2.datadoghq.com/api/v2/monitor/template/{template_id}/validate | | app.datadoghq.eu | POST https://api.datadoghq.eu/api/v2/monitor/template/{template_id}/validate | | app.ddog-gov.com | POST https://api.ddog-gov.com/api/v2/monitor/template/{template_id}/validate | | us2.ddog-gov.com | POST https://api.us2.ddog-gov.com/api/v2/monitor/template/{template_id}/validate | | app.datadoghq.com | POST https://api.datadoghq.com/api/v2/monitor/template/{template_id}/validate | | us3.datadoghq.com | POST https://api.us3.datadoghq.com/api/v2/monitor/template/{template_id}/validate | | us5.datadoghq.com | POST https://api.us5.datadoghq.com/api/v2/monitor/template/{template_id}/validate | ### Overview Validate the structure and content of an existing monitor user template being updated to a new version. This endpoint requires the `monitor_config_policy_write` permission. ### Arguments #### Path Parameters | Name | Type | Description | | ----------------------------- | ------ | -------------------------------- | | template_id [*required*] | string | ID of the monitor user template. | ### Request #### Body Data (required) {% tab title="Model" %} | Parent field | Field | Type | Description | | ------------------ | ------------------------------------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------------ | | | data [*required*] | object | Monitor user template data. | | data | attributes [*required*] | object | Attributes for a monitor user template. | | attributes | description | string | A brief description of the monitor user template. | | attributes | monitor_definition [*required*] | object | A valid monitor definition in the same format as the [V1 Monitor API](https://docs.datadoghq.com/api/latest/monitors.md#create-a-monitor). | | attributes | tags [*required*] | [string] | The definition of `MonitorUserTemplateTags` object. | | attributes | template_variables | [object] | The definition of `MonitorUserTemplateTemplateVariables` object. | | template_variables | available_values | [string] | Available values for the variable. | | template_variables | defaults | [string] | Default values of the template variable. | | template_variables | name [*required*] | string | The name of the template variable. | | template_variables | tag_key | string | The tag key associated with the variable. This works the same as dashboard template variables. | | attributes | title [*required*] | string | The title of the monitor user template. | | data | id [*required*] | string | The unique identifier. | | data | type [*required*] | enum | Monitor user template resource type. Allowed enum values: `monitor-user-template` | {% /tab %} {% tab title="Example" %} ```json { "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" } } ``` {% /tab %} ### Response {% tab title="204" %} OK {% /tab %} {% tab title="400" %} Bad Request {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="404" %} Not Found {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="429" %} Too many requests {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} ### Code Example ##### \## default # \# Path parameters export template_id="00000000-0000-1234-0000-000000000000" \# Curl command curl -X POST "https://api.datadoghq.com/api/v2/monitor/template/${template_id}/validate" \ -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 ##### ```go // Validate an existing monitor user template returns "OK" response package main import ( "context" "fmt" "os" "github.com/DataDog/datadog-api-client-go/v2/api/datadog" "github.com/DataDog/datadog-api-client-go/v2/api/datadogV2" ) func main() { // there is a valid "monitor_user_template" in the system MonitorUserTemplateDataID := 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.ValidateExistingMonitorUserTemplate", true) apiClient := datadog.NewAPIClient(configuration) api := datadogV2.NewMonitorsApi(apiClient) r, err := api.ValidateExistingMonitorUserTemplate(ctx, MonitorUserTemplateDataID, body) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `MonitorsApi.ValidateExistingMonitorUserTemplate`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=go) and then save the example to `main.go` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" go run "main.go" ##### ```java // Validate an existing monitor user template returns "OK" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v2.api.MonitorsApi; import com.datadog.api.client.v2.model.MonitorUserTemplateRequestAttributes; import com.datadog.api.client.v2.model.MonitorUserTemplateResourceType; import com.datadog.api.client.v2.model.MonitorUserTemplateTemplateVariablesItems; import com.datadog.api.client.v2.model.MonitorUserTemplateUpdateData; import com.datadog.api.client.v2.model.MonitorUserTemplateUpdateRequest; import java.util.Arrays; import java.util.Collections; import java.util.Map; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); defaultClient.setUnstableOperationEnabled("v2.validateExistingMonitorUserTemplate", true); MonitorsApi apiInstance = new MonitorsApi(defaultClient); // there is a valid "monitor_user_template" in the system String MONITOR_USER_TEMPLATE_DATA_ID = System.getenv("MONITOR_USER_TEMPLATE_DATA_ID"); MonitorUserTemplateUpdateRequest body = new MonitorUserTemplateUpdateRequest() .data( new MonitorUserTemplateUpdateData() .attributes( new MonitorUserTemplateRequestAttributes() .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( new MonitorUserTemplateTemplateVariablesItems() .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 { apiInstance.validateExistingMonitorUserTemplate(MONITOR_USER_TEMPLATE_DATA_ID, body); } catch (ApiException e) { System.err.println("Exception when calling MonitorsApi#validateExistingMonitorUserTemplate"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=java) and then save the example to `Example.java` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" java "Example.java" ##### ```python """ Validate an existing monitor user template returns "OK" response """ from os import environ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v2.api.monitors_api import MonitorsApi from datadog_api_client.v2.model.monitor_user_template_request_attributes import MonitorUserTemplateRequestAttributes from datadog_api_client.v2.model.monitor_user_template_resource_type import MonitorUserTemplateResourceType from datadog_api_client.v2.model.monitor_user_template_template_variables_items import ( MonitorUserTemplateTemplateVariablesItems, ) from datadog_api_client.v2.model.monitor_user_template_update_data import MonitorUserTemplateUpdateData from datadog_api_client.v2.model.monitor_user_template_update_request import MonitorUserTemplateUpdateRequest # there is a valid "monitor_user_template" in the system MONITOR_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["validate_existing_monitor_user_template"] = True with ApiClient(configuration) as api_client: api_instance = MonitorsApi(api_client) api_instance.validate_existing_monitor_user_template(template_id=MONITOR_USER_TEMPLATE_DATA_ID, body=body) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=python) and then save the example to `example.py` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" python3 "example.py" ##### ```ruby # Validate an existing monitor user template returns "OK" response require "datadog_api_client" DatadogAPIClient.configure do |config| config.unstable_operations["v2.validate_existing_monitor_user_template".to_sym] = true end api_instance = DatadogAPIClient::V2::MonitorsAPI.new # there is a valid "monitor_user_template" in the system MONITOR_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, }), }) api_instance.validate_existing_monitor_user_template(MONITOR_USER_TEMPLATE_DATA_ID, body) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=ruby) and then save the example to `example.rb` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" rb "example.rb" ##### ```rust // Validate an existing monitor user template returns "OK" response use datadog_api_client::datadog; use datadog_api_client::datadogV2::api_monitors::MonitorsAPI; use datadog_api_client::datadogV2::model::MonitorUserTemplateRequestAttributes; use datadog_api_client::datadogV2::model::MonitorUserTemplateResourceType; use datadog_api_client::datadogV2::model::MonitorUserTemplateTemplateVariablesItems; use datadog_api_client::datadogV2::model::MonitorUserTemplateUpdateData; use datadog_api_client::datadogV2::model::MonitorUserTemplateUpdateRequest; use serde_json::Value; use std::collections::BTreeMap; #[tokio::main] async fn main() { // there is a valid "monitor_user_template" in the system let monitor_user_template_data_id = std::env::var("MONITOR_USER_TEMPLATE_DATA_ID").unwrap(); let body = 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, )); let mut configuration = datadog::Configuration::new(); configuration.set_unstable_operation_enabled("v2.ValidateExistingMonitorUserTemplate", true); let api = MonitorsAPI::with_config(configuration); let resp = api .validate_existing_monitor_user_template(monitor_user_template_data_id.clone(), body) .await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=rust) and then save the example to `src/main.rs` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" cargo run ##### ```typescript /** * Validate an existing monitor user template returns "OK" response */ import { client, v2 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration(); configuration.unstableOperations["v2.validateExistingMonitorUserTemplate"] = true; const apiInstance = new v2.MonitorsApi(configuration); // there is a valid "monitor_user_template" in the system const MONITOR_USER_TEMPLATE_DATA_ID = process.env .MONITOR_USER_TEMPLATE_DATA_ID as string; const params: v2.MonitorsApiValidateExistingMonitorUserTemplateRequest = { 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 .validateExistingMonitorUserTemplate(params) .then((data: any) => { console.log( "API called successfully. Returned data: " + JSON.stringify(data) ); }) .catch((error: any) => console.error(error)); ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=typescript) and then save the example to `example.ts` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" tsc "example.ts" {% /tab %}