--- title: Get a tag rule description: Retrieve a single tag rule by ID. breadcrumbs: ドキュメント > API > Get a tag rule --- > For the complete documentation index, see [llms.txt](https://dnd37xeb23o8n.cloudfront.net/stefon.simmons/docs-astro-web-10435/llms.txt). # Get a tag rule ## v2 (latest) {% alert level="warning" %} **Note**: This endpoint is in preview and is subject to change. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help.md). {% /alert %} | Datadog site | API endpoint | | ----------------- | ----------------------------------------------------------------------- | | app.datadoghq.com | GET https://api.datadoghq.com/api/v2/governance/tag_rules/{rule_id} | | us3.datadoghq.com | GET https://api.us3.datadoghq.com/api/v2/governance/tag_rules/{rule_id} | | us5.datadoghq.com | GET https://api.us5.datadoghq.com/api/v2/governance/tag_rules/{rule_id} | | app.datadoghq.eu | GET https://api.datadoghq.eu/api/v2/governance/tag_rules/{rule_id} | | ap1.datadoghq.com | GET https://api.ap1.datadoghq.com/api/v2/governance/tag_rules/{rule_id} | | ap2.datadoghq.com | GET https://api.ap2.datadoghq.com/api/v2/governance/tag_rules/{rule_id} | | uk1.datadoghq.com | GET https://api.uk1.datadoghq.com/api/v2/governance/tag_rules/{rule_id} | | app.ddog-gov.com | GET https://api.ddog-gov.com/api/v2/governance/tag_rules/{rule_id} | | us2.ddog-gov.com | GET https://api.us2.ddog-gov.com/api/v2/governance/tag_rules/{rule_id} | ### Overview Retrieve a single tag rule by ID. Optionally include the rule's current compliance score via the `include=score` query parameter. Rules belonging to other organizations cannot be retrieved. This endpoint requires any of the following permissions: - `telemetry_rules_read` - `metrics_read` ### Arguments #### Path Parameters | Field | Type | Description | | -------------------- | ------ | -------------------------------------- | | rule_id [*required*] | string | The unique identifier of the tag rule. | #### Query Strings | Field | Type | Description | | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | | include | enum | Comma-separated list of related resources to include alongside the rule. Currently the only supported value is `score`. Allowed enum values: `score`. | | ts_start | integer | Start of the time window used for compliance score computation, as a Unix timestamp in milliseconds. | | ts_end | integer | End of the time window used for compliance score computation, as a Unix timestamp in milliseconds. Must be in the past and greater than `ts_start`. | ### Response {% tabs %} {% tab label="200" %} OK {% tabs %} {% tab label="Model" %} A single tag rule. | Parent field | Field | Type | Description | | ------------- | ------------------------------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | data [*required*] | object | A tag rule resource. | | data | attributes [*required*] | object | The attributes of a tag rule resource. | | attributes | created_at [*required*] | date-time | The RFC 3339 timestamp at which the rule was created. | | attributes | created_by [*required*] | string | The identifier of the user who created the rule. | | attributes | 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. | | attributes | deleted_by | string | The identifier of the user who soft-deleted the rule. `null` if the rule has not been deleted. | | attributes | enabled [*required*] | boolean | Whether the rule is currently enforced. | | attributes | modified_at [*required*] | date-time | The RFC 3339 timestamp at which the rule was last modified. | | attributes | modified_by [*required*] | string | The identifier of the user who last modified the rule. | | attributes | name [*required*] | string | Human-readable name for the tag rule. | | attributes | negated [*required*] | boolean | When `true`, the rule matches tag values that do NOT match any of the supplied patterns. | | attributes | required [*required*] | boolean | When `true`, telemetry without this tag is treated as a violation. | | attributes | 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`. | | attributes | scope [*required*] | string | The scope the rule applies within. | | attributes | source [*required*] | enum | The telemetry source that a tag rule applies to. Allowed enum values: `logs`, `spans`, `metrics`, `rum`, `feed`. | | attributes | tag_key [*required*] | string | The tag key that the rule 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 rule. | | data | relationships | object | Related resources for a tag rule. Only present when the corresponding `include` query parameter is supplied. | | relationships | score | object | A relationship to the compliance score resource for this rule. | | 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 rule compliance score. Allowed enum values: `tag_rule_score`. | | data | 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. | | included | attributes [*required*] | object | Attributes of a tag rule compliance score. | | attributes | 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. | | 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 rule 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 rule compliance score. Allowed enum values: `tag_rule_score`. | {% /tab %} {% tab label="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", "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" } ] } ``` {% /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="401" %} Unauthorized {% 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="404" %} Not Found {% 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. | Field | Type | Description | | ------------------- | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% /tabs %} ### Code Example {% tabs %} {% tab label="Curl" %} ```bash # Path parameters export rule_id="123" # 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 GET "https://api.${DD_SITE}/api/v2/governance/tag_rules/${rule_id}" \ -H "Accept: application/json" \ -H "Authorization: Bearer ${DD_BEARER_TOKEN}" ``` {% /tab %} {% tab label="Go" %} ```go // Get 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() { ctx := datadog.NewDefaultContext(context.Background()) ctx = context.WithValue(ctx, datadog.ContextAccessToken, os.Getenv("DD_BEARER_TOKEN")) configuration := datadog.NewConfiguration() configuration.SetUnstableOperationEnabled("v2.GetTagRule", true) apiClient := datadog.NewAPIClient(configuration) api := datadogV2.NewTagRulesApi(apiClient) resp, r, err := api.GetTagRule(ctx, "rule_id", *datadogV2.NewGetTagRuleOptionalParameters()) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `TagRulesApi.GetTagRule`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `TagRulesApi.GetTagRule`:\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 // Get 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.TagRuleResponse; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN")); defaultClient.setUnstableOperationEnabled("v2.getTagRule", true); TagRulesApi apiInstance = new TagRulesApi(defaultClient); try { TagRuleResponse result = apiInstance.getTagRule("123"); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling TagRulesApi#getTagRule"); 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 """ Get a tag rule returns "OK" response """ from os import environ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v2.api.tag_rules_api import TagRulesApi configuration = Configuration() configuration.access_token = environ["DD_BEARER_TOKEN"] configuration.unstable_operations["get_tag_rule"] = True with ApiClient(configuration) as api_client: api_instance = TagRulesApi(api_client) response = api_instance.get_tag_rule( rule_id="rule_id", ) 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 # Get a tag rule returns "OK" response require "datadog_api_client" DatadogAPIClient.configure do |config| config.access_token = ENV["DD_BEARER_TOKEN"] config.unstable_operations["v2.get_tag_rule".to_sym] = true end api_instance = DatadogAPIClient::V2::TagRulesAPI.new p api_instance.get_tag_rule("rule_id") ``` #### 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 // Get a tag rule returns "OK" response use datadog_api_client::datadog; use datadog_api_client::datadogV2::api_tag_rules::GetTagRuleOptionalParams; use datadog_api_client::datadogV2::api_tag_rules::TagRulesAPI; #[tokio::main] async fn main() { let mut configuration = datadog::Configuration::new(); configuration.set_unstable_operation_enabled("v2.get_tag_rule", true); let api = TagRulesAPI::with_config(configuration); let resp = api .get_tag_rule("rule_id".to_string(), GetTagRuleOptionalParams::default()) .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 /** * Get a tag rule returns "OK" 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.getTagRule"] = true; const apiInstance = new v2.TagRulesApi(configuration); const params: v2.TagRulesApiGetTagRuleRequest = { ruleId: "rule_id", }; apiInstance .getTagRule(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](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 %}