Update a tag rule

Note: This endpoint is in preview and is subject to change. If you have any feedback, contact Datadog support.

PATCH https://api.ap1.datadoghq.com/api/v2/governance/tag_rules/{rule_id}https://api.ap2.datadoghq.com/api/v2/governance/tag_rules/{rule_id}https://api.datadoghq.eu/api/v2/governance/tag_rules/{rule_id}https://api.ddog-gov.com/api/v2/governance/tag_rules/{rule_id}https://api.us2.ddog-gov.com/api/v2/governance/tag_rules/{rule_id}https://api.uk1.datadoghq.com/api/v2/governance/tag_rules/{rule_id}https://api.datadoghq.com/api/v2/governance/tag_rules/{rule_id}https://api.us3.datadoghq.com/api/v2/governance/tag_rules/{rule_id}https://api.us5.datadoghq.com/api/v2/governance/tag_rules/{rule_id}

Overview

Update one or more attributes of an existing tag rule. Only the fields supplied in the request body are modified; omitted fields retain their current values. The rule’s source cannot be changed after creation. This endpoint requires the telemetry_rules_create permission.

Arguments

Path Parameters

Name

Type

Description

rule_id [required]

string

The unique identifier of the tag rule to update.

Request

Body Data (required)

Expand All

Field

Type

Description

data [required]

object

Data object for updating a tag rule.

attributes

object

Mutable attributes of a tag rule. Each field is optional; omitting a field leaves its current value unchanged. The source of a rule cannot be changed.

enabled

boolean

Whether the rule is currently enforced.

name

string

Human-readable name for the tag rule.

negated

boolean

When true, the rule matches tag values that do NOT match any of the supplied patterns.

required

boolean

When true, telemetry without this tag is treated as a violation.

rule_type

enum

How the rule is enforced. blocking rejects telemetry that violates the rule. surfacing only highlights non-compliant telemetry without blocking it. Allowed enum values: blocking,surfacing

scope

string

The scope the rule applies within.

tag_key

string

The tag key that the rule governs.

tag_value_patterns

[string]

One or more patterns that valid values for the tag key must match.

id [required]

string

The unique identifier of the tag rule being updated.

type [required]

enum

JSON:API resource type for a tag rule. Allowed enum values: tag_rule

{
  "data": {
    "attributes": {
      "enabled": false,
      "name": "string",
      "negated": false,
      "required": false,
      "rule_type": "surfacing",
      "scope": "string",
      "tag_key": "string",
      "tag_value_patterns": []
    },
    "id": "123",
    "type": "tag_rule"
  }
}

Response

OK

A single tag rule.

Expand All

Field

Type

Description

data [required]

object

A tag rule resource.

attributes [required]

object

The attributes of a tag rule resource.

created_at [required]

date-time

The RFC 3339 timestamp at which the rule was created.

created_by [required]

string

The identifier of the user who created the rule.

deleted_at

date-time

The RFC 3339 timestamp at which the rule was soft-deleted. null if the rule has not been deleted. Only present when include_deleted=true is requested.

deleted_by

string

The identifier of the user who soft-deleted the rule. null if the rule has not been deleted.

enabled [required]

boolean

Whether the rule is currently enforced.

modified_at [required]

date-time

The RFC 3339 timestamp at which the rule was last modified.

modified_by [required]

string

The identifier of the user who last modified the rule.

name [required]

string

Human-readable name for the tag rule.

negated [required]

boolean

When true, the rule matches tag values that do NOT match any of the supplied patterns.

required [required]

boolean

When true, telemetry without this tag is treated as a violation.

rule_type [required]

enum

How the rule is enforced. blocking rejects telemetry that violates the rule. surfacing only highlights non-compliant telemetry without blocking it. Allowed enum values: blocking,surfacing

scope [required]

string

The scope the rule applies within.

source [required]

enum

The telemetry source that a tag rule applies to. Allowed enum values: logs,spans,metrics,rum,feed

tag_key [required]

string

The tag key that the rule governs.

tag_value_patterns [required]

[string]

The patterns that valid values for the tag key must match.

version [required]

int64

A monotonically increasing version counter that is incremented on each update.

id [required]

string

The unique identifier of the tag rule.

relationships

object

Related resources for a tag rule. Only present when the corresponding include query parameter is supplied.

score

object

A relationship to the compliance score resource for this rule.

data [required]

object

Identifier of the related compliance score resource.

id [required]

string

The unique identifier of the related compliance score resource.

type [required]

enum

