--- title: Update a tag policy description: Datadog, the leading service for cloud-scale monitoring. breadcrumbs: Docs > API Reference > Tag Policies --- # Update a tag policy{% #update-a-tag-policy %} Copy pageCopied {% tab title="v2" %} **Note**: This endpoint is in preview and is subject to change. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). | Datadog site | API endpoint | | ----------------- | ------------------------------------------------------------------- | | ap1.datadoghq.com | PATCH https://api.ap1.datadoghq.com/api/v2/tag-policies/{policy_id} | | ap2.datadoghq.com | PATCH https://api.ap2.datadoghq.com/api/v2/tag-policies/{policy_id} | | app.datadoghq.eu | PATCH https://api.datadoghq.eu/api/v2/tag-policies/{policy_id} | | app.ddog-gov.com | PATCH https://api.ddog-gov.com/api/v2/tag-policies/{policy_id} | | us2.ddog-gov.com | PATCH https://api.us2.ddog-gov.com/api/v2/tag-policies/{policy_id} | | uk1.datadoghq.com | PATCH https://api.uk1.datadoghq.com/api/v2/tag-policies/{policy_id} | | app.datadoghq.com | PATCH https://api.datadoghq.com/api/v2/tag-policies/{policy_id} | | us3.datadoghq.com | PATCH https://api.us3.datadoghq.com/api/v2/tag-policies/{policy_id} | | us5.datadoghq.com | PATCH https://api.us5.datadoghq.com/api/v2/tag-policies/{policy_id} | ### Overview Update one or more attributes of an existing tag policy. Only the fields supplied in the request body are modified; omitted fields retain their current values. The policy's `source` cannot be changed after creation. ### Arguments #### Path Parameters | Name | Type | Description | | --------------------------- | ------ | -------------------------------------------------- | | policy_id [*required*] | string | The unique identifier of the tag policy to update. | ### Request #### Body Data (required) {% tab title="Model" %} | Parent field | Field | Type | Description | | ------------ | ---------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | data [*required*] | object | Data object for updating a tag policy. | | data | attributes | object | Mutable attributes of a tag policy. Each field is optional; omitting a field leaves its current value unchanged. The `source` of a policy cannot be changed. | | attributes | enabled | boolean | Whether the policy is currently enforced. | | attributes | negated | boolean | When `true`, the policy matches tag values that do NOT match any of the supplied patterns. | | attributes | policy_name | string | Human-readable name for the tag policy. | | attributes | policy_type | enum | How the policy is enforced. `blocking` rejects telemetry that violates the policy. `surfacing` only highlights non-compliant telemetry without blocking it. Allowed enum values: `blocking,surfacing` | | attributes | required | boolean | When `true`, telemetry without this tag is treated as a violation. | | attributes | scope | string | The scope the policy applies within. | | attributes | tag_key | string | The tag key that the policy governs. | | attributes | tag_value_patterns | [string] | One or more patterns that valid values for the tag key must match. | | data | id [*required*] | string | The unique identifier of the tag policy being updated. | | data | type [*required*] | enum | JSON:API resource type for a tag policy. Allowed enum values: `tag_policy` | {% /tab %} {% tab title="Example" %} ```json { "data": { "attributes": { "enabled": false, "negated": false, "policy_name": "string", "policy_type": "surfacing", "required": false, "scope": "string", "tag_key": "string", "tag_value_patterns": [] }, "id": "123", "type": "tag_policy" } } ``` {% /tab %} ### Response {% tab title="200" %} OK {% tab title="Model" %} A single tag policy. | Parent field | Field | Type | Description | | ------------- | ------------------------------------ | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | data [*required*] | object | A tag policy resource. | | data | attributes [*required*] | object | The attributes of a tag policy resource. | | attributes | created_at [*required*] | date-time | The RFC 3339 timestamp at which the policy was created. | | attributes | created_by [*required*] | string | The identifier of the user who created the policy. | | attributes | deleted_at | date-time | The RFC 3339 timestamp at which the policy was soft-deleted. `null` if the policy has not been deleted. Only present when `include_deleted=true` is requested. | | attributes | deleted_by | string | The identifier of the user who soft-deleted the policy. `null` if the policy has not been deleted. | | attributes | enabled [*required*] | boolean | Whether the policy is currently enforced. | | attributes | modified_at [*required*] | date-time | The RFC 3339 timestamp at which the policy was last modified. | | attributes | modified_by [*required*] | string | The identifier of the user who last modified the policy. | | attributes | negated [*required*] | boolean | When `true`, the policy matches tag values that do NOT match any of the supplied patterns. | | attributes | policy_name [*required*] | string | Human-readable name for the tag policy. | | attributes | policy_type [*required*] | enum | How the policy is enforced. `blocking` rejects telemetry that violates the policy. `surfacing` only highlights non-compliant telemetry without blocking it. Allowed enum values: `blocking,surfacing` | | attributes | required [*required*] | boolean | When `true`, telemetry without this tag is treated as a violation. | | attributes | scope [*required*] | string | The scope the policy applies within. | | attributes | source [*required*] | enum | The telemetry source that a tag policy applies to. Allowed enum values: `logs,spans,metrics,rum,feed` | | attributes | tag_key [*required*] | string | The tag key that the policy governs. | | attributes | tag_value_patterns [*required*] | [string] | The patterns that valid values for the tag key must match. | | attributes | version [*required*] | int64 | A monotonically increasing version counter that is incremented on each update. | | data | id [*required*] | string | The unique identifier of the tag policy. | | data | relationships | object | Related resources for a tag policy. Only present when the corresponding `include` query parameter is supplied. | | relationships | score | object | A relationship to the compliance score resource for this policy. | | score | data [*required*] | object | Identifier of the related compliance score resource. | | data | id [*required*] | string | The unique identifier of the related compliance score resource. | | data | type [*required*] | enum | JSON:API resource type for a tag policy compliance score. Allowed enum values: `tag_policy_score` | | data | type [*required*] | enum | JSON:API resource type for a tag policy. Allowed enum values: `tag_policy` | | | included | [object] | Related resources fetched alongside the primary tag policies. Populated when an `include` query parameter is supplied. | | included | attributes [*required*] | object | Attributes of a tag policy compliance score. | | attributes | score [*required*] | double | The compliance score for the policy over the requested time window, as a percentage between 0 and 100. `null` indicates that no relevant telemetry was found. | | attributes | ts_end [*required*] | int64 | End of the time window the score was computed over, as a Unix timestamp in milliseconds. | | attributes | ts_start [*required*] | int64 | Start of the time window the score was computed over, as a Unix timestamp in milliseconds. | | attributes | version [*required*] | int64 | The version of the tag policy that the score was computed against. | | included | id [*required*] | string | The unique identifier of the compliance score resource. | | included | type [*required*] | enum | JSON:API resource type for a tag policy compliance score. Allowed enum values: `tag_policy_score` | {% /tab %} {% tab title="Example" %} ```json { "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", "negated": false, "policy_name": "Service tag must be one of api or web", "policy_type": "surfacing", "required": true, "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_policy_score" } } }, "type": "tag_policy" }, "included": [ { "attributes": { "score": 80, "ts_end": 1779401466097, "ts_start": 1779315066097, "version": 1 }, "id": "123-v1-1779315066097-1779401466097", "type": "tag_policy_score" } ] } ``` {% /tab %} {% /tab %} {% tab title="400" %} Bad Request {% tab title="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 title="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 %} {% /tab %} {% tab title="401" %} Unauthorized {% tab title="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 title="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 %} {% /tab %} {% tab title="403" %} Forbidden {% tab title="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 title="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 %} {% /tab %} {% tab title="404" %} Not Found {% tab title="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 title="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 %} {% /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 policy_id="123" \# Curl command curl -X PATCH "https://api.datadoghq.com/api/v2/tag-policies/${policy_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, "policy_name": "Service tag must be one of api, web, or worker" }, "id": "123", "type": "tag_policy" } } EOF ##### ```python """ Update a tag policy returns "OK" response """ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v2.api.tag_policies_api import TagPoliciesApi from datadog_api_client.v2.model.tag_policy_resource_type import TagPolicyResourceType from datadog_api_client.v2.model.tag_policy_type import TagPolicyType from datadog_api_client.v2.model.tag_policy_update_attributes import TagPolicyUpdateAttributes from datadog_api_client.v2.model.tag_policy_update_data import TagPolicyUpdateData from datadog_api_client.v2.model.tag_policy_update_request import TagPolicyUpdateRequest body = TagPolicyUpdateRequest( data=TagPolicyUpdateData( attributes=TagPolicyUpdateAttributes( policy_type=TagPolicyType.SURFACING, tag_value_patterns=[], ), id="123", type=TagPolicyResourceType.TAG_POLICY, ), ) configuration = Configuration() configuration.unstable_operations["update_tag_policy"] = True with ApiClient(configuration) as api_client: api_instance = TagPoliciesApi(api_client) response = api_instance.update_tag_policy(policy_id="policy_id", body=body) print(response) ``` #### 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 # Update a tag policy returns "OK" response require "datadog_api_client" DatadogAPIClient.configure do |config| config.unstable_operations["v2.update_tag_policy".to_sym] = true end api_instance = DatadogAPIClient::V2::TagPoliciesAPI.new body = DatadogAPIClient::V2::TagPolicyUpdateRequest.new({ data: DatadogAPIClient::V2::TagPolicyUpdateData.new({ attributes: DatadogAPIClient::V2::TagPolicyUpdateAttributes.new({ policy_type: DatadogAPIClient::V2::TagPolicyType::SURFACING, tag_value_patterns: [], }), id: "123", type: DatadogAPIClient::V2::TagPolicyResourceType::TAG_POLICY, }), }) p api_instance.update_tag_policy("policy_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" ##### ```go // Update a tag policy 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.TagPolicyUpdateRequest{ Data: datadogV2.TagPolicyUpdateData{ Attributes: &datadogV2.TagPolicyUpdateAttributes{ PolicyType: datadogV2.TAGPOLICYTYPE_SURFACING.Ptr(), TagValuePatterns: []string{}, }, Id: "123", Type: datadogV2.TAGPOLICYRESOURCETYPE_TAG_POLICY, }, } ctx := datadog.NewDefaultContext(context.Background()) configuration := datadog.NewConfiguration() configuration.SetUnstableOperationEnabled("v2.UpdateTagPolicy", true) apiClient := datadog.NewAPIClient(configuration) api := datadogV2.NewTagPoliciesApi(apiClient) resp, r, err := api.UpdateTagPolicy(ctx, "policy_id", body) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `TagPoliciesApi.UpdateTagPolicy`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `TagPoliciesApi.UpdateTagPolicy`:\n%s\n", responseContent) } ``` #### 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 // Update a tag policy returns "OK" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v2.api.TagPoliciesApi; import com.datadog.api.client.v2.model.TagPolicyResourceType; import com.datadog.api.client.v2.model.TagPolicyResponse; import com.datadog.api.client.v2.model.TagPolicyType; import com.datadog.api.client.v2.model.TagPolicyUpdateAttributes; import com.datadog.api.client.v2.model.TagPolicyUpdateData; import com.datadog.api.client.v2.model.TagPolicyUpdateRequest; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); defaultClient.setUnstableOperationEnabled("v2.updateTagPolicy", true); TagPoliciesApi apiInstance = new TagPoliciesApi(defaultClient); TagPolicyUpdateRequest body = new TagPolicyUpdateRequest() .data( new TagPolicyUpdateData() .attributes(new TagPolicyUpdateAttributes().policyType(TagPolicyType.SURFACING)) .id("123") .type(TagPolicyResourceType.TAG_POLICY)); try { TagPolicyResponse result = apiInstance.updateTagPolicy("123", body); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling TagPoliciesApi#updateTagPolicy"); 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" ##### ```rust // Update a tag policy returns "OK" response use datadog_api_client::datadog; use datadog_api_client::datadogV2::api_tag_policies::TagPoliciesAPI; use datadog_api_client::datadogV2::model::TagPolicyResourceType; use datadog_api_client::datadogV2::model::TagPolicyType; use datadog_api_client::datadogV2::model::TagPolicyUpdateAttributes; use datadog_api_client::datadogV2::model::TagPolicyUpdateData; use datadog_api_client::datadogV2::model::TagPolicyUpdateRequest; #[tokio::main] async fn main() { let body = TagPolicyUpdateRequest::new( TagPolicyUpdateData::new("123".to_string(), TagPolicyResourceType::TAG_POLICY).attributes( TagPolicyUpdateAttributes::new() .policy_type(TagPolicyType::SURFACING) .tag_value_patterns(vec![]), ), ); let mut configuration = datadog::Configuration::new(); configuration.set_unstable_operation_enabled("v2.UpdateTagPolicy", true); let api = TagPoliciesAPI::with_config(configuration); let resp = api.update_tag_policy("policy_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](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 /** * Update a tag policy returns "OK" response */ import { client, v2 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration(); configuration.unstableOperations["v2.updateTagPolicy"] = true; const apiInstance = new v2.TagPoliciesApi(configuration); const params: v2.TagPoliciesApiUpdateTagPolicyRequest = { body: { data: { attributes: { policyType: "surfacing", tagValuePatterns: [], }, id: "123", type: "tag_policy", }, }, policyId: "policy_id", }; apiInstance .updateTagPolicy(params) .then((data: v2.TagPolicyResponse) => { 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 %}