Observability

ObservabilityTracing

ObservabilityTracingSettings

View zone tracing settings

GET/zones/{zone_id}/observability/tracing/settings

Update zone tracing settings

PATCH/zones/{zone_id}/observability/tracing/settings

Reset zone tracing settings

DELETE/zones/{zone_id}/observability/tracing/settings

ModelsExpand Collapse

SettingGetResponse object { destinations, enabled, forward_context, 3 more }

destinations: array of string

Up to 100 OpenTelemetry destination identifiers that receive traces.

enabled: boolean

Whether Cloudflare Traces is enabled for the zone.

forward_context: boolean

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

persist: boolean

Whether traces are persisted in Cloudflare.

propagation_policy: "accept" or "authenticated" or "reject"

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

One of the following:

"accept"

"authenticated"

"reject"

sampling_ratio: number

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

maximum1

minimum0

SettingUpdateResponse object { destinations, enabled, forward_context, 3 more }

destinations: array of string

Up to 100 OpenTelemetry destination identifiers that receive traces.

enabled: boolean

Whether Cloudflare Traces is enabled for the zone.

forward_context: boolean

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

persist: boolean

Whether traces are persisted in Cloudflare.

propagation_policy: "accept" or "authenticated" or "reject"

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

One of the following:

"accept"

"authenticated"

"reject"

sampling_ratio: number

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

maximum1

minimum0

SettingDeleteResponse object { destinations, enabled, forward_context, 3 more }

destinations: array of string

Up to 100 OpenTelemetry destination identifiers that receive traces.

enabled: boolean

Whether Cloudflare Traces is enabled for the zone.

forward_context: boolean

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

persist: boolean

Whether traces are persisted in Cloudflare.

propagation_policy: "accept" or "authenticated" or "reject"

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

One of the following:

"accept"

"authenticated"

"reject"

sampling_ratio: number

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

maximum1

minimum0

ObservabilityTracingRules

View zone trace rules

GET/zones/{zone_id}/observability/tracing/rules

Replace zone trace rules

PUT/zones/{zone_id}/observability/tracing/rules

Delete zone trace rules

DELETE/zones/{zone_id}/observability/tracing/rules

ModelsExpand Collapse

RuleGetResponse object { rules }

rules: array of object { action, action_parameters, description, 2 more }

Trace rules in evaluation order.

action: "set_trace_settings"

action_parameters: object { sampling_ratio }

sampling_ratio: number

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

maximum1

minimum0

description: string

maxLength1000

enabled: boolean

expression: string

A Rules language expression that selects requests.

maxLength4096

minLength1

RuleUpdateResponse object { rules }

rules: array of object { action, action_parameters, description, 2 more }

Trace rules in evaluation order.

action: "set_trace_settings"

action_parameters: object { sampling_ratio }

sampling_ratio: number

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

maximum1

minimum0

description: string

maxLength1000

enabled: boolean

expression: string

A Rules language expression that selects requests.

maxLength4096

minLength1

RuleDeleteResponse object { rules }

rules: array of object { action, action_parameters, description, 2 more }

Trace rules in evaluation order.

action: "set_trace_settings"

action_parameters: object { sampling_ratio }

sampling_ratio: number

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

maximum1

minimum0

description: string

maxLength1000

enabled: boolean

expression: string

A Rules language expression that selects requests.

maxLength4096

minLength1