--- title: Create a tag indexing rule exemption description: Exempt a metric from all tag indexing rules. The response includes the created exemption resource. Requires the Manage Tags for Metrics permission. breadcrumbs: Documentación > API > Create a tag indexing rule exemption --- > For the complete documentation index, see [llms.txt](https://dnd37xeb23o8n.cloudfront.net/stefon.simmons/docs-astro-web-10435/llms.txt). # Create a tag indexing rule exemption ## v2 (latest) {% alert level="warning" %} **Note**: The Tag Indexing Rules feature is currently in Preview. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help.md). {% /alert %} | Datadog site | API endpoint | | ----------------- | -------------------------------------------------------------------------------------------- | | app.datadoghq.com | POST https://api.datadoghq.com/api/v2/metrics/{metric_name}/tag-indexing-rule-exemptions | | us3.datadoghq.com | POST https://api.us3.datadoghq.com/api/v2/metrics/{metric_name}/tag-indexing-rule-exemptions | | us5.datadoghq.com | POST https://api.us5.datadoghq.com/api/v2/metrics/{metric_name}/tag-indexing-rule-exemptions | | app.datadoghq.eu | POST https://api.datadoghq.eu/api/v2/metrics/{metric_name}/tag-indexing-rule-exemptions | | ap1.datadoghq.com | POST https://api.ap1.datadoghq.com/api/v2/metrics/{metric_name}/tag-indexing-rule-exemptions | | ap2.datadoghq.com | POST https://api.ap2.datadoghq.com/api/v2/metrics/{metric_name}/tag-indexing-rule-exemptions | | uk1.datadoghq.com | POST https://api.uk1.datadoghq.com/api/v2/metrics/{metric_name}/tag-indexing-rule-exemptions | | app.ddog-gov.com | POST https://api.ddog-gov.com/api/v2/metrics/{metric_name}/tag-indexing-rule-exemptions | | us2.ddog-gov.com | POST https://api.us2.ddog-gov.com/api/v2/metrics/{metric_name}/tag-indexing-rule-exemptions | ### Overview Exempt a metric from all tag indexing rules. The response includes the created exemption resource. Requires the `Manage Tags for Metrics` permission. This endpoint requires the `metric_tags_write` permission. OAuth apps require the `metric_tags_write` authorization [scope](https://dnd37xeb23o8n.cloudfront.net/stefon.simmons/docs-astro-web-10435/es/api/latest/scopes.md#metrics) to access this endpoint. ### Arguments #### Path Parameters | Field | Type | Description | | ------------------------ | ------ | ----------------------- | | metric_name [*required*] | string | The name of the metric. | ### Request #### Body Data (required) {% tabs %} {% tab label="Model" %} | Parent field | Field | Type | Description | | ------------ | ----------------------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------- | | | data [*required*] | object | Data object for creating a tag indexing rule exemption. | | data | attributes [*required*] | object | Attributes for creating a tag indexing rule exemption. | | attributes | reason [*required*] | string | The reason the metric is exempt from tag indexing rules. | | data | type [*required*] | enum | The tag indexing rule exemption resource type. Allowed enum values: `tag_indexing_rule_exemptions`. Default: `tag_indexing_rule_exemptions`. | {% /tab %} {% tab label="Example" %} ```json { "data": { "attributes": { "reason": "This metric has a pre-existing tag configuration." }, "type": "tag_indexing_rule_exemptions" } } ``` {% /tab %} {% /tabs %} ### Response {% tabs %} {% tab label="201" %} Created {% tabs %} {% tab label="Model" %} Response containing a tag indexing rule exemption. | Parent field | Field | Type | Description | | ------------ | -------------------------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | data | object | A tag indexing rule exemption resource object. | | data | attributes | object | Attributes of a tag indexing rule exemption. | | attributes | created_at | date-time | Timestamp when the exemption was created. Read-only. | | attributes | created_by_handle | string | Handle of the user who created the exemption. Read-only. | | attributes | estimated_change_in_volume | int64 | Estimated change in indexed cardinality or points if the exemption is removed and the matching tag indexing rule applies to the metric. A negative value indicates a reduction in indexed volume, a positive value indicates an increase, and zero indicates no change. A `null` value indicates that the estimate is unavailable. Read-only. | | attributes | kind | string | Discriminates between an explicit exemption (`exemption`) and a pre-existing legacy tag configuration acting as an implicit exclusion (`legacy_tag_configuration`). | | attributes | missing_indexed_tags | [string] | Tag keys used to query this metric in monitors, dashboards, notebooks, and SLOs that the matching rule would remove or not include if the exemption is removed. Read-only. | | attributes | reason | string | The reason the metric is exempt from tag indexing rules. | | attributes | volume_status | enum | Indicates whether `estimated_change_in_volume` is available and, if not, why. `ok` indicates a fresh estimate. `unindexed_tags` indicates that the matching rule uses tags that are not indexed for the metric. `unavailable` indicates that the estimate is stale, was not computed, or could not be retrieved. Read-only. Allowed enum values: `ok`, `unindexed_tags`, `unavailable`. | | data | id | string | The metric name, used as the resource ID. | | data | type | enum | The tag indexing rule exemption resource type. Allowed enum values: `tag_indexing_rule_exemptions`. Default: `tag_indexing_rule_exemptions`. | {% /tab %} {% tab label="Example" %} ```json { "data": { "attributes": { "created_at": "2024-01-15T12:00:00.000Z", "created_by_handle": "user@datadoghq.com", "estimated_change_in_volume": 45, "kind": "exemption", "missing_indexed_tags": [ "service" ], "reason": "This metric has a pre-existing tag configuration.", "volume_status": "unavailable" }, "id": "dd.test.metric", "type": "tag_indexing_rule_exemptions" } } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="400" %} Bad Request {% tabs %} {% tab label="Model" %} API error response. | Parent field | Field | Type | Description | | ------------ | ------------------- | -------- | ------------------------------------------------------------------------------- | | | errors [*required*] | [object] | A list of errors. | | errors | detail | string | A human-readable explanation specific to this occurrence of the error. | | errors | meta | object | Non-standard meta-information about the error | | errors | source | object | References to the source of the error. | | source | header | string | A string indicating the name of a single request header which caused the error. | | source | parameter | string | A string indicating which URI query parameter caused the error. | | source | pointer | string | A JSON pointer to the value in the request document that caused the error. | | errors | status | string | Status code of the response. | | errors | title | string | Short human-readable summary of the error. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ { "detail": "Missing required attribute in body", "meta": {}, "source": { "header": "Authorization", "parameter": "limit", "pointer": "/data/attributes/title" }, "status": "400", "title": "Bad Request" } ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="403" %} Forbidden {% tabs %} {% tab label="Model" %} API error response. | Parent field | Field | Type | Description | | ------------ | ------------------- | -------- | ------------------------------------------------------------------------------- | | | errors [*required*] | [object] | A list of errors. | | errors | detail | string | A human-readable explanation specific to this occurrence of the error. | | errors | meta | object | Non-standard meta-information about the error | | errors | source | object | References to the source of the error. | | source | header | string | A string indicating the name of a single request header which caused the error. | | source | parameter | string | A string indicating which URI query parameter caused the error. | | source | pointer | string | A JSON pointer to the value in the request document that caused the error. | | errors | status | string | Status code of the response. | | errors | title | string | Short human-readable summary of the error. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ { "detail": "Missing required attribute in body", "meta": {}, "source": { "header": "Authorization", "parameter": "limit", "pointer": "/data/attributes/title" }, "status": "400", "title": "Bad Request" } ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="429" %} Too Many Requests {% tabs %} {% tab label="Model" %} API error response. | Parent field | Field | Type | Description | | ------------ | ------------------- | -------- | ------------------------------------------------------------------------------- | | | errors [*required*] | [object] | A list of errors. | | errors | detail | string | A human-readable explanation specific to this occurrence of the error. | | errors | meta | object | Non-standard meta-information about the error | | errors | source | object | References to the source of the error. | | source | header | string | A string indicating the name of a single request header which caused the error. | | source | parameter | string | A string indicating which URI query parameter caused the error. | | source | pointer | string | A JSON pointer to the value in the request document that caused the error. | | errors | status | string | Status code of the response. | | errors | title | string | Short human-readable summary of the error. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ { "detail": "Missing required attribute in body", "meta": {}, "source": { "header": "Authorization", "parameter": "limit", "pointer": "/data/attributes/title" }, "status": "400", "title": "Bad Request" } ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% /tabs %} ### Code Example {% tabs %} {% tab label="Curl" %} ```bash # Path parameters export metric_name="dist.http.endpoint.request" # Set your Datadog site and credentials export DD_SITE="datadoghq.com" # Or us3.datadoghq.com, us5.datadoghq.com, datadoghq.eu, ap1.datadoghq.com, ap2.datadoghq.com, uk1.datadoghq.com, ddog-gov.com, us2.ddog-gov.com # Use a Personal Access Token or Service Access Token export DD_BEARER_TOKEN="" curl -X POST "https://api.${DD_SITE}/api/v2/metrics/${metric_name}/tag-indexing-rule-exemptions" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer ${DD_BEARER_TOKEN}" \ -d @- << EOF { "data": { "attributes": { "reason": "This metric has a pre-existing tag configuration." }, "type": "tag_indexing_rule_exemptions" } } EOF ``` {% /tab %} {% tab label="Go" %} ```go // Create a tag indexing rule exemption returns "Created" response package main import ( "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" ) func main() { body := datadogV2.TagIndexingRuleExemptionCreateRequest{ Data: datadogV2.TagIndexingRuleExemptionCreateData{ Attributes: datadogV2.TagIndexingRuleExemptionCreateAttributes{ Reason: "This metric has a pre-existing tag configuration.", }, Type: datadogV2.TAGINDEXINGRULEEXEMPTIONTYPE_TAG_INDEXING_RULE_EXEMPTIONS, }, } ctx := datadog.NewDefaultContext(context.Background()) ctx = context.WithValue(ctx, datadog.ContextAccessToken, os.Getenv("DD_BEARER_TOKEN")) configuration := datadog.NewConfiguration() configuration.SetUnstableOperationEnabled("v2.CreateTagIndexingRuleExemption", true) apiClient := datadog.NewAPIClient(configuration) api := datadogV2.NewMetricsApi(apiClient) resp, r, err := api.CreateTagIndexingRuleExemption(ctx, "metric_name", body) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `MetricsApi.CreateTagIndexingRuleExemption`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `MetricsApi.CreateTagIndexingRuleExemption`:\n%s\n", responseContent) } ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=go) and then save the example to `main.go` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" go run "main.go" ``` {% /tab %} {% tab label="Java" %} ```java // Create a tag indexing rule exemption returns "Created" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v2.api.MetricsApi; import com.datadog.api.client.v2.model.TagIndexingRuleExemptionCreateAttributes; import com.datadog.api.client.v2.model.TagIndexingRuleExemptionCreateData; import com.datadog.api.client.v2.model.TagIndexingRuleExemptionCreateRequest; import com.datadog.api.client.v2.model.TagIndexingRuleExemptionResponse; import com.datadog.api.client.v2.model.TagIndexingRuleExemptionType; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN")); defaultClient.setUnstableOperationEnabled("v2.createTagIndexingRuleExemption", true); MetricsApi apiInstance = new MetricsApi(defaultClient); TagIndexingRuleExemptionCreateRequest body = new TagIndexingRuleExemptionCreateRequest() .data( new TagIndexingRuleExemptionCreateData() .attributes( new TagIndexingRuleExemptionCreateAttributes() .reason("This metric has a pre-existing tag configuration.")) .type(TagIndexingRuleExemptionType.TAG_INDEXING_RULE_EXEMPTIONS)); try { TagIndexingRuleExemptionResponse result = apiInstance.createTagIndexingRuleExemption("dist.http.endpoint.request", body); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling MetricsApi#createTagIndexingRuleExemption"); 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://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=java) and then save the example to `Example.java` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" java "Example.java" ``` {% /tab %} {% tab label="Python" %} ```python """ Create a tag indexing rule exemption returns "Created" response """ from os import environ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v2.api.metrics_api import MetricsApi from datadog_api_client.v2.model.tag_indexing_rule_exemption_create_attributes import ( TagIndexingRuleExemptionCreateAttributes, ) from datadog_api_client.v2.model.tag_indexing_rule_exemption_create_data import TagIndexingRuleExemptionCreateData from datadog_api_client.v2.model.tag_indexing_rule_exemption_create_request import TagIndexingRuleExemptionCreateRequest from datadog_api_client.v2.model.tag_indexing_rule_exemption_type import TagIndexingRuleExemptionType body = TagIndexingRuleExemptionCreateRequest( data=TagIndexingRuleExemptionCreateData( attributes=TagIndexingRuleExemptionCreateAttributes( reason="This metric has a pre-existing tag configuration.", ), type=TagIndexingRuleExemptionType.TAG_INDEXING_RULE_EXEMPTIONS, ), ) configuration = Configuration() configuration.access_token = environ["DD_BEARER_TOKEN"] configuration.unstable_operations["create_tag_indexing_rule_exemption"] = True with ApiClient(configuration) as api_client: api_instance = MetricsApi(api_client) response = api_instance.create_tag_indexing_rule_exemption(metric_name="metric_name", body=body) print(response) ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=python) and then save the example to `example.py` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" python3 "example.py" ``` {% /tab %} {% tab label="Ruby" %} ```ruby # Create a tag indexing rule exemption returns "Created" response require "datadog_api_client" DatadogAPIClient.configure do |config| config.access_token = ENV["DD_BEARER_TOKEN"] config.unstable_operations["v2.create_tag_indexing_rule_exemption".to_sym] = true end api_instance = DatadogAPIClient::V2::MetricsAPI.new body = DatadogAPIClient::V2::TagIndexingRuleExemptionCreateRequest.new({ data: DatadogAPIClient::V2::TagIndexingRuleExemptionCreateData.new({ attributes: DatadogAPIClient::V2::TagIndexingRuleExemptionCreateAttributes.new({ reason: "This metric has a pre-existing tag configuration.", }), type: DatadogAPIClient::V2::TagIndexingRuleExemptionType::TAG_INDEXING_RULE_EXEMPTIONS, }), }) p api_instance.create_tag_indexing_rule_exemption("metric_name", body) ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=ruby) and then save the example to `example.rb` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" rb "example.rb" ``` {% /tab %} {% tab label="Rust" %} ```rust // Create a tag indexing rule exemption returns "Created" response use datadog_api_client::datadog; use datadog_api_client::datadogV2::api_metrics::MetricsAPI; use datadog_api_client::datadogV2::model::TagIndexingRuleExemptionCreateAttributes; use datadog_api_client::datadogV2::model::TagIndexingRuleExemptionCreateData; use datadog_api_client::datadogV2::model::TagIndexingRuleExemptionCreateRequest; use datadog_api_client::datadogV2::model::TagIndexingRuleExemptionType; #[tokio::main] async fn main() { let body = TagIndexingRuleExemptionCreateRequest::new(TagIndexingRuleExemptionCreateData::new( TagIndexingRuleExemptionCreateAttributes::new( "This metric has a pre-existing tag configuration.".to_string(), ), TagIndexingRuleExemptionType::TAG_INDEXING_RULE_EXEMPTIONS, )); let mut configuration = datadog::Configuration::new(); configuration.set_unstable_operation_enabled("v2.create_tag_indexing_rule_exemption", true); let api = MetricsAPI::with_config(configuration); let resp = api .create_tag_indexing_rule_exemption("metric_name".to_string(), body) .await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=rust) and then save the example to `src/main.rs` and run following commands: ```bash DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" cargo run ``` {% /tab %} {% tab label="TypeScript" %} ```typescript /** * Create a tag indexing rule exemption returns "Created" response */ import { client, v2 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration({ authMethods: { AuthZ: { accessToken: process.env.DD_BEARER_TOKEN as string, }, }, }); configuration.unstableOperations["v2.createTagIndexingRuleExemption"] = true; const apiInstance = new v2.MetricsApi(configuration); const params: v2.MetricsApiCreateTagIndexingRuleExemptionRequest = { body: { data: { attributes: { reason: "This metric has a pre-existing tag configuration.", }, type: "tag_indexing_rule_exemptions", }, }, metricName: "metric_name", }; apiInstance .createTagIndexingRuleExemption(params) .then((data: v2.TagIndexingRuleExemptionResponse) => { 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://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=typescript) and then save the example to `example.ts` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" tsc "example.ts" ``` {% /tab %} {% /tabs %}