Skip to content
Cloudflare API
Start here
API Reference
Zones

Observability

ObservabilityTracing

ObservabilityTracingSettings

View zone tracing settings
zones.observability.tracing.settings.get(SettingGetParams**kwargs) -> SettingGetResponse
GET/zones/{zone_id}/observability/tracing/settings
Update zone tracing settings
zones.observability.tracing.settings.update(SettingUpdateParams**kwargs) -> SettingUpdateResponse
PATCH/zones/{zone_id}/observability/tracing/settings
Reset zone tracing settings
zones.observability.tracing.settings.delete(SettingDeleteParams**kwargs) -> SettingDeleteResponse
DELETE/zones/{zone_id}/observability/tracing/settings
ModelsExpand Collapse
class SettingGetResponse: …
destinations: List[str]

Up to 100 OpenTelemetry destination identifiers that receive traces.

enabled: bool

Whether Cloudflare Traces is enabled for the zone.

forward_context: bool

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

persist: bool

Whether traces are persisted in Cloudflare.

propagation_policy: Literal["accept", "authenticated", "reject"]

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

One of the following:
"accept"
"authenticated"
"reject"
sampling_ratio: float

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

maximum1
minimum0
class SettingUpdateResponse: …
destinations: List[str]

Up to 100 OpenTelemetry destination identifiers that receive traces.

enabled: bool

Whether Cloudflare Traces is enabled for the zone.

forward_context: bool

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

persist: bool

Whether traces are persisted in Cloudflare.

propagation_policy: Literal["accept", "authenticated", "reject"]

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

One of the following:
"accept"
"authenticated"
"reject"
sampling_ratio: float

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

maximum1
minimum0
class SettingDeleteResponse: …
destinations: List[str]

Up to 100 OpenTelemetry destination identifiers that receive traces.

enabled: bool

Whether Cloudflare Traces is enabled for the zone.

forward_context: bool

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

persist: bool

Whether traces are persisted in Cloudflare.

propagation_policy: Literal["accept", "authenticated", "reject"]

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

One of the following:
"accept"
"authenticated"
"reject"
sampling_ratio: float

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

maximum1
minimum0

ObservabilityTracingRules

View zone trace rules
zones.observability.tracing.rules.get(RuleGetParams**kwargs) -> RuleGetResponse
GET/zones/{zone_id}/observability/tracing/rules
Replace zone trace rules
zones.observability.tracing.rules.update(RuleUpdateParams**kwargs) -> RuleUpdateResponse
PUT/zones/{zone_id}/observability/tracing/rules
Delete zone trace rules
zones.observability.tracing.rules.delete(RuleDeleteParams**kwargs) -> RuleDeleteResponse
DELETE/zones/{zone_id}/observability/tracing/rules
ModelsExpand Collapse
class RuleGetResponse: …
rules: List[Rule]

Trace rules in evaluation order.

action: Literal["set_trace_settings"]
action_parameters: RuleActionParameters
sampling_ratio: float

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

maximum1
minimum0
description: str
maxLength1000
enabled: bool
expression: str

A Rules language expression that selects requests.

maxLength4096
minLength1
class RuleUpdateResponse: …
rules: List[Rule]

Trace rules in evaluation order.

action: Literal["set_trace_settings"]
action_parameters: RuleActionParameters
sampling_ratio: float

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

maximum1
minimum0
description: str
maxLength1000
enabled: bool
expression: str

A Rules language expression that selects requests.

maxLength4096
minLength1
class RuleDeleteResponse: …
rules: List[Rule]

Trace rules in evaluation order.

action: Literal["set_trace_settings"]
action_parameters: RuleActionParameters
sampling_ratio: float

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

maximum1
minimum0
description: str
maxLength1000
enabled: bool
expression: str

A Rules language expression that selects requests.

maxLength4096
minLength1