diff --git a/hugo/config/_default/menus/main.en.yaml b/hugo/config/_default/menus/main.en.yaml index 39e9cd6b59f..8690cac6bf3 100644 --- a/hugo/config/_default/menus/main.en.yaml +++ b/hugo/config/_default/menus/main.en.yaml @@ -10480,11 +10480,16 @@ menu: identifier: account_management_samle_troubleshooting parent: account_management_saml weight: 411 + - name: Delete Data + identifier: account_management_delete_data + url: account_management/delete_data/ + parent: account_management + weight: 5 - name: SCIM url: account_management/scim/ parent: account_management identifier: account_management_scim - weight: 5 + weight: 6 - name: Okta identifier: account_management_scim_okta url: account_management/scim/okta @@ -10499,22 +10504,22 @@ menu: identifier: account_management_api_app_keys url: account_management/api-app-keys/ parent: account_management - weight: 6 + weight: 7 - name: Personal Access Tokens identifier: account_management_personal_access_tokens url: account_management/personal-access-tokens/ parent: account_management - weight: 7 + weight: 8 - name: Service Access Tokens identifier: account_management_service_access_tokens url: account_management/service-access-tokens/ parent: account_management - weight: 8 + weight: 9 - name: Teams identifier: account_management_teams url: account_management/teams/ parent: account_management - weight: 9 + weight: 10 - name: Team Management identifier: account_management_teams_management url: account_management/teams/manage/ @@ -10529,7 +10534,7 @@ menu: identifier: account_management_governance_console url: account_management/governance_console/ parent: account_management - weight: 10 + weight: 11 - name: Controls identifier: account_management_governance_console_controls url: account_management/governance_console/controls @@ -10539,12 +10544,12 @@ menu: identifier: account_management_mfa url: account_management/multi-factor_authentication/ parent: account_management - weight: 11 + weight: 12 - name: Audit Trail url: account_management/audit_trail/ parent: account_management identifier: account_management_audit_trail - weight: 12 + weight: 13 - name: Events url: account_management/audit_trail/events/ parent: account_management_audit_trail @@ -10564,12 +10569,12 @@ menu: url: account_management/safety_center/ parent: account_management identifier: safety_center - weight: 13 + weight: 14 - name: Plan & Usage url: account_management/plan_and_usage/ parent: account_management identifier: account_management_plan_and_usage - weight: 14 + weight: 15 - name: Bill Overview identifier: account_management_bill_overview url: account_management/plan_and_usage/bill_overview/ @@ -10594,7 +10599,7 @@ menu: identifier: account_management_billing url: account_management/billing/ parent: account_management - weight: 15 + weight: 16 - name: Pricing url: account_management/billing/pricing parent: account_management_billing @@ -10709,7 +10714,7 @@ menu: identifier: account_management_multi_org_accounts url: account_management/multi_organization/ parent: account_management - weight: 16 + weight: 17 - name: Organization Groups identifier: account_management_organization_groups url: account_management/organization_groups/ @@ -10719,12 +10724,12 @@ menu: identifier: account_management_guides url: account_management/guide/ parent: account_management - weight: 17 + weight: 18 - name: Workload Identity Federation identifier: account_management_workload_identity_federation url: account_management/workload_identity_federation/ parent: account_management - weight: 18 + weight: 19 - name: Disaster Recovery url: disaster_recovery/ pre: disaster-recovery-wui diff --git a/hugo/content/en/account_management/audit_trail/_index.md b/hugo/content/en/account_management/audit_trail/_index.md index ba55306aab9..79c7b80b95b 100644 --- a/hugo/content/en/account_management/audit_trail/_index.md +++ b/hugo/content/en/account_management/audit_trail/_index.md @@ -19,6 +19,9 @@ further_reading: - link: "https://www.datadoghq.com/blog/audit-trail-best-practices/" tag: "Blog" text: "Monitor critical Datadog assets and configurations with Audit Trail" +- link: "/account_management/delete_data/" + tag: "Documentation" + text: "Delete data from Datadog" --- ## Overview diff --git a/hugo/content/en/account_management/delete_data.md b/hugo/content/en/account_management/delete_data.md index a7b5d7dd17e..31702182a7e 100644 --- a/hugo/content/en/account_management/delete_data.md +++ b/hugo/content/en/account_management/delete_data.md @@ -1,7 +1,13 @@ --- title: Delete Data description: Delete logs data from Datadog with proper permissions, time-based queries, and audit trail logging for compliance. -private: true +further_reading: + - link: '/account_management/rbac/' + tag: 'Documentation' + text: 'Learn about roles and permissions' + - link: '/account_management/audit_trail/' + tag: 'Documentation' + text: 'Monitor user activity with Audit Trail' --- This page explains how to delete sensitive data that should not have been ingested into Datadog. @@ -59,6 +65,10 @@ To cancel a deletion, click {{< ui >}}Cancel{{< /ui >}} on an {{< ui >}}Upcoming Deletions are logged in [Deletion History][5] for 90 days. They are also logged in [Audit Trail][6] alongside the requesting user's details. +## Further Reading + +{{< partial name="whats-next/whats-next.html" >}} + [1]: https://www.datadoghq.com/support/ [2]: /account_management/rbac/permissions/ [3]: https://app.datadoghq.com/organization-settings/roles diff --git a/hugo/content/en/account_management/governance_console/telemetry_rules.md b/hugo/content/en/account_management/governance_console/telemetry_rules.md index 0360073b3ab..5492e1f4109 100644 --- a/hugo/content/en/account_management/governance_console/telemetry_rules.md +++ b/hugo/content/en/account_management/governance_console/telemetry_rules.md @@ -4,7 +4,7 @@ is_beta: true private: true description: Use telemetry rules to govern tags, indexing, and other characteristics of your metrics, logs, and spans. further_reading: -- link: '/api/latest/tag-policies/' +- link: '/api/latest/tag-rules/' tag: 'Documentation' text: 'Tag Visibility and Enforcement Rules API' - link: '/account_management/governance_console/' diff --git a/hugo/content/en/account_management/rbac/_index.md b/hugo/content/en/account_management/rbac/_index.md index b7f3aa3c132..151dfbebd5c 100644 --- a/hugo/content/en/account_management/rbac/_index.md +++ b/hugo/content/en/account_management/rbac/_index.md @@ -23,6 +23,9 @@ further_reading: - link: "https://www.datadoghq.com/blog/compliance-governance-transparency-with-datadog-audit-trail/" tag: "Blog" text: "Build compliance, governance, and transparency across your teams with Datadog Audit Trail" + - link: '/account_management/delete_data/' + tag: 'Documentation' + text: 'Delete data from Datadog' algolia: tags: ["rbac"] --- diff --git a/hugo/content/en/api/latest/tag-policies/_index.md b/hugo/content/en/api/latest/tag-policies/_index.md deleted file mode 100644 index ecfc544bdc4..00000000000 --- a/hugo/content/en/api/latest/tag-policies/_index.md +++ /dev/null @@ -1,3 +0,0 @@ ---- -title: Tag Policies ---- diff --git a/hugo/content/en/api/latest/tag-policies/create-a-tag-policy/index.md b/hugo/content/en/api/latest/tag-policies/create-a-tag-policy/index.md deleted file mode 100644 index b5e249e13f8..00000000000 --- a/hugo/content/en/api/latest/tag-policies/create-a-tag-policy/index.md +++ /dev/null @@ -1,3 +0,0 @@ ---- -title: Create a tag policy ---- diff --git a/hugo/content/en/api/latest/tag-policies/delete-a-tag-policy/index.md b/hugo/content/en/api/latest/tag-policies/delete-a-tag-policy/index.md deleted file mode 100644 index d6188c07a50..00000000000 --- a/hugo/content/en/api/latest/tag-policies/delete-a-tag-policy/index.md +++ /dev/null @@ -1,3 +0,0 @@ ---- -title: Delete a tag policy ---- diff --git a/hugo/content/en/api/latest/tag-policies/get-a-tag-policy-compliance-score/index.md b/hugo/content/en/api/latest/tag-policies/get-a-tag-policy-compliance-score/index.md deleted file mode 100644 index eecca766fb4..00000000000 --- a/hugo/content/en/api/latest/tag-policies/get-a-tag-policy-compliance-score/index.md +++ /dev/null @@ -1,3 +0,0 @@ ---- -title: Get a tag policy compliance score ---- diff --git a/hugo/content/en/api/latest/tag-policies/get-a-tag-policy/index.md b/hugo/content/en/api/latest/tag-policies/get-a-tag-policy/index.md deleted file mode 100644 index 16f6804aa2f..00000000000 --- a/hugo/content/en/api/latest/tag-policies/get-a-tag-policy/index.md +++ /dev/null @@ -1,3 +0,0 @@ ---- -title: Get a tag policy ---- diff --git a/hugo/content/en/api/latest/tag-policies/list-tag-policies/index.md b/hugo/content/en/api/latest/tag-policies/list-tag-policies/index.md deleted file mode 100644 index 5c5ba631c54..00000000000 --- a/hugo/content/en/api/latest/tag-policies/list-tag-policies/index.md +++ /dev/null @@ -1,3 +0,0 @@ ---- -title: List tag policies ---- diff --git a/hugo/content/en/api/latest/tag-policies/update-a-tag-policy/index.md b/hugo/content/en/api/latest/tag-policies/update-a-tag-policy/index.md deleted file mode 100644 index 20ae8c7cfa4..00000000000 --- a/hugo/content/en/api/latest/tag-policies/update-a-tag-policy/index.md +++ /dev/null @@ -1,3 +0,0 @@ ---- -title: Update a tag policy ---- diff --git a/hugo/content/en/api/latest/tag-rules/_index.md b/hugo/content/en/api/latest/tag-rules/_index.md index 77cdcd2939f..260cf368d88 100644 --- a/hugo/content/en/api/latest/tag-rules/_index.md +++ b/hugo/content/en/api/latest/tag-rules/_index.md @@ -1,3 +1,5 @@ --- title: Tag Rules +aliases: +- /api/latest/tag-policies/ --- 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 index f5fdd282056..e07eac69182 100644 --- 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 @@ -1,3 +1,5 @@ --- title: Create a tag rule +aliases: +- /api/latest/tag-policies/create-a-tag-policy/ --- 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 index bdf9ed321ee..4ca9a1a150a 100644 --- 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 @@ -1,3 +1,5 @@ --- title: Delete a tag rule +aliases: +- /api/latest/tag-policies/delete-a-tag-policy/ --- 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 index 25fa8b719fc..eeb3ffe96c0 100644 --- 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 @@ -1,3 +1,5 @@ --- title: Get a tag rule compliance score +aliases: +- /api/latest/tag-policies/get-a-tag-policy-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 index 784c5f7601d..9ccb6a89f6e 100644 --- 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 @@ -1,3 +1,5 @@ --- title: Get a tag rule +aliases: +- /api/latest/tag-policies/get-a-tag-policy/ --- 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 index 97b3eef7e4a..89ee2d21313 100644 --- 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 @@ -1,3 +1,5 @@ --- title: List tag rules +aliases: +- /api/latest/tag-policies/list-tag-policies/ --- 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 index 600dd1d735f..61817d690dc 100644 --- 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 @@ -1,3 +1,5 @@ --- title: Update a tag rule +aliases: +- /api/latest/tag-policies/update-a-tag-policy/ --- diff --git a/hugo/content/en/api/v2/tag-policies/_index.md b/hugo/content/en/api/v2/tag-policies/_index.md deleted file mode 100644 index 330bf3c00a5..00000000000 --- a/hugo/content/en/api/v2/tag-policies/_index.md +++ /dev/null @@ -1,4 +0,0 @@ ---- -title: Tag Policies -headless: true ---- diff --git a/hugo/content/en/api/v2/tag-policies/examples.json b/hugo/content/en/api/v2/tag-policies/examples.json deleted file mode 100644 index 6cf700a7d0a..00000000000 --- a/hugo/content/en/api/v2/tag-policies/examples.json +++ /dev/null @@ -1,788 +0,0 @@ -{ - "ListTagPolicies": { - "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 policy data objects.

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