JSON:API resource type for a tag rule compliance score. Allowed enum values: tag_rule_score

type [required]

enum

JSON:API resource type for a tag rule. Allowed enum values: tag_rule

included

[object]

Related resources fetched alongside the primary tag rules. Populated when an include query parameter is supplied.

attributes [required]

object

Attributes of a tag rule compliance score.

score [required]

double

The compliance score for the rule over the requested time window, as a percentage between 0 and 100. null indicates that no relevant telemetry was found.

ts_end [required]

int64

End of the time window the score was computed over, as a Unix timestamp in milliseconds.

ts_start [required]

int64

Start of the time window the score was computed over, as a Unix timestamp in milliseconds.

version [required]

int64

The version of the tag rule that the score was computed against.

id [required]

string

The unique identifier of the compliance score resource.

type [required]

enum

JSON:API resource type for a tag rule compliance score. Allowed enum values: tag_rule_score

{
  "data": {
    "attributes": {
      "created_at": "2026-05-21T22:11:06.108696Z",
      "created_by": "test-user",
      "deleted_at": "2019-09-19T10:00:00.000Z",
      "deleted_by": "string",
      "enabled": true,
      "modified_at": "2026-05-21T22:11:06.108696Z",
      "modified_by": "test-user",
      "name": "Service tag must be one of api or web",
      "negated": false,
      "required": true,
      "rule_type": "surfacing",
      "scope": "env",
      "source": "logs",
      "tag_key": "service",
      "tag_value_patterns": [
        "api",
        "web"
      ],
      "version": 1
    },
    "id": "123",
    "relationships": {
      "score": {
        "data": {
          "id": "123-v1-1779315066097-1779401466097",
          "type": "tag_rule_score"
        }
      }
    },
    "type": "tag_rule"
  },
  "included": [
    {
      "attributes": {
        "score": 80,
        "ts_end": 1779401466097,
        "ts_start": 1779315066097,
        "version": 1
      },
      "id": "123-v1-1779315066097-1779401466097",
      "type": "tag_rule_score"
    }
  ]
}

Bad Request

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Unauthorized

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Forbidden

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Not Found

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Too many requests

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Code Example

                  ## default
# 

