API Reference

Zones

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Observability

ObservabilityTracing

ObservabilityTracingSettings

View zone tracing settings

client.zones.observability.tracing.settings.get(SettingGetParams { zone_id } params, RequestOptionsoptions?): SettingGetResponse { destinations, enabled, forward_context, 3 more }

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

Update zone tracing settings

client.zones.observability.tracing.settings.update(SettingUpdateParams { zone_id, destinations, enabled, 4 more } params, RequestOptionsoptions?): SettingUpdateResponse { destinations, enabled, forward_context, 3 more }

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

Reset zone tracing settings

client.zones.observability.tracing.settings.delete(SettingDeleteParams { zone_id } params, RequestOptionsoptions?): SettingDeleteResponse { destinations, enabled, forward_context, 3 more }

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

ModelsExpand Collapse

SettingGetResponse { destinations, enabled, forward_context, 3 more }

destinations: Array<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" | "authenticated" | "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 { destinations, enabled, forward_context, 3 more }

destinations: Array<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" | "authenticated" | "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 { destinations, enabled, forward_context, 3 more }

destinations: Array<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" | "authenticated" | "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

client.zones.observability.tracing.rules.get(RuleGetParams { zone_id } params, RequestOptionsoptions?): RuleGetResponse { rules }

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

Replace zone trace rules

client.zones.observability.tracing.rules.update(RuleUpdateParams { zone_id, rules } params, RequestOptionsoptions?): RuleUpdateResponse { rules }

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

Delete zone trace rules

client.zones.observability.tracing.rules.delete(RuleDeleteParams { zone_id } params, RequestOptionsoptions?): RuleDeleteResponse { rules }

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

ModelsExpand Collapse

RuleGetResponse { rules }

rules: Array<Rule>

Trace rules in evaluation order.

action: "set_trace_settings"

action_parameters: ActionParameters { 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 { rules }

rules: Array<Rule>

Trace rules in evaluation order.

action: "set_trace_settings"

action_parameters: ActionParameters { 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 { rules }

rules: Array<Rule>

Trace rules in evaluation order.

action: "set_trace_settings"

action_parameters: ActionParameters { 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