---
title: Observability
---

[Skip to content](#_top)

[API Reference](https://developers.cloudflare.com/api/typescript)

[Zones](https://developers.cloudflare.com/api/typescript/resources/zones)

Copy Markdown

Open in **Claude**Open in **ChatGPT**Open in **Cursor**

---

**Copy Markdown****View as Markdown**

# Observability

#### ObservabilityTracing

#### ObservabilityTracingSettings

##### [View zone tracing settings](https://developers.cloudflare.com/api/typescript/resources/zones/subresources/observability/subresources/tracing/subresources/settings/methods/get)

client.zones.observability.tracing.settings.get(SettingGetParams {zone\_id } params, RequestOptionsoptions?): [SettingGetResponse](<https://developers.cloudflare.com/api/typescript/resources/zones#(resource)%20zones.observability.tracing.settings%20%3E%20(model)%20setting_get_response%20%3E%20(schema)>) {destinations, enabled, forward\_context, 3 more }

GET/zones/{zone\_id}/observability/tracing/settings

##### [Update zone tracing settings](https://developers.cloudflare.com/api/typescript/resources/zones/subresources/observability/subresources/tracing/subresources/settings/methods/update)

client.zones.observability.tracing.settings.update(SettingUpdateParams {zone\_id, destinations, enabled, 4 more } params, RequestOptionsoptions?): [SettingUpdateResponse](<https://developers.cloudflare.com/api/typescript/resources/zones#(resource)%20zones.observability.tracing.settings%20%3E%20(model)%20setting_update_response%20%3E%20(schema)>) {destinations, enabled, forward\_context, 3 more }

PATCH/zones/{zone\_id}/observability/tracing/settings

##### [Reset zone tracing settings](https://developers.cloudflare.com/api/typescript/resources/zones/subresources/observability/subresources/tracing/subresources/settings/methods/delete)

client.zones.observability.tracing.settings.delete(SettingDeleteParams {zone\_id } params, RequestOptionsoptions?): [SettingDeleteResponse](<https://developers.cloudflare.com/api/typescript/resources/zones#(resource)%20zones.observability.tracing.settings%20%3E%20(model)%20setting_delete_response%20%3E%20(schema)>) {destinations, enabled, forward\_context, 3 more }

DELETE/zones/{zone\_id}/observability/tracing/settings

##### ModelsExpand Collapse

<details>

<summary>

SettingGetResponse {destinations, enabled, forward\_context, 3 more }

</summary>

destinations: Array&lt;string&gt;

Up to 100 OpenTelemetry destination identifiers that receive traces.

<a href="#(resource)%20zones.observability.tracing.settings%20%3E%20(model)%20setting_get_response%20%3E%20(schema)%20%3E%20(property)%20destinations">Link to this property</a>

enabled: boolean

Whether Cloudflare Traces is enabled for the zone.

<a href="#(resource)%20zones.observability.tracing.settings%20%3E%20(model)%20setting_get_response%20%3E%20(schema)%20%3E%20(property)%20enabled">Link to this property</a>

forward\_context: boolean

Whether trace context is sent externally or across a zone boundary.

<a href="#(resource)%20zones.observability.tracing.settings%20%3E%20(model)%20setting_get_response%20%3E%20(schema)%20%3E%20(property)%20forward_context">Link to this property</a>

persist: boolean

Whether traces are persisted in Cloudflare.

<a href="#(resource)%20zones.observability.tracing.settings%20%3E%20(model)%20setting_get_response%20%3E%20(schema)%20%3E%20(property)%20persist">Link to this property</a>

<details>

<summary>

propagation\_policy: "accept"| "authenticated"| "reject"

When inbound trace context may be continued. Authenticated propagation is not supported yet.

</summary>

One of the following:

"accept"

<a href="#(resource)%20zones.observability.tracing.settings%20%3E%20(model)%20setting_get_response%20%3E%20(schema)%20%3E%20(property)%20propagation_policy%20%3E%20(member)%200">Link to this property</a>

"authenticated"

<a href="#(resource)%20zones.observability.tracing.settings%20%3E%20(model)%20setting_get_response%20%3E%20(schema)%20%3E%20(property)%20propagation_policy%20%3E%20(member)%201">Link to this property</a>

"reject"

<a href="#(resource)%20zones.observability.tracing.settings%20%3E%20(model)%20setting_get_response%20%3E%20(schema)%20%3E%20(property)%20propagation_policy%20%3E%20(member)%202">Link to this property</a>

</details>

<a href="#(resource)%20zones.observability.tracing.settings%20%3E%20(model)%20setting_get_response%20%3E%20(schema)%20%3E%20(property)%20propagation_policy">Link to this property</a>

sampling\_ratio: number

The ratio of requests sampled for tracing, from 0 to 1.

maximum1

minimum0

<a href="#(resource)%20zones.observability.tracing.settings%20%3E%20(model)%20setting_get_response%20%3E%20(schema)%20%3E%20(property)%20sampling_ratio">Link to this property</a>

</details>

[Link to this property](<#(resource)%20zones.observability.tracing.settings%20%3E%20(model)%20setting_get_response%20%3E%20(schema)>)

<details>

<summary>

SettingUpdateResponse {destinations, enabled, forward\_context, 3 more }

</summary>

destinations: Array&lt;string&gt;

Up to 100 OpenTelemetry destination identifiers that receive traces.

<a href="#(resource)%20zones.observability.tracing.settings%20%3E%20(model)%20setting_update_response%20%3E%20(schema)%20%3E%20(property)%20destinations">Link to this property</a>

enabled: boolean

Whether Cloudflare Traces is enabled for the zone.

<a href="#(resource)%20zones.observability.tracing.settings%20%3E%20(model)%20setting_update_response%20%3E%20(schema)%20%3E%20(property)%20enabled">Link to this property</a>

forward\_context: boolean

Whether trace context is sent externally or across a zone boundary.

<a href="#(resource)%20zones.observability.tracing.settings%20%3E%20(model)%20setting_update_response%20%3E%20(schema)%20%3E%20(property)%20forward_context">Link to this property</a>

persist: boolean

Whether traces are persisted in Cloudflare.

<a href="#(resource)%20zones.observability.tracing.settings%20%3E%20(model)%20setting_update_response%20%3E%20(schema)%20%3E%20(property)%20persist">Link to this property</a>

<details>

<summary>

propagation\_policy: "accept"| "authenticated"| "reject"

When inbound trace context may be continued. Authenticated propagation is not supported yet.

</summary>

One of the following:

"accept"

<a href="#(resource)%20zones.observability.tracing.settings%20%3E%20(model)%20setting_update_response%20%3E%20(schema)%20%3E%20(property)%20propagation_policy%20%3E%20(member)%200">Link to this property</a>

"authenticated"

<a href="#(resource)%20zones.observability.tracing.settings%20%3E%20(model)%20setting_update_response%20%3E%20(schema)%20%3E%20(property)%20propagation_policy%20%3E%20(member)%201">Link to this property</a>

"reject"

<a href="#(resource)%20zones.observability.tracing.settings%20%3E%20(model)%20setting_update_response%20%3E%20(schema)%20%3E%20(property)%20propagation_policy%20%3E%20(member)%202">Link to this property</a>

</details>

<a href="#(resource)%20zones.observability.tracing.settings%20%3E%20(model)%20setting_update_response%20%3E%20(schema)%20%3E%20(property)%20propagation_policy">Link to this property</a>

sampling\_ratio: number

The ratio of requests sampled for tracing, from 0 to 1.

maximum1

minimum0

<a href="#(resource)%20zones.observability.tracing.settings%20%3E%20(model)%20setting_update_response%20%3E%20(schema)%20%3E%20(property)%20sampling_ratio">Link to this property</a>

</details>

[Link to this property](<#(resource)%20zones.observability.tracing.settings%20%3E%20(model)%20setting_update_response%20%3E%20(schema)>)

<details>

<summary>

SettingDeleteResponse {destinations, enabled, forward\_context, 3 more }

</summary>

destinations: Array&lt;string&gt;

Up to 100 OpenTelemetry destination identifiers that receive traces.

<a href="#(resource)%20zones.observability.tracing.settings%20%3E%20(model)%20setting_delete_response%20%3E%20(schema)%20%3E%20(property)%20destinations">Link to this property</a>

enabled: boolean

Whether Cloudflare Traces is enabled for the zone.

<a href="#(resource)%20zones.observability.tracing.settings%20%3E%20(model)%20setting_delete_response%20%3E%20(schema)%20%3E%20(property)%20enabled">Link to this property</a>

forward\_context: boolean

Whether trace context is sent externally or across a zone boundary.

<a href="#(resource)%20zones.observability.tracing.settings%20%3E%20(model)%20setting_delete_response%20%3E%20(schema)%20%3E%20(property)%20forward_context">Link to this property</a>

persist: boolean

Whether traces are persisted in Cloudflare.

<a href="#(resource)%20zones.observability.tracing.settings%20%3E%20(model)%20setting_delete_response%20%3E%20(schema)%20%3E%20(property)%20persist">Link to this property</a>

<details>

<summary>

propagation\_policy: "accept"| "authenticated"| "reject"

When inbound trace context may be continued. Authenticated propagation is not supported yet.

</summary>

One of the following:

"accept"

<a href="#(resource)%20zones.observability.tracing.settings%20%3E%20(model)%20setting_delete_response%20%3E%20(schema)%20%3E%20(property)%20propagation_policy%20%3E%20(member)%200">Link to this property</a>

"authenticated"

<a href="#(resource)%20zones.observability.tracing.settings%20%3E%20(model)%20setting_delete_response%20%3E%20(schema)%20%3E%20(property)%20propagation_policy%20%3E%20(member)%201">Link to this property</a>

"reject"

<a href="#(resource)%20zones.observability.tracing.settings%20%3E%20(model)%20setting_delete_response%20%3E%20(schema)%20%3E%20(property)%20propagation_policy%20%3E%20(member)%202">Link to this property</a>

</details>

<a href="#(resource)%20zones.observability.tracing.settings%20%3E%20(model)%20setting_delete_response%20%3E%20(schema)%20%3E%20(property)%20propagation_policy">Link to this property</a>

sampling\_ratio: number

The ratio of requests sampled for tracing, from 0 to 1.

maximum1

minimum0

<a href="#(resource)%20zones.observability.tracing.settings%20%3E%20(model)%20setting_delete_response%20%3E%20(schema)%20%3E%20(property)%20sampling_ratio">Link to this property</a>

</details>

[Link to this property](<#(resource)%20zones.observability.tracing.settings%20%3E%20(model)%20setting_delete_response%20%3E%20(schema)>)

#### ObservabilityTracingRules

##### [View zone trace rules](https://developers.cloudflare.com/api/typescript/resources/zones/subresources/observability/subresources/tracing/subresources/rules/methods/get)

client.zones.observability.tracing.rules.get(RuleGetParams {zone\_id } params, RequestOptionsoptions?): [RuleGetResponse](<https://developers.cloudflare.com/api/typescript/resources/zones#(resource)%20zones.observability.tracing.rules%20%3E%20(model)%20rule_get_response%20%3E%20(schema)>) {rules }

GET/zones/{zone\_id}/observability/tracing/rules

##### [Replace zone trace rules](https://developers.cloudflare.com/api/typescript/resources/zones/subresources/observability/subresources/tracing/subresources/rules/methods/update)

client.zones.observability.tracing.rules.update(RuleUpdateParams {zone\_id, rules } params, RequestOptionsoptions?): [RuleUpdateResponse](<https://developers.cloudflare.com/api/typescript/resources/zones#(resource)%20zones.observability.tracing.rules%20%3E%20(model)%20rule_update_response%20%3E%20(schema)>) {rules }

PUT/zones/{zone\_id}/observability/tracing/rules

##### [Delete zone trace rules](https://developers.cloudflare.com/api/typescript/resources/zones/subresources/observability/subresources/tracing/subresources/rules/methods/delete)

client.zones.observability.tracing.rules.delete(RuleDeleteParams {zone\_id } params, RequestOptionsoptions?): [RuleDeleteResponse](<https://developers.cloudflare.com/api/typescript/resources/zones#(resource)%20zones.observability.tracing.rules%20%3E%20(model)%20rule_delete_response%20%3E%20(schema)>) {rules }

DELETE/zones/{zone\_id}/observability/tracing/rules

##### ModelsExpand Collapse

<details>

<summary>

RuleGetResponse {rules }

</summary>

<details>

<summary>

rules: Array&lt;Rule&gt;

Trace rules in evaluation order.

</summary>

action: "set\_trace\_settings"

<a href="#(resource)%20zones.observability.tracing.rules%20%3E%20(model)%20rule_get_response%20%3E%20(schema)%20%3E%20(property)%20rules%20%3E%20(items)%20%3E%20(property)%20action">Link to this property</a>

<details>

<summary>

action\_parameters: ActionParameters {sampling\_ratio }

</summary>

sampling\_ratio: number

The ratio of requests sampled for tracing, from 0 to 1.

maximum1

minimum0

<a href="#(resource)%20zones.observability.tracing.rules%20%3E%20(model)%20rule_get_response%20%3E%20(schema)%20%3E%20(property)%20rules%20%3E%20(items)%20%3E%20(property)%20action_parameters%20%3E%20(property)%20sampling_ratio">Link to this property</a>

</details>

<a href="#(resource)%20zones.observability.tracing.rules%20%3E%20(model)%20rule_get_response%20%3E%20(schema)%20%3E%20(property)%20rules%20%3E%20(items)%20%3E%20(property)%20action_parameters">Link to this property</a>

description: string

maxLength1000

<a href="#(resource)%20zones.observability.tracing.rules%20%3E%20(model)%20rule_get_response%20%3E%20(schema)%20%3E%20(property)%20rules%20%3E%20(items)%20%3E%20(property)%20description">Link to this property</a>

enabled: boolean

<a href="#(resource)%20zones.observability.tracing.rules%20%3E%20(model)%20rule_get_response%20%3E%20(schema)%20%3E%20(property)%20rules%20%3E%20(items)%20%3E%20(property)%20enabled">Link to this property</a>

expression: string

A Rules language expression that selects requests.

maxLength4096

minLength1

<a href="#(resource)%20zones.observability.tracing.rules%20%3E%20(model)%20rule_get_response%20%3E%20(schema)%20%3E%20(property)%20rules%20%3E%20(items)%20%3E%20(property)%20expression">Link to this property</a>

</details>

<a href="#(resource)%20zones.observability.tracing.rules%20%3E%20(model)%20rule_get_response%20%3E%20(schema)%20%3E%20(property)%20rules">Link to this property</a>

</details>

[Link to this property](<#(resource)%20zones.observability.tracing.rules%20%3E%20(model)%20rule_get_response%20%3E%20(schema)>)

<details>

<summary>

RuleUpdateResponse {rules }

</summary>

<details>

<summary>

rules: Array&lt;Rule&gt;

Trace rules in evaluation order.

</summary>

action: "set\_trace\_settings"

<a href="#(resource)%20zones.observability.tracing.rules%20%3E%20(model)%20rule_update_response%20%3E%20(schema)%20%3E%20(property)%20rules%20%3E%20(items)%20%3E%20(property)%20action">Link to this property</a>

<details>

<summary>

action\_parameters: ActionParameters {sampling\_ratio }

</summary>

sampling\_ratio: number

The ratio of requests sampled for tracing, from 0 to 1.

maximum1

minimum0

<a href="#(resource)%20zones.observability.tracing.rules%20%3E%20(model)%20rule_update_response%20%3E%20(schema)%20%3E%20(property)%20rules%20%3E%20(items)%20%3E%20(property)%20action_parameters%20%3E%20(property)%20sampling_ratio">Link to this property</a>

</details>

<a href="#(resource)%20zones.observability.tracing.rules%20%3E%20(model)%20rule_update_response%20%3E%20(schema)%20%3E%20(property)%20rules%20%3E%20(items)%20%3E%20(property)%20action_parameters">Link to this property</a>

description: string

maxLength1000

<a href="#(resource)%20zones.observability.tracing.rules%20%3E%20(model)%20rule_update_response%20%3E%20(schema)%20%3E%20(property)%20rules%20%3E%20(items)%20%3E%20(property)%20description">Link to this property</a>

enabled: boolean

<a href="#(resource)%20zones.observability.tracing.rules%20%3E%20(model)%20rule_update_response%20%3E%20(schema)%20%3E%20(property)%20rules%20%3E%20(items)%20%3E%20(property)%20enabled">Link to this property</a>

expression: string

A Rules language expression that selects requests.

maxLength4096

minLength1

<a href="#(resource)%20zones.observability.tracing.rules%20%3E%20(model)%20rule_update_response%20%3E%20(schema)%20%3E%20(property)%20rules%20%3E%20(items)%20%3E%20(property)%20expression">Link to this property</a>

</details>

<a href="#(resource)%20zones.observability.tracing.rules%20%3E%20(model)%20rule_update_response%20%3E%20(schema)%20%3E%20(property)%20rules">Link to this property</a>

</details>

[Link to this property](<#(resource)%20zones.observability.tracing.rules%20%3E%20(model)%20rule_update_response%20%3E%20(schema)>)

<details>

<summary>

RuleDeleteResponse {rules }

</summary>

<details>

<summary>

rules: Array&lt;Rule&gt;

Trace rules in evaluation order.

</summary>

action: "set\_trace\_settings"

<a href="#(resource)%20zones.observability.tracing.rules%20%3E%20(model)%20rule_delete_response%20%3E%20(schema)%20%3E%20(property)%20rules%20%3E%20(items)%20%3E%20(property)%20action">Link to this property</a>

<details>

<summary>

action\_parameters: ActionParameters {sampling\_ratio }

</summary>

sampling\_ratio: number

The ratio of requests sampled for tracing, from 0 to 1.

maximum1

minimum0

<a href="#(resource)%20zones.observability.tracing.rules%20%3E%20(model)%20rule_delete_response%20%3E%20(schema)%20%3E%20(property)%20rules%20%3E%20(items)%20%3E%20(property)%20action_parameters%20%3E%20(property)%20sampling_ratio">Link to this property</a>

</details>

<a href="#(resource)%20zones.observability.tracing.rules%20%3E%20(model)%20rule_delete_response%20%3E%20(schema)%20%3E%20(property)%20rules%20%3E%20(items)%20%3E%20(property)%20action_parameters">Link to this property</a>

description: string

maxLength1000

<a href="#(resource)%20zones.observability.tracing.rules%20%3E%20(model)%20rule_delete_response%20%3E%20(schema)%20%3E%20(property)%20rules%20%3E%20(items)%20%3E%20(property)%20description">Link to this property</a>

enabled: boolean

<a href="#(resource)%20zones.observability.tracing.rules%20%3E%20(model)%20rule_delete_response%20%3E%20(schema)%20%3E%20(property)%20rules%20%3E%20(items)%20%3E%20(property)%20enabled">Link to this property</a>

expression: string

A Rules language expression that selects requests.

maxLength4096

minLength1

<a href="#(resource)%20zones.observability.tracing.rules%20%3E%20(model)%20rule_delete_response%20%3E%20(schema)%20%3E%20(property)%20rules%20%3E%20(items)%20%3E%20(property)%20expression">Link to this property</a>

</details>

<a href="#(resource)%20zones.observability.tracing.rules%20%3E%20(model)%20rule_delete_response%20%3E%20(schema)%20%3E%20(property)%20rules">Link to this property</a>

</details>

[Link to this property](<#(resource)%20zones.observability.tracing.rules%20%3E%20(model)%20rule_delete_response%20%3E%20(schema)>)