attributes [required]

\n
\n

object

\n

The attributes of a tag policy resource.

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

created_at [required]

\n
\n

date-time

\n

The RFC 3339 timestamp at which the policy 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 policy.

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

deleted_at

\n
\n

date-time

\n

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.

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

deleted_by

\n
\n

string

\n

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

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

enabled [required]

\n
\n

boolean

\n

Whether the policy 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 policy 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 policy.

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

negated [required]

\n
\n

boolean

\n

When true, the policy 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 policy.

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

policy_type [required]

\n
\n

enum

\n

How the policy is enforced. blocking rejects telemetry that violates the policy.\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 policy applies within.

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

source [required]

\n
\n

enum

\n

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

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

tag_key [required]

\n
\n

string

\n

The tag key that the policy 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 policy.

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

relationships

\n
\n

object

\n

Related resources for a tag policy. 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 policy.

\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 policy 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 policy. \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 policies. Populated when an include query parameter is supplied.

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

attributes [required]

\n
\n

object

\n

Attributes of a tag policy compliance score.

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

score [required]

\n
\n

double

\n

The compliance score for the policy 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 policy 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 policy 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": "" - } - }, - "CreateTagPolicy": { - "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 policy resource.

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

attributes [required]

\n
\n

object

\n

The attributes of a tag policy resource.

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