# Path parameters
export rule_id="123"
# Curl command
curl -X PATCH "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/governance/tag_rules/${rule_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": { "enabled": true, "name": "Service tag must be one of api, web, or worker" }, "id": "123", "type": "tag_rule" } } EOF
"""
Update a tag rule returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.tag_rules_api import TagRulesApi
from datadog_api_client.v2.model.tag_rule_resource_type import TagRuleResourceType
from datadog_api_client.v2.model.tag_rule_type import TagRuleType
from datadog_api_client.v2.model.tag_rule_update_attributes import TagRuleUpdateAttributes
from datadog_api_client.v2.model.tag_rule_update_data import TagRuleUpdateData
from datadog_api_client.v2.model.tag_rule_update_request import TagRuleUpdateRequest

body = TagRuleUpdateRequest(
    data=TagRuleUpdateData(
        attributes=TagRuleUpdateAttributes(
            rule_type=TagRuleType.SURFACING,
            tag_value_patterns=[],
        ),
        id="123",
        type=TagRuleResourceType.TAG_RULE,
    ),
)

configuration = Configuration()
configuration.unstable_operations["update_tag_rule"] = True
with ApiClient(configuration) as api_client:
    api_instance = TagRulesApi(api_client)
    response = api_instance.update_tag_rule(rule_id="rule_id", body=body)

    print(response)

Instructions

First install the library and its dependencies and then save the example to example.py and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" python3 "example.py"
# Update a tag rule returns "OK" response

require "datadog_api_client"
DatadogAPIClient.configure do |config|
  config.unstable_operations["v2.update_tag_rule".to_sym] = true
end
api_instance = DatadogAPIClient::V2::TagRulesAPI.new

body = DatadogAPIClient::V2::TagRuleUpdateRequest.new({
  data: DatadogAPIClient::V2::TagRuleUpdateData.new({
    attributes: DatadogAPIClient::V2::TagRuleUpdateAttributes.new({
      rule_type: DatadogAPIClient::V2::TagRuleType::SURFACING,
      tag_value_patterns: [],
    }),
    id: "123",
    type: DatadogAPIClient::V2::TagRuleResourceType::TAG_RULE,
  }),
})
p api_instance.update_tag_rule("rule_id", body)

Instructions

First install the library and its dependencies and then save the example to example.rb and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" rb "example.rb"
// Update a tag rule returns "OK" 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.TagRuleUpdateRequest{
		Data: datadogV2.TagRuleUpdateData{
			Attributes: &datadogV2.TagRuleUpdateAttributes{
				RuleType:         datadogV2.TAGRULETYPE_SURFACING.Ptr(),
				TagValuePatterns: []string{},
			},
			Id:   "123",
			Type: datadogV2.TAGRULERESOURCETYPE_TAG_RULE,
		},
	}
	ctx := datadog.NewDefaultContext(context.Background())
	configuration := datadog.NewConfiguration()
	configuration.SetUnstableOperationEnabled("v2.UpdateTagRule", true)
	apiClient := datadog.NewAPIClient(configuration)
	api := datadogV2.NewTagRulesApi(apiClient)
	resp, r, err := api.UpdateTagRule(ctx, "rule_id", body)

	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `TagRulesApi.UpdateTagRule`: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}

	responseContent, _ := json.MarshalIndent(resp, "", "  ")
	fmt.Fprintf(os.Stdout, "Response from `TagRulesApi.UpdateTagRule`:\n%s\n", responseContent)
}

Instructions

First install the library and its dependencies and then save the example to main.go and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" go run "main.go"
// Update a tag rule returns "OK" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.TagRulesApi;
import com.datadog.api.client.v2.model.TagRuleResourceType;
import com.datadog.api.client.v2.model.TagRuleResponse;
import com.datadog.api.client.v2.model.TagRuleType;
import com.datadog.api.client.v2.model.TagRuleUpdateAttributes;
import com.datadog.api.client.v2.model.TagRuleUpdateData;
import com.datadog.api.client.v2.model.TagRuleUpdateRequest;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = ApiClient.getDefaultApiClient();
    defaultClient.setUnstableOperationEnabled("v2.updateTagRule", true);
    TagRulesApi apiInstance = new TagRulesApi(defaultClient);

    TagRuleUpdateRequest body =
        new TagRuleUpdateRequest()
            .data(
                new TagRuleUpdateData()
                    .attributes(new TagRuleUpdateAttributes().ruleType(TagRuleType.SURFACING))
                    .id("123")
                    .type(TagRuleResourceType.TAG_RULE));

    try {
      TagRuleResponse result = apiInstance.updateTagRule("123", body);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling TagRulesApi#updateTagRule");
      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 and then save the example to Example.java and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" java "Example.java"
// Update a tag rule returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_tag_rules::TagRulesAPI;
use datadog_api_client::datadogV2::model::TagRuleResourceType;
use datadog_api_client::datadogV2::model::TagRuleType;
use datadog_api_client::datadogV2::model::TagRuleUpdateAttributes;
use datadog_api_client::datadogV2::model::TagRuleUpdateData;
use datadog_api_client::datadogV2::model::TagRuleUpdateRequest;

#[tokio::main]
async fn main() {
    let body = TagRuleUpdateRequest::new(
        TagRuleUpdateData::new("123".to_string(), TagRuleResourceType::TAG_RULE).attributes(
            TagRuleUpdateAttributes::new()
                .rule_type(TagRuleType::SURFACING)
                .tag_value_patterns(vec![]),
        ),
    );
    let mut configuration = datadog::Configuration::new();
    configuration.set_unstable_operation_enabled("v2.UpdateTagRule", true);
    let api = TagRulesAPI::with_config(configuration);
    let resp = api.update_tag_rule("rule_id".to_string(), body).await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}

Instructions

First install the library and its dependencies and then save the example to src/main.rs and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo run
/**
 * Update a tag rule returns "OK" response
 */

import { client, v2 } from "@datadog/datadog-api-client";

const configuration = client.createConfiguration();
configuration.unstableOperations["v2.updateTagRule"] = true;
const apiInstance = new v2.TagRulesApi(configuration);

const params: v2.TagRulesApiUpdateTagRuleRequest = {
  body: {
    data: {
      attributes: {
        ruleType: "surfacing",
        tagValuePatterns: [],
      },
      id: "123",
      type: "tag_rule",
    },
  },
  ruleId: "rule_id",
};

apiInstance
  .updateTagRule(params)
  .then((data: v2.TagRuleResponse) => {
    console.log(
      "API called successfully. Returned data: " + JSON.stringify(data)
    );
  })
  .catch((error: any) => console.error(error));

Instructions

First install the library and its dependencies and then save the example to example.ts and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" tsc "example.ts"