diff --git a/hugo/config/_default/menus/api.en.yaml b/hugo/config/_default/menus/api.en.yaml index 6cfc2089368..dc76f3dedd2 100644 --- a/hugo/config/_default/menus/api.en.yaml +++ b/hugo/config/_default/menus/api.en.yaml @@ -21059,85 +21059,85 @@ menu: - UpsertSyncConfig unstable: [] order: 1 - - name: Tag Policies - url: /api/latest/tag-policies/ - identifier: tag-policies + - name: Tag Rules + url: /api/latest/tag-rules/ + identifier: tag-rules generated: true - - name: Get a tag policy compliance score - url: /api/latest/tag-policies/get-a-tag-policy-compliance-score/ - identifier: tag-policies-get-a-tag-policy-compliance-score - parent: tag-policies + - name: Get a tag rule compliance score + url: /api/latest/tag-rules/get-a-tag-rule-compliance-score/ + identifier: tag-rules-get-a-tag-rule-compliance-score + parent: tag-rules generated: true params: versions: - v2 operationids: - - GetTagPolicyScore + - GetTagRuleScore unstable: - v2 order: 6 - - name: Update a tag policy - url: /api/latest/tag-policies/update-a-tag-policy/ - identifier: tag-policies-update-a-tag-policy - parent: tag-policies + - name: Update a tag rule + url: /api/latest/tag-rules/update-a-tag-rule/ + identifier: tag-rules-update-a-tag-rule + parent: tag-rules generated: true params: versions: - v2 operationids: - - UpdateTagPolicy + - UpdateTagRule unstable: - v2 order: 4 - - name: Get a tag policy - url: /api/latest/tag-policies/get-a-tag-policy/ - identifier: tag-policies-get-a-tag-policy - parent: tag-policies + - name: Get a tag rule + url: /api/latest/tag-rules/get-a-tag-rule/ + identifier: tag-rules-get-a-tag-rule + parent: tag-rules generated: true params: versions: - v2 operationids: - - GetTagPolicy + - GetTagRule unstable: - v2 order: 3 - - name: Delete a tag policy - url: /api/latest/tag-policies/delete-a-tag-policy/ - identifier: tag-policies-delete-a-tag-policy - parent: tag-policies + - name: Delete a tag rule + url: /api/latest/tag-rules/delete-a-tag-rule/ + identifier: tag-rules-delete-a-tag-rule + parent: tag-rules generated: true params: versions: - v2 operationids: - - DeleteTagPolicy + - DeleteTagRule unstable: - v2 order: 5 - - name: Create a tag policy - url: /api/latest/tag-policies/create-a-tag-policy/ - identifier: tag-policies-create-a-tag-policy - parent: tag-policies + - name: Create a tag rule + url: /api/latest/tag-rules/create-a-tag-rule/ + identifier: tag-rules-create-a-tag-rule + parent: tag-rules generated: true params: versions: - v2 operationids: - - CreateTagPolicy + - CreateTagRule unstable: - v2 order: 2 - - name: List tag policies - url: /api/latest/tag-policies/list-tag-policies/ - identifier: tag-policies-list-tag-policies - parent: tag-policies + - name: List tag rules + url: /api/latest/tag-rules/list-tag-rules/ + identifier: tag-rules-list-tag-rules + parent: tag-rules generated: true params: versions: - v2 operationids: - - ListTagPolicies + - ListTagRules unstable: - v2 order: 1 diff --git a/hugo/content/en/api/latest/tag-rules/_index.md b/hugo/content/en/api/latest/tag-rules/_index.md new file mode 100644 index 00000000000..77cdcd2939f --- /dev/null +++ b/hugo/content/en/api/latest/tag-rules/_index.md @@ -0,0 +1,3 @@ +--- +title: Tag Rules +--- diff --git a/hugo/content/en/api/latest/tag-rules/create-a-tag-rule/index.md b/hugo/content/en/api/latest/tag-rules/create-a-tag-rule/index.md new file mode 100644 index 00000000000..f5fdd282056 --- /dev/null +++ b/hugo/content/en/api/latest/tag-rules/create-a-tag-rule/index.md @@ -0,0 +1,3 @@ +--- +title: Create a tag rule +--- diff --git a/hugo/content/en/api/latest/tag-rules/delete-a-tag-rule/index.md b/hugo/content/en/api/latest/tag-rules/delete-a-tag-rule/index.md new file mode 100644 index 00000000000..bdf9ed321ee --- /dev/null +++ b/hugo/content/en/api/latest/tag-rules/delete-a-tag-rule/index.md @@ -0,0 +1,3 @@ +--- +title: Delete a tag rule +--- diff --git a/hugo/content/en/api/latest/tag-rules/get-a-tag-rule-compliance-score/index.md b/hugo/content/en/api/latest/tag-rules/get-a-tag-rule-compliance-score/index.md new file mode 100644 index 00000000000..25fa8b719fc --- /dev/null +++ b/hugo/content/en/api/latest/tag-rules/get-a-tag-rule-compliance-score/index.md @@ -0,0 +1,3 @@ +--- +title: Get a tag rule compliance score +--- diff --git a/hugo/content/en/api/latest/tag-rules/get-a-tag-rule/index.md b/hugo/content/en/api/latest/tag-rules/get-a-tag-rule/index.md new file mode 100644 index 00000000000..784c5f7601d --- /dev/null +++ b/hugo/content/en/api/latest/tag-rules/get-a-tag-rule/index.md @@ -0,0 +1,3 @@ +--- +title: Get a tag rule +--- diff --git a/hugo/content/en/api/latest/tag-rules/list-tag-rules/index.md b/hugo/content/en/api/latest/tag-rules/list-tag-rules/index.md new file mode 100644 index 00000000000..97b3eef7e4a --- /dev/null +++ b/hugo/content/en/api/latest/tag-rules/list-tag-rules/index.md @@ -0,0 +1,3 @@ +--- +title: List tag rules +--- diff --git a/hugo/content/en/api/latest/tag-rules/update-a-tag-rule/index.md b/hugo/content/en/api/latest/tag-rules/update-a-tag-rule/index.md new file mode 100644 index 00000000000..600dd1d735f --- /dev/null +++ b/hugo/content/en/api/latest/tag-rules/update-a-tag-rule/index.md @@ -0,0 +1,3 @@ +--- +title: Update a tag rule +--- diff --git a/hugo/content/en/api/v2/tag-rules/_index.md b/hugo/content/en/api/v2/tag-rules/_index.md new file mode 100644 index 00000000000..b1de2bf6a9a --- /dev/null +++ b/hugo/content/en/api/v2/tag-rules/_index.md @@ -0,0 +1,4 @@ +--- +title: Tag Rules +headless: true +--- diff --git a/hugo/content/en/api/v2/tag-rules/examples.json b/hugo/content/en/api/v2/tag-rules/examples.json new file mode 100644 index 00000000000..59ea26eaf2e --- /dev/null +++ b/hugo/content/en/api/v2/tag-rules/examples.json @@ -0,0 +1,788 @@ +{ + "ListTagRules": { + "responses": { + "200": { + "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" + } + ] + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of tag rule data objects.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The attributes of a tag rule resource.

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The RFC 3339 timestamp at which the rule was created.

\n
\n \n
\n
\n
\n
\n
\n

created_by [required]

\n
\n

string

\n

The identifier of the user who created the rule.

\n
\n \n
\n
\n
\n
\n
\n

deleted_at

\n
\n

date-time

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

deleted_by

\n
\n

string

\n

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

\n
\n \n
\n
\n
\n
\n
\n

enabled [required]

\n
\n

boolean

\n

Whether the rule is currently enforced.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

date-time

\n

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

\n
\n \n
\n
\n
\n
\n
\n

modified_by [required]

\n
\n

string

\n

The identifier of the user who last modified the rule.

\n
\n \n
\n
\n
\n
\n
\n

negated [required]

\n
\n

boolean

\n

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

\n
\n \n
\n
\n
\n
\n
\n

policy_name [required]

\n
\n

string

\n

Human-readable name for the tag rule.

\n
\n \n
\n
\n
\n
\n
\n

policy_type [required]

\n
\n

enum

\n

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

\n
\n \n
\n
\n
\n
\n
\n

required [required]

\n
\n

boolean

\n

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

\n
\n \n
\n
\n
\n
\n
\n

scope [required]

\n
\n

string

\n

The scope the rule applies within.

\n
\n \n
\n
\n
\n
\n
\n

source [required]

\n
\n

enum

\n

The telemetry source that a tag rule applies to. \nAllowed enum values: logs,spans,metrics

\n
\n \n
\n
\n
\n
\n
\n

tag_key [required]

\n
\n

string

\n

The tag key that the rule governs.

\n
\n \n
\n
\n
\n
\n
\n

tag_value_patterns [required]

\n
\n

[string]

\n

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

\n
\n \n
\n
\n
\n
\n
\n

version [required]

\n
\n

int64

\n

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

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the tag rule.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

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

\n
\n
\n
\n
\n
\n

score

\n
\n

object

\n

A relationship to the compliance score resource for this rule.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Identifier of the related compliance score resource.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the related compliance score resource.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

JSON:API resource type for a tag rule compliance score. \nAllowed enum values: tag_policy_score

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

JSON:API resource type for a tag rule. \nAllowed enum values: tag_policy

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[object]

\n

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

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of a tag rule compliance score.

\n
\n
\n
\n
\n
\n

score [required]

\n
\n

double

\n

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

\n
\n \n
\n
\n
\n
\n
\n

ts_end [required]

\n
\n

int64

\n

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

\n
\n \n
\n
\n
\n
\n
\n

ts_start [required]

\n
\n

int64

\n

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

\n
\n \n
\n
\n
\n
\n
\n

version [required]

\n
\n

int64

\n

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

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the compliance score resource.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

JSON:API resource type for a tag rule compliance score. \nAllowed enum values: tag_policy_score

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

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

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

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

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

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

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

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

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

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

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

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

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

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

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

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

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

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

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

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

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

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

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

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "CreateTagRule": { + "responses": { + "201": { + "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" + } + ] + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

A tag rule resource.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The attributes of a tag rule resource.

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The RFC 3339 timestamp at which the rule was created.

\n
\n \n
\n
\n
\n
\n
\n

created_by [required]

\n
\n

string

\n

The identifier of the user who created the rule.

\n
\n \n
\n
\n
\n
\n
\n

deleted_at

\n
\n

date-time

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

deleted_by

\n
\n

string

\n

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

\n
\n \n
\n
\n
\n
\n
\n

enabled [required]

\n
\n

boolean

\n

Whether the rule is currently enforced.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

date-time

\n

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

\n
\n \n
\n
\n
\n
\n
\n

modified_by [required]

\n
\n

string

\n

The identifier of the user who last modified the rule.

\n
\n \n
\n
\n
\n
\n
\n

negated [required]

\n
\n

boolean

\n

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

\n
\n \n
\n
\n
\n
\n
\n

policy_name [required]

\n
\n

string

\n

Human-readable name for the tag rule.

\n
\n \n
\n
\n
\n
\n
\n

policy_type [required]

\n
\n

enum

\n

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

\n
\n \n
\n
\n
\n
\n
\n

required [required]

\n
\n

boolean

\n

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

\n
\n \n
\n
\n
\n
\n
\n

scope [required]

\n
\n

string

\n

The scope the rule applies within.

\n
\n \n
\n
\n
\n
\n
\n

source [required]

\n
\n

enum

\n

The telemetry source that a tag rule applies to. \nAllowed enum values: logs,spans,metrics

\n
\n \n
\n
\n
\n
\n
\n

tag_key [required]

\n
\n

string

\n

The tag key that the rule governs.

\n
\n \n
\n
\n
\n
\n
\n

tag_value_patterns [required]

\n
\n

[string]

\n

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

\n
\n \n
\n
\n
\n
\n
\n

version [required]

\n
\n

int64

\n

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

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the tag rule.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

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

\n
\n
\n
\n
\n
\n

score

\n
\n

object

\n

A relationship to the compliance score resource for this rule.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Identifier of the related compliance score resource.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the related compliance score resource.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

JSON:API resource type for a tag rule compliance score. \nAllowed enum values: tag_policy_score

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

JSON:API resource type for a tag rule. \nAllowed enum values: tag_policy

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[object]

\n

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

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of a tag rule compliance score.

\n
\n
\n
\n
\n
\n

score [required]

\n
\n

double

\n

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

\n
\n \n
\n
\n
\n
\n
\n

ts_end [required]

\n
\n

int64

\n

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

\n
\n \n
\n
\n
\n
\n
\n

ts_start [required]

\n
\n

int64

\n

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

\n
\n \n
\n
\n
\n
\n
\n

version [required]

\n
\n

int64

\n

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

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the compliance score resource.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

JSON:API resource type for a tag rule compliance score. \nAllowed enum values: tag_policy_score

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

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

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

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

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

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

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

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

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

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

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

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

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

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

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

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

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

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

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

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

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

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

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

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

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

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

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

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

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

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

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

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": { + "data": { + "attributes": { + "policy_name": "Service tag must be one of api or web", + "policy_type": "surfacing", + "scope": "env", + "source": "logs", + "tag_key": "service", + "tag_value_patterns": [ + "api", + "web" + ] + }, + "type": "tag_policy" + } + }, + "json": { + "data": { + "attributes": { + "enabled": true, + "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" + ] + }, + "type": "tag_policy" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data object for creating a tag rule.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes that can be supplied when creating a tag rule.

\n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Whether the rule is currently enforced. Defaults to true for newly created rules.

\n
\n \n
\n
\n
\n
\n
\n

negated

\n
\n

boolean

\n

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

\n
\n \n
\n
\n
\n
\n
\n

policy_name [required]

\n
\n

string

\n

Human-readable name for the tag rule.

\n
\n \n
\n
\n
\n
\n
\n

policy_type [required]

\n
\n

enum

\n

The rule type allowed when creating a tag rule. Only surfacing is accepted at\ncreation time. \nAllowed enum values: surfacing

\n
\n \n
\n
\n
\n
\n
\n

required

\n
\n

boolean

\n

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

\n
\n \n
\n
\n
\n
\n
\n

scope [required]

\n
\n

string

\n

The scope the rule applies within. Typically an environment, team, or\norganization-level identifier used to limit where the rule is enforced.

\n
\n \n
\n
\n
\n
\n
\n

source [required]

\n
\n

enum

\n

The telemetry source that a tag rule applies to. \nAllowed enum values: logs,spans,metrics

\n
\n \n
\n
\n
\n
\n
\n

tag_key [required]

\n
\n

string

\n

The tag key that the rule governs (for example, service).

\n
\n \n
\n
\n
\n
\n
\n

tag_value_patterns [required]

\n
\n

[string]

\n

One or more patterns that valid values for the tag key must match. At least one\npattern is required.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

JSON:API resource type for a tag rule. \nAllowed enum values: tag_policy

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

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

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

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

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

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

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

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

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

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

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

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

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

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

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

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

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

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

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

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

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

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

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

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

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

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

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

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

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

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

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

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "GetTagRule": { + "responses": { + "200": { + "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" + } + ] + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

A tag rule resource.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The attributes of a tag rule resource.

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The RFC 3339 timestamp at which the rule was created.

\n
\n \n
\n
\n
\n
\n
\n

created_by [required]

\n
\n

string

\n

The identifier of the user who created the rule.

\n
\n \n
\n
\n
\n
\n
\n

deleted_at

\n
\n

date-time

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

deleted_by

\n
\n

string

\n

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

\n
\n \n
\n
\n
\n
\n
\n

enabled [required]

\n
\n

boolean

\n

Whether the rule is currently enforced.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

date-time

\n

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

\n
\n \n
\n
\n
\n
\n
\n

modified_by [required]

\n
\n

string

\n

The identifier of the user who last modified the rule.

\n
\n \n
\n
\n
\n
\n
\n

negated [required]

\n
\n

boolean

\n

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

\n
\n \n
\n
\n
\n
\n
\n

policy_name [required]

\n
\n

string

\n

Human-readable name for the tag rule.

\n
\n \n
\n
\n
\n
\n
\n

policy_type [required]

\n
\n

enum

\n

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

\n
\n \n
\n
\n
\n
\n
\n

required [required]

\n
\n

boolean

\n

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

\n
\n \n
\n
\n
\n
\n
\n

scope [required]

\n
\n

string

\n

The scope the rule applies within.

\n
\n \n
\n
\n
\n
\n
\n

source [required]

\n
\n

enum

\n

The telemetry source that a tag rule applies to. \nAllowed enum values: logs,spans,metrics

\n
\n \n
\n
\n
\n
\n
\n

tag_key [required]

\n
\n

string

\n

The tag key that the rule governs.

\n
\n \n
\n
\n
\n
\n
\n

tag_value_patterns [required]

\n
\n

[string]

\n

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

\n
\n \n
\n
\n
\n
\n
\n

version [required]

\n
\n

int64

\n

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

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the tag rule.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

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

\n
\n
\n
\n
\n
\n

score

\n
\n

object

\n

A relationship to the compliance score resource for this rule.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Identifier of the related compliance score resource.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the related compliance score resource.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

JSON:API resource type for a tag rule compliance score. \nAllowed enum values: tag_policy_score

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

JSON:API resource type for a tag rule. \nAllowed enum values: tag_policy

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[object]

\n

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

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of a tag rule compliance score.

\n
\n
\n
\n
\n
\n

score [required]

\n
\n

double

\n

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

\n
\n \n
\n
\n
\n
\n
\n

ts_end [required]

\n
\n

int64

\n

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

\n
\n \n
\n
\n
\n
\n
\n

ts_start [required]

\n
\n

int64

\n

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

\n
\n \n
\n
\n
\n
\n
\n

version [required]

\n
\n

int64

\n

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

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the compliance score resource.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

JSON:API resource type for a tag rule compliance score. \nAllowed enum values: tag_policy_score

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

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

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

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

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

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

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

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

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

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

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

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

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

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

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

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

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

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

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

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

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

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

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

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

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

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

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

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

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

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

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

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "UpdateTagRule": { + "responses": { + "200": { + "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" + } + ] + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

A tag rule resource.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The attributes of a tag rule resource.

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The RFC 3339 timestamp at which the rule was created.

\n
\n \n
\n
\n
\n
\n
\n

created_by [required]

\n
\n

string

\n

The identifier of the user who created the rule.

\n
\n \n
\n
\n
\n
\n
\n

deleted_at

\n
\n

date-time

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

deleted_by

\n
\n

string

\n

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

\n
\n \n
\n
\n
\n
\n
\n

enabled [required]

\n
\n

boolean

\n

Whether the rule is currently enforced.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

date-time

\n

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

\n
\n \n
\n
\n
\n
\n
\n

modified_by [required]

\n
\n

string

\n

The identifier of the user who last modified the rule.

\n
\n \n
\n
\n
\n
\n
\n

negated [required]

\n
\n

boolean

\n

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

\n
\n \n
\n
\n
\n
\n
\n

policy_name [required]

\n
\n

string

\n

Human-readable name for the tag rule.

\n
\n \n
\n
\n
\n
\n
\n

policy_type [required]

\n
\n

enum

\n

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

\n
\n \n
\n
\n
\n
\n
\n

required [required]

\n
\n

boolean

\n

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

\n
\n \n
\n
\n
\n
\n
\n

scope [required]

\n
\n

string

\n

The scope the rule applies within.

\n
\n \n
\n
\n
\n
\n
\n

source [required]

\n
\n

enum

\n

The telemetry source that a tag rule applies to. \nAllowed enum values: logs,spans,metrics

\n
\n \n
\n
\n
\n
\n
\n

tag_key [required]

\n
\n

string

\n

The tag key that the rule governs.

\n
\n \n
\n
\n
\n
\n
\n

tag_value_patterns [required]

\n
\n

[string]

\n

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

\n
\n \n
\n
\n
\n
\n
\n

version [required]

\n
\n

int64

\n

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

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the tag rule.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

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

\n
\n
\n
\n
\n
\n

score

\n
\n

object

\n

A relationship to the compliance score resource for this rule.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Identifier of the related compliance score resource.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the related compliance score resource.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

JSON:API resource type for a tag rule compliance score. \nAllowed enum values: tag_policy_score

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

JSON:API resource type for a tag rule. \nAllowed enum values: tag_policy

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[object]

\n

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

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of a tag rule compliance score.

\n
\n
\n
\n
\n
\n

score [required]

\n
\n

double

\n

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

\n
\n \n
\n
\n
\n
\n
\n

ts_end [required]

\n
\n

int64

\n

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

\n
\n \n
\n
\n
\n
\n
\n

ts_start [required]

\n
\n

int64

\n

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

\n
\n \n
\n
\n
\n
\n
\n

version [required]

\n
\n

int64

\n

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

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the compliance score resource.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

JSON:API resource type for a tag rule compliance score. \nAllowed enum values: tag_policy_score

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

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

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

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

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

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

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

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

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

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

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

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

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

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

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

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

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

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

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

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

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

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

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

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

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

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

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

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

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

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

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

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": { + "data": { + "id": "123", + "type": "tag_policy" + } + }, + "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" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data object for updating a tag rule.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

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

\n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Whether the rule is currently enforced.

\n
\n \n
\n
\n
\n
\n
\n

negated

\n
\n

boolean

\n

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

\n
\n \n
\n
\n
\n
\n
\n

policy_name

\n
\n

string

\n

Human-readable name for the tag rule.

\n
\n \n
\n
\n
\n
\n
\n

policy_type

\n
\n

enum

\n

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

\n
\n \n
\n
\n
\n
\n
\n

required

\n
\n

boolean

\n

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

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

The scope the rule applies within.

\n
\n \n
\n
\n
\n
\n
\n

tag_key

\n
\n

string

\n

The tag key that the rule governs.

\n
\n \n
\n
\n
\n
\n
\n

tag_value_patterns

\n
\n

[string]

\n

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

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the tag rule being updated.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

JSON:API resource type for a tag rule. \nAllowed enum values: tag_policy

\n
\n \n
\n
\n
\n
" + } + }, + "GetTagRuleScore": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "score": 80, + "ts_end": 1779401466097, + "ts_start": 1779315066097, + "version": 1 + }, + "id": "123-v1-1779315066097-1779401466097", + "type": "tag_policy_score" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

A compliance score resource for a tag rule.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of a tag rule compliance score.

\n
\n
\n
\n
\n
\n

score [required]

\n
\n

double

\n

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

\n
\n \n
\n
\n
\n
\n
\n

ts_end [required]

\n
\n

int64

\n

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

\n
\n \n
\n
\n
\n
\n
\n

ts_start [required]

\n
\n

int64

\n

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

\n
\n \n
\n
\n
\n
\n
\n

version [required]

\n
\n

int64

\n

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

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the compliance score resource.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

JSON:API resource type for a tag rule compliance score. \nAllowed enum values: tag_policy_score

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

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

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

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

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

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

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

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

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

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

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

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

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

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

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

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

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

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

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

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

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

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

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

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

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

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

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

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

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

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

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

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + } +} \ No newline at end of file diff --git a/hugo/data/api/v2/full_spec.yaml b/hugo/data/api/v2/full_spec.yaml index 441596194a8..5d65ce78300 100644 --- a/hugo/data/api/v2/full_spec.yaml +++ b/hugo/data/api/v2/full_spec.yaml @@ -111806,72 +111806,62 @@ components: format: int64 type: integer type: object - TagPoliciesListResponse: - description: A page of tag policies. - properties: - data: - $ref: "#/components/schemas/TagPolicyDataArray" - included: - $ref: "#/components/schemas/TagPolicyIncludedResources" - required: - - data - type: object - TagPolicyAttributes: - description: The attributes of a tag policy resource. + TagRuleAttributes: + description: The attributes of a tag rule resource. properties: created_at: - description: The RFC 3339 timestamp at which the policy was created. + description: The RFC 3339 timestamp at which the rule was created. example: "2026-05-21T22:11:06.108696Z" format: date-time type: string created_by: - description: The identifier of the user who created the policy. + description: The identifier of the user who created the rule. example: "test-user" type: string deleted_at: - description: 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. + description: 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. format: date-time nullable: true type: string deleted_by: - description: The identifier of the user who soft-deleted the policy. `null` if the policy has not been deleted. + description: The identifier of the user who soft-deleted the rule. `null` if the rule has not been deleted. nullable: true type: string enabled: - description: Whether the policy is currently enforced. + description: Whether the rule is currently enforced. example: true type: boolean modified_at: - description: The RFC 3339 timestamp at which the policy was last modified. + description: The RFC 3339 timestamp at which the rule was last modified. example: "2026-05-21T22:11:06.108696Z" format: date-time type: string modified_by: - description: The identifier of the user who last modified the policy. + description: The identifier of the user who last modified the rule. example: "test-user" type: string negated: - description: When `true`, the policy matches tag values that do NOT match any of the supplied patterns. + description: When `true`, the rule matches tag values that do NOT match any of the supplied patterns. example: false type: boolean policy_name: - description: Human-readable name for the tag policy. + description: Human-readable name for the tag rule. example: "Service tag must be one of api or web" type: string policy_type: - $ref: "#/components/schemas/TagPolicyType" + $ref: "#/components/schemas/TagRuleType" required: description: When `true`, telemetry without this tag is treated as a violation. example: true type: boolean scope: - description: The scope the policy applies within. + description: The scope the rule applies within. example: "env" type: string source: - $ref: "#/components/schemas/TagPolicySource" + $ref: "#/components/schemas/TagRuleSource" tag_key: - description: The tag key that the policy governs. + description: The tag key that the rule governs. example: "service" type: string tag_value_patterns: @@ -111904,37 +111894,37 @@ components: - modified_at - modified_by type: object - TagPolicyCreateAttributes: - description: Attributes that can be supplied when creating a tag policy. + TagRuleCreateAttributes: + description: Attributes that can be supplied when creating a tag rule. properties: enabled: - description: Whether the policy is currently enforced. Defaults to `true` for newly created policies. + description: Whether the rule is currently enforced. Defaults to `true` for newly created rules. example: true type: boolean negated: - description: When `true`, the policy matches tag values that do NOT match any of the supplied patterns. Defaults to `false`. + description: When `true`, the rule matches tag values that do NOT match any of the supplied patterns. Defaults to `false`. example: false type: boolean policy_name: - description: Human-readable name for the tag policy. + description: Human-readable name for the tag rule. example: "Service tag must be one of api or web" type: string policy_type: - $ref: "#/components/schemas/TagPolicyCreateType" + $ref: "#/components/schemas/TagRuleCreateType" required: description: When `true`, telemetry without this tag is treated as a violation. Defaults to `false`. example: true type: boolean scope: description: |- - The scope the policy applies within. Typically an environment, team, or - organization-level identifier used to limit where the policy is enforced. + The scope the rule applies within. Typically an environment, team, or + organization-level identifier used to limit where the rule is enforced. example: "env" type: string source: - $ref: "#/components/schemas/TagPolicySource" + $ref: "#/components/schemas/TagRuleSource" tag_key: - description: The tag key that the policy governs (for example, `service`). + description: The tag key that the rule governs (for example, `service`). example: "service" type: string tag_value_patterns: @@ -111957,28 +111947,28 @@ components: - tag_value_patterns - policy_type type: object - TagPolicyCreateData: - description: Data object for creating a tag policy. + TagRuleCreateData: + description: Data object for creating a tag rule. properties: attributes: - $ref: "#/components/schemas/TagPolicyCreateAttributes" + $ref: "#/components/schemas/TagRuleCreateAttributes" type: - $ref: "#/components/schemas/TagPolicyResourceType" + $ref: "#/components/schemas/TagRuleResourceType" required: - type - attributes type: object - TagPolicyCreateRequest: - description: Payload for creating a new tag policy. + TagRuleCreateRequest: + description: Payload for creating a new tag rule. properties: data: - $ref: "#/components/schemas/TagPolicyCreateData" + $ref: "#/components/schemas/TagRuleCreateData" required: - data type: object - TagPolicyCreateType: + TagRuleCreateType: description: |- - The policy type allowed when creating a tag policy. Only `surfacing` is accepted at + The rule type allowed when creating a tag rule. Only `surfacing` is accepted at creation time. enum: - surfacing @@ -111986,72 +111976,72 @@ components: type: string x-enum-varnames: - SURFACING - TagPolicyData: - description: A tag policy resource. + TagRuleData: + description: A tag rule resource. properties: attributes: - $ref: "#/components/schemas/TagPolicyAttributes" + $ref: "#/components/schemas/TagRuleAttributes" id: - description: The unique identifier of the tag policy. + description: The unique identifier of the tag rule. example: "123" type: string relationships: - $ref: "#/components/schemas/TagPolicyRelationships" + $ref: "#/components/schemas/TagRuleRelationships" type: - $ref: "#/components/schemas/TagPolicyResourceType" + $ref: "#/components/schemas/TagRuleResourceType" required: - type - id - attributes type: object - TagPolicyDataArray: - description: An array of tag policy data objects. + TagRuleDataArray: + description: An array of tag rule data objects. items: - $ref: "#/components/schemas/TagPolicyData" + $ref: "#/components/schemas/TagRuleData" type: array - TagPolicyInclude: - description: A related resource to include alongside a tag policy in the response. Currently the only supported value is `score`. + TagRuleInclude: + description: A related resource to include alongside a tag rule in the response. Currently the only supported value is `score`. enum: - score example: "score" type: string x-enum-varnames: - SCORE - TagPolicyIncludedResources: - description: Related resources fetched alongside the primary tag policies. Populated when an `include` query parameter is supplied. + TagRuleIncludedResources: + description: Related resources fetched alongside the primary tag rules. Populated when an `include` query parameter is supplied. items: - $ref: "#/components/schemas/TagPolicyScoreData" + $ref: "#/components/schemas/TagRuleScoreData" type: array - TagPolicyRelationships: - description: Related resources for a tag policy. Only present when the corresponding `include` query parameter is supplied. + TagRuleRelationships: + description: Related resources for a tag rule. Only present when the corresponding `include` query parameter is supplied. properties: score: - $ref: "#/components/schemas/TagPolicyScoreRelationship" + $ref: "#/components/schemas/TagRuleScoreRelationship" type: object - TagPolicyResourceType: - description: JSON:API resource type for a tag policy. + TagRuleResourceType: + description: JSON:API resource type for a tag rule. enum: - tag_policy example: "tag_policy" type: string x-enum-varnames: - TAG_POLICY - TagPolicyResponse: - description: A single tag policy. + TagRuleResponse: + description: A single tag rule. properties: data: - $ref: "#/components/schemas/TagPolicyData" + $ref: "#/components/schemas/TagRuleData" included: - $ref: "#/components/schemas/TagPolicyIncludedResources" + $ref: "#/components/schemas/TagRuleIncludedResources" required: - data type: object - TagPolicyScoreAttributes: - description: Attributes of a tag policy compliance score. + TagRuleScoreAttributes: + description: Attributes of a tag rule compliance score. properties: score: description: |- - The compliance score for the policy over the requested time window, as a percentage + 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. example: 80 format: double @@ -112068,7 +112058,7 @@ components: format: int64 type: integer version: - description: The version of the tag policy that the score was computed against. + description: The version of the tag rule that the score was computed against. example: 1 format: int64 type: integer @@ -112078,31 +112068,31 @@ components: - ts_end - version type: object - TagPolicyScoreData: - description: A compliance score resource for a tag policy. + TagRuleScoreData: + description: A compliance score resource for a tag rule. properties: attributes: - $ref: "#/components/schemas/TagPolicyScoreAttributes" + $ref: "#/components/schemas/TagRuleScoreAttributes" id: description: The unique identifier of the compliance score resource. example: "123-v1-1779315066097-1779401466097" type: string type: - $ref: "#/components/schemas/TagPolicyScoreResourceType" + $ref: "#/components/schemas/TagRuleScoreResourceType" required: - type - id - attributes type: object - TagPolicyScoreRelationship: - description: A relationship to the compliance score resource for this policy. + TagRuleScoreRelationship: + description: A relationship to the compliance score resource for this rule. properties: data: - $ref: "#/components/schemas/TagPolicyScoreRelationshipData" + $ref: "#/components/schemas/TagRuleScoreRelationshipData" required: - data type: object - TagPolicyScoreRelationshipData: + TagRuleScoreRelationshipData: description: Identifier of the related compliance score resource. properties: id: @@ -112110,46 +112100,42 @@ components: example: "123-v1-1779315066097-1779401466097" type: string type: - $ref: "#/components/schemas/TagPolicyScoreResourceType" + $ref: "#/components/schemas/TagRuleScoreResourceType" required: - type - id type: object - TagPolicyScoreResourceType: - description: JSON:API resource type for a tag policy compliance score. + TagRuleScoreResourceType: + description: JSON:API resource type for a tag rule compliance score. enum: - tag_policy_score example: "tag_policy_score" type: string x-enum-varnames: - TAG_POLICY_SCORE - TagPolicyScoreResponse: - description: A tag policy compliance score. + TagRuleScoreResponse: + description: A tag rule compliance score. properties: data: - $ref: "#/components/schemas/TagPolicyScoreData" + $ref: "#/components/schemas/TagRuleScoreData" required: - data type: object - TagPolicySource: - description: The telemetry source that a tag policy applies to. + TagRuleSource: + description: The telemetry source that a tag rule applies to. enum: - logs - spans - metrics - - rum - - feed example: "logs" type: string x-enum-varnames: - LOGS - SPANS - METRICS - - RUM - - FEED - TagPolicyType: + TagRuleType: description: |- - How the policy is enforced. `blocking` rejects telemetry that violates the policy. + How the rule is enforced. `blocking` rejects telemetry that violates the rule. `surfacing` only highlights non-compliant telemetry without blocking it. enum: - blocking @@ -112159,30 +112145,30 @@ components: x-enum-varnames: - BLOCKING - SURFACING - TagPolicyUpdateAttributes: + TagRuleUpdateAttributes: description: |- - 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. + 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. properties: enabled: - description: Whether the policy is currently enforced. + description: Whether the rule is currently enforced. type: boolean negated: - description: When `true`, the policy matches tag values that do NOT match any of the supplied patterns. + description: When `true`, the rule matches tag values that do NOT match any of the supplied patterns. type: boolean policy_name: - description: Human-readable name for the tag policy. + description: Human-readable name for the tag rule. type: string policy_type: - $ref: "#/components/schemas/TagPolicyType" + $ref: "#/components/schemas/TagRuleType" required: description: When `true`, telemetry without this tag is treated as a violation. type: boolean scope: - description: The scope the policy applies within. + description: The scope the rule applies within. type: string tag_key: - description: The tag key that the policy governs. + description: The tag key that the rule governs. type: string tag_value_patterns: description: One or more patterns that valid values for the tag key must match. @@ -112191,26 +112177,36 @@ components: type: string type: array type: object - TagPolicyUpdateData: - description: Data object for updating a tag policy. + TagRuleUpdateData: + description: Data object for updating a tag rule. properties: attributes: - $ref: "#/components/schemas/TagPolicyUpdateAttributes" + $ref: "#/components/schemas/TagRuleUpdateAttributes" id: - description: The unique identifier of the tag policy being updated. + description: The unique identifier of the tag rule being updated. example: "123" type: string type: - $ref: "#/components/schemas/TagPolicyResourceType" + $ref: "#/components/schemas/TagRuleResourceType" required: - type - id type: object - TagPolicyUpdateRequest: - description: Payload for updating an existing tag policy. Only the supplied fields are modified. + TagRuleUpdateRequest: + description: Payload for updating an existing tag rule. Only the supplied fields are modified. properties: data: - $ref: "#/components/schemas/TagPolicyUpdateData" + $ref: "#/components/schemas/TagRuleUpdateData" + required: + - data + type: object + TagRulesListResponse: + description: A page of tag rules. + properties: + data: + $ref: "#/components/schemas/TagRuleDataArray" + included: + $ref: "#/components/schemas/TagRuleIncludedResources" required: - data type: object @@ -210194,38 +210190,38 @@ paths: /api/v2/tag_policies: get: description: |- - Retrieve all tag policies for the organization. Optionally include disabled or deleted - policies, filter by telemetry source, and include each policy's current compliance score + Retrieve all tag rules for the organization. Optionally include disabled or deleted + rules, filter by telemetry source, and include each rule's current compliance score via the `include=score` query parameter. - operationId: ListTagPolicies + operationId: ListTagRules parameters: - - description: Whether to include policies that are currently disabled. Defaults to `false`. + - description: Whether to include rules that are currently disabled. Defaults to `false`. example: false in: query name: include_disabled required: false schema: type: boolean - - description: Whether to include policies that have been soft-deleted. Defaults to `false`. + - description: Whether to include rules that have been soft-deleted. Defaults to `false`. example: false in: query name: include_deleted required: false schema: type: boolean - - description: Comma-separated list of related resources to include alongside each policy in the response. Currently the only supported value is `score`. + - description: Comma-separated list of related resources to include alongside each rule in the response. Currently the only supported value is `score`. example: "score" in: query name: include required: false schema: - $ref: "#/components/schemas/TagPolicyInclude" - - description: Restrict the result set to policies whose source matches the given value. + $ref: "#/components/schemas/TagRuleInclude" + - description: Restrict the result set to rules whose source matches the given value. in: query name: filter[source] required: false schema: - $ref: "#/components/schemas/TagPolicySource" + $ref: "#/components/schemas/TagRuleSource" - description: Start of the time window used for compliance score computation, as a Unix timestamp in milliseconds. Defaults to a recent window appropriate for the source. example: 1779315066097 in: query @@ -210283,7 +210279,7 @@ paths: id: "123-v1-1779315066097-1779401466097" type: "tag_policy_score" schema: - $ref: "#/components/schemas/TagPoliciesListResponse" + $ref: "#/components/schemas/TagRulesListResponse" description: OK "400": content: @@ -210308,9 +210304,9 @@ paths: security: - apiKeyAuth: [] appKeyAuth: [] - summary: List tag policies + summary: List tag rules tags: - - Tag Policies + - Tag Rules x-menu-order: 1 "x-permission": operator: OR @@ -210322,10 +210318,10 @@ paths: If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). post: description: |- - Create a new tag policy for the organization. The caller's organization is derived from + Create a new tag rule for the organization. The caller's organization is derived from the authenticated user; cross-organization creation is not supported. Fields such as `policy_id`, `version`, and the timestamp/audit fields are assigned by the server. - operationId: CreateTagPolicy + operationId: CreateTagRule requestBody: content: application/json: @@ -210347,7 +210343,7 @@ paths: - "web" type: "tag_policy" schema: - $ref: "#/components/schemas/TagPolicyCreateRequest" + $ref: "#/components/schemas/TagRuleCreateRequest" required: true responses: "201": @@ -210377,7 +210373,7 @@ paths: id: "123" type: "tag_policy" schema: - $ref: "#/components/schemas/TagPolicyResponse" + $ref: "#/components/schemas/TagRuleResponse" description: Created "400": content: @@ -210408,9 +210404,9 @@ paths: security: - apiKeyAuth: [] appKeyAuth: [] - summary: Create a tag policy + summary: Create a tag rule tags: - - Tag Policies + - Tag Rules x-menu-order: 2 "x-permission": operator: AND @@ -210422,19 +210418,19 @@ paths: /api/v2/tag_policies/{policy_id}: delete: description: |- - Delete a tag policy. By default the policy is soft-deleted so it can be recovered later + Delete a tag rule. By default the rule is soft-deleted so it can be recovered later and so that historical score data remains queryable. Pass `hard_delete=true` to remove - the policy permanently. - operationId: DeleteTagPolicy + the rule permanently. + operationId: DeleteTagRule parameters: - - description: The unique identifier of the tag policy to delete. + - description: The unique identifier of the tag rule to delete. example: "123" in: path name: policy_id required: true schema: type: string - - description: Whether to permanently delete the policy instead of performing a soft delete. Defaults to `false`. + - description: Whether to permanently delete the rule instead of performing a soft delete. Defaults to `false`. example: false in: query name: hard_delete @@ -210473,9 +210469,9 @@ paths: security: - apiKeyAuth: [] appKeyAuth: [] - summary: Delete a tag policy + summary: Delete a tag rule tags: - - Tag Policies + - Tag Rules x-menu-order: 5 "x-permission": operator: AND @@ -210486,25 +210482,25 @@ paths: If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). get: description: |- - Retrieve a single tag policy by ID. Optionally include the policy's current compliance - score via the `include=score` query parameter. Policies belonging to other organizations + 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. - operationId: GetTagPolicy + operationId: GetTagRule parameters: - - description: The unique identifier of the tag policy. + - description: The unique identifier of the tag rule. example: "123" in: path name: policy_id required: true schema: type: string - - description: Comma-separated list of related resources to include alongside the policy. Currently the only supported value is `score`. + - description: Comma-separated list of related resources to include alongside the rule. Currently the only supported value is `score`. example: "score" in: query name: include required: false schema: - $ref: "#/components/schemas/TagPolicyInclude" + $ref: "#/components/schemas/TagRuleInclude" - description: Start of the time window used for compliance score computation, as a Unix timestamp in milliseconds. example: 1779315066097 in: query @@ -210562,7 +210558,7 @@ paths: id: "123-v1-1779315066097-1779401466097" type: "tag_policy_score" schema: - $ref: "#/components/schemas/TagPolicyResponse" + $ref: "#/components/schemas/TagRuleResponse" description: OK "400": content: @@ -210593,9 +210589,9 @@ paths: security: - apiKeyAuth: [] appKeyAuth: [] - summary: Get a tag policy + summary: Get a tag rule tags: - - Tag Policies + - Tag Rules x-menu-order: 3 "x-permission": operator: OR @@ -210607,12 +210603,12 @@ paths: If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). patch: description: |- - 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 + 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. - operationId: UpdateTagPolicy + operationId: UpdateTagRule parameters: - - description: The unique identifier of the tag policy to update. + - description: The unique identifier of the tag rule to update. example: "123" in: path name: policy_id @@ -210632,7 +210628,7 @@ paths: id: "123" type: "tag_policy" schema: - $ref: "#/components/schemas/TagPolicyUpdateRequest" + $ref: "#/components/schemas/TagRuleUpdateRequest" required: true responses: "200": @@ -210662,7 +210658,7 @@ paths: id: "123" type: "tag_policy" schema: - $ref: "#/components/schemas/TagPolicyResponse" + $ref: "#/components/schemas/TagRuleResponse" description: OK "400": content: @@ -210693,9 +210689,9 @@ paths: security: - apiKeyAuth: [] appKeyAuth: [] - summary: Update a tag policy + summary: Update a tag rule tags: - - Tag Policies + - Tag Rules x-menu-order: 4 "x-permission": operator: AND @@ -210707,13 +210703,13 @@ paths: /api/v2/tag_policies/{policy_id}/score: get: description: |- - Retrieve the compliance score for a single tag policy. The score is computed over the + Retrieve the compliance score for a single tag rule. The score is computed over the requested time window (or a source-appropriate default) and represents the percentage of - telemetry within that window that conforms to the policy. A `null` score indicates that + telemetry within that window that conforms to the rule. A `null` score indicates that no relevant telemetry was found. - operationId: GetTagPolicyScore + operationId: GetTagRuleScore parameters: - - description: The unique identifier of the tag policy. + - description: The unique identifier of the tag rule. example: "123" in: path name: policy_id @@ -210752,7 +210748,7 @@ paths: id: "123-v1-1779315066097-1779401466097" type: "tag_policy_score" schema: - $ref: "#/components/schemas/TagPolicyScoreResponse" + $ref: "#/components/schemas/TagRuleScoreResponse" description: OK "400": content: @@ -210783,9 +210779,9 @@ paths: security: - apiKeyAuth: [] appKeyAuth: [] - summary: Get a tag policy compliance score + summary: Get a tag rule compliance score tags: - - Tag Policies + - Tag Rules x-menu-order: 6 "x-permission": operator: OR @@ -217085,12 +217081,12 @@ tags: For more information, see the [Synthetic Monitoring documentation](https://docs.datadoghq.com/synthetics/). name: Synthetics - description: |- - Tag Policies define rules that govern which tag values are accepted for a given tag key, - scoped to a particular telemetry source (such as logs, spans, or metrics). Policies can be - `blocking` (data not matching the policy is rejected) or `surfacing` (matching data is - highlighted but not blocked). Each policy reports a compliance `score` derived from how - much recent telemetry adheres to the policy. - name: Tag Policies + Tag Rules define rules that govern which tag values are accepted for a given tag key, + scoped to a particular telemetry source (such as logs, spans, or metrics). Rules can be + `blocking` (data not matching the rule is rejected) or `surfacing` (matching data is + highlighted but not blocked). Each rule reports a compliance `score` derived from how + much recent telemetry adheres to the rule. + name: Tag Rules - description: View and manage teams within Datadog. See the [Teams page](https://docs.datadoghq.com/account_management/teams/) for more information. name: Teams - description: |- diff --git a/hugo/data/api/v2/translate_actions.json b/hugo/data/api/v2/translate_actions.json index 33058aff922..4f304a548c6 100644 --- a/hugo/data/api/v2/translate_actions.json +++ b/hugo/data/api/v2/translate_actions.json @@ -6833,33 +6833,33 @@ "request_description": "JSON Patch document with operations to apply.", "request_schema_description": "JSON Patch request for global variable." }, - "ListTagPolicies": { - "description": "Retrieve all tag policies for the organization. Optionally include disabled or deleted\npolicies, filter by telemetry source, and include each policy's current compliance score\nvia the `include=score` query parameter.", - "summary": "List tag policies" + "ListTagRules": { + "description": "Retrieve all tag rules for the organization. Optionally include disabled or deleted\nrules, filter by telemetry source, and include each rule's current compliance score\nvia the `include=score` query parameter.", + "summary": "List tag rules" }, - "CreateTagPolicy": { - "description": "Create a new tag policy for the organization. The caller's organization is derived from\nthe authenticated user; cross-organization creation is not supported. Fields such as\n`policy_id`, `version`, and the timestamp/audit fields are assigned by the server.", - "summary": "Create a tag policy", + "CreateTagRule": { + "description": "Create a new tag rule for the organization. The caller's organization is derived from\nthe authenticated user; cross-organization creation is not supported. Fields such as\n`policy_id`, `version`, and the timestamp/audit fields are assigned by the server.", + "summary": "Create a tag rule", "request_description": "", - "request_schema_description": "Payload for creating a new tag policy." + "request_schema_description": "Payload for creating a new tag rule." }, - "DeleteTagPolicy": { - "description": "Delete a tag policy. By default the policy is soft-deleted so it can be recovered later\nand so that historical score data remains queryable. Pass `hard_delete=true` to remove\nthe policy permanently.", - "summary": "Delete a tag policy" + "DeleteTagRule": { + "description": "Delete a tag rule. By default the rule is soft-deleted so it can be recovered later\nand so that historical score data remains queryable. Pass `hard_delete=true` to remove\nthe rule permanently.", + "summary": "Delete a tag rule" }, - "GetTagPolicy": { - "description": "Retrieve a single tag policy by ID. Optionally include the policy's current compliance\nscore via the `include=score` query parameter. Policies belonging to other organizations\ncannot be retrieved.", - "summary": "Get a tag policy" + "GetTagRule": { + "description": "Retrieve a single tag rule by ID. Optionally include the rule's current compliance\nscore via the `include=score` query parameter. Rules belonging to other organizations\ncannot be retrieved.", + "summary": "Get a tag rule" }, - "UpdateTagPolicy": { - "description": "Update one or more attributes of an existing tag policy. Only the fields supplied in the\nrequest body are modified; omitted fields retain their current values. The policy's\n`source` cannot be changed after creation.", - "summary": "Update a tag policy", + "UpdateTagRule": { + "description": "Update one or more attributes of an existing tag rule. Only the fields supplied in the\nrequest body are modified; omitted fields retain their current values. The rule's\n`source` cannot be changed after creation.", + "summary": "Update a tag rule", "request_description": "", - "request_schema_description": "Payload for updating an existing tag policy. Only the supplied fields are modified." + "request_schema_description": "Payload for updating an existing tag rule. Only the supplied fields are modified." }, - "GetTagPolicyScore": { - "description": "Retrieve the compliance score for a single tag policy. The score is computed over the\nrequested time window (or a source-appropriate default) and represents the percentage of\ntelemetry within that window that conforms to the policy. A `null` score indicates that\nno relevant telemetry was found.", - "summary": "Get a tag policy compliance score" + "GetTagRuleScore": { + "description": "Retrieve the compliance score for a single tag rule. The score is computed over the\nrequested time window (or a source-appropriate default) and represents the percentage of\ntelemetry within that window that conforms to the rule. A `null` score indicates that\nno relevant telemetry was found.", + "summary": "Get a tag rule compliance score" }, "ListTagPipelinesRulesets": { "description": "List all tag pipeline rulesets - Retrieve a list of all tag pipeline rulesets for the organization", diff --git a/hugo/data/api/v2/translate_tags.json b/hugo/data/api/v2/translate_tags.json index a144bf419c2..c46da23ab24 100644 --- a/hugo/data/api/v2/translate_tags.json +++ b/hugo/data/api/v2/translate_tags.json @@ -519,9 +519,9 @@ "name": "Synthetics", "description": "Synthetic tests use simulated requests and actions so you can monitor the availability and performance of systems and applications. Datadog supports the following types of synthetic tests:\n- [API tests](https://docs.datadoghq.com/synthetics/api_tests/)\n- [Browser tests](https://docs.datadoghq.com/synthetics/browser_tests)\n- [Network Path tests](https://docs.datadoghq.com/synthetics/network_path_tests/)\n- [Mobile Application tests](https://docs.datadoghq.com/synthetics/mobile_app_testing)\nYou can use the Datadog API to create, manage, and organize tests and test suites programmatically.\nFor more information, see the [Synthetic Monitoring documentation](https://docs.datadoghq.com/synthetics/)." }, - "tag-policies": { - "name": "Tag Policies", - "description": "Tag Policies define rules that govern which tag values are accepted for a given tag key,\nscoped to a particular telemetry source (such as logs, spans, or metrics). Policies can be\n`blocking` (data not matching the policy is rejected) or `surfacing` (matching data is\nhighlighted but not blocked). Each policy reports a compliance `score` derived from how\nmuch recent telemetry adheres to the policy." + "tag-rules": { + "name": "Tag Rules", + "description": "Tag Rules define rules that govern which tag values are accepted for a given tag key,\nscoped to a particular telemetry source (such as logs, spans, or metrics). Rules can be\n`blocking` (data not matching the rule is rejected) or `surfacing` (matching data is\nhighlighted but not blocked). Each rule reports a compliance `score` derived from how\nmuch recent telemetry adheres to the rule." }, "teams": { "name": "Teams",