created_at [required]

\n
\n

date-time

\n

The RFC 3339 timestamp at which the policy 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 policy.

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

deleted_at

\n
\n

date-time

\n

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.

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

deleted_by

\n
\n

string

\n

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

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

enabled [required]

\n
\n

boolean

\n

Whether the policy 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 policy 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 policy.

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

negated [required]

\n
\n

boolean

\n

When true, the policy 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 policy.

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

policy_type [required]

\n
\n

enum

\n

How the policy is enforced. blocking rejects telemetry that violates the policy.\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 policy applies within.

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

source [required]

\n
\n

enum

\n

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

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

tag_key [required]

\n
\n

string

\n

The tag key that the policy 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 policy.

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

relationships

\n
\n

object

\n

Related resources for a tag policy. 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 policy.

\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 policy 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 policy. \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 policies. Populated when an include query parameter is supplied.

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

attributes [required]

\n
\n

object

\n

Attributes of a tag policy compliance score.

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

score [required]

\n
\n

double

\n

The compliance score for the policy 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 policy 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 policy 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 policy.

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

attributes [required]

\n
\n

object

\n

Attributes that can be supplied when creating a tag policy.

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

enabled

\n
\n

boolean

\n

Whether the policy is currently enforced. Defaults to true for newly created policies.

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

negated

\n
\n

boolean

\n

When true, the policy 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 policy.

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

policy_type [required]

\n
\n

enum

\n

The policy type allowed when creating a tag policy. 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 policy applies within. Typically an environment, team, or\norganization-level identifier used to limit where the policy is enforced.

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

source [required]

\n
\n

enum

\n

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

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

tag_key [required]

\n
\n

string

\n

The tag key that the policy 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 policy. \nAllowed enum values: tag_policy

\n
\n \n
\n
\n
\n
" - } - }, - "DeleteTagPolicy": { - "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": "" - } - }, - "GetTagPolicy": { - "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 policy resource.

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

attributes [required]

\n
\n

object

\n

The attributes of a tag policy resource.

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

created_at [required]

\n
\n

date-time

\n

The RFC 3339 timestamp at which the policy 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 policy.

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

deleted_at

\n
\n

date-time

\n

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.

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

deleted_by

\n
\n

string

\n

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

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

enabled [required]

\n
\n

boolean

\n

Whether the policy 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 policy 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 policy.

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

negated [required]

\n
\n

boolean

\n

When true, the policy 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 policy.

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

policy_type [required]

\n
\n

enum

\n

How the policy is enforced. blocking rejects telemetry that violates the policy.\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 policy applies within.

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

source [required]

\n
\n

enum

\n

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

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

tag_key [required]

\n
\n

string

\n

The tag key that the policy 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 policy.

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

relationships

\n
\n

object

\n

Related resources for a tag policy. 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 policy.

\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 policy 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 policy. \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 policies. Populated when an include query parameter is supplied.

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

attributes [required]

\n
\n

object

\n

Attributes of a tag policy compliance score.

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

score [required]

\n
\n

double

\n

The compliance score for the policy 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 policy 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 policy 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": "" - } - }, - "UpdateTagPolicy": { - "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 policy resource.

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

attributes [required]

\n
\n

object

\n

The attributes of a tag policy resource.

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

created_at [required]

\n
\n

date-time

\n

The RFC 3339 timestamp at which the policy 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 policy.

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

deleted_at

\n
\n

date-time

\n

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.

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

deleted_by

\n
\n

string

\n

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

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

enabled [required]

\n
\n

boolean

\n

Whether the policy 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 policy 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 policy.

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

negated [required]

\n
\n

boolean

\n

When true, the policy 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 policy.

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

policy_type [required]

\n
\n

enum

\n

How the policy is enforced. blocking rejects telemetry that violates the policy.\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 policy applies within.

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

source [required]

\n
\n

enum

\n

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

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

tag_key [required]

\n
\n

string

\n

The tag key that the policy 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 policy.

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

relationships

\n
\n

object

\n

Related resources for a tag policy. 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 policy.

\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 policy 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 policy. \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 policies. Populated when an include query parameter is supplied.

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

attributes [required]

\n
\n

object

\n

Attributes of a tag policy compliance score.

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

score [required]

\n
\n

double

\n

The compliance score for the policy 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 policy 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 policy 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 policy.

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

attributes

\n
\n

object

\n

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

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

enabled

\n
\n

boolean

\n

Whether the policy is currently enforced.

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

negated

\n
\n

boolean

\n

When true, the policy 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 policy.

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

policy_type

\n
\n

enum

\n

How the policy is enforced. blocking rejects telemetry that violates the policy.\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 policy applies within.

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

tag_key

\n
\n

string

\n

The tag key that the policy 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 policy being updated.

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

type [required]

\n
\n

enum

\n

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

\n
\n \n
\n
\n
\n
" - } - }, - "GetTagPolicyScore": { - "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 policy.

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

attributes [required]

\n
\n

object

\n

Attributes of a tag policy compliance score.

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

score [required]

\n
\n

double

\n

The compliance score for the policy 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 policy 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 policy 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