NewYour coding agent can read the release notes before it upgrades.Set up the MCP server →
PyPI
PyPI, #2568 most downloaded on PyPI
The official Python library for the cloudflare API
Latest stable
5.10.0
Last release 17 days ago
05 Nov 2026
Ships unpredictably
gaps range from 9 days to 8 months
Some releases are documented
notes for 19 of the last 60 stable releases
9 versions withdrawn
withdrawn after publishing
11 years old
142 releases · first in 2016
Drag across the ruler to compare, or tap a release to open it.
…pagination and response types. Review the breaking changes before upgrading.
Full Changelog: v5.9.0...v5.10.0
This release adds the K2 streaming, Monetization, Zero Trust CWS, and Billing Spend Policies APIs, plus Zero Trust Access user populations and MFA catalog resources. It also removes the Magic Cloud Networking and Tenant Custom Nameservers resources and changes several pagination and response types. Review the breaking changes before upgrading.
See the v5.10.0 Migration Guide for upgrade examples.
client.magic_cloud_networking has been removed entirely, including the catalog_syncs
(and prebuilt_policies), on_ramps (and address_spaces), cloud_integrations, and resources sub-resources
and all cloudflare.types.magic_cloud_networking exports.client.tenant_custom_nameservers has been removed, along with its create(),
delete(), and get() methods and the TenantCustomNameserverCreateResponse, TenantCustomNameserverDeleteResponse,
and TenantCustomNameserverGetResponse types.client.tenants.get() has been removed, along with the account_types, entitlements, and
memberships sub-resources and the Tenant and TenantAccount types. client.tenants.accounts.list() now returns
SyncV4PagePaginationArray[AccountListResponse] instead of SyncSinglePage[TenantAccount].client.user.tenants.list() now returns SyncSinglePage[TenantListResponse] instead of
SyncSinglePage[Organization], and the Organization type was removed from cloudflare.types.user.client.accounts.pay_bad_debt sub-resource has been removed. client.accounts.subscriptions.bulk.create()
now returns BulkCreateResponse instead of Optional[BulkCreateResponse].client.registrar.domains sub-resource has been removed.client.browser_rendering.devtools.browser.connect() and launch() have been removed, along
with the devtools.browser.page sub-resource.name to namespace across every
client.aisearch.namespaces.instances method and its items and jobs sub-resources. Callers passing name= must
switch to namespace=.client.rulesets.list() is no longer paginated and now returns RulesetListResponse directly (was
SyncCursorPagination[RulesetListResponse]). client.rulesets.versions.list() and
client.rulesets.phases.versions.list() likewise now return VersionListResponse instead of
SyncSinglePage[VersionListResponse].client.zero_trust.resource_library.applications.list() and categories.list() now return
SyncCursorPaginationAfter instead of SyncSinglePage. client.diagnostics.endpoint_healthchecks.list() now returns
SyncSinglePage[EndpointHealthcheckListResponse] instead of Optional[EndpointHealthcheckListResponse].client.vectorize.indexes.get_by_ids() now uses GET and returns
SyncSinglePage[IndexGetByIDsResponse] instead of issuing POST and returning object.client.zero_trust.access.users.last_seen_identity.get() now returns
Optional[LastSeenIdentityGetResponse] and the Identity type was removed.
client.workers_for_platforms.dispatch.namespaces.scripts.tags.delete() now returns TagDeleteResponse instead of
object.LoadBalancerPreview type was removed, along with
magic_transit.WANStaticAddressingParam, organizations.OrganizationProfileParam, and
precursor.EnforcementRuleParam.client.k2 with streams and streams.subscriptions APIsclient.monetization with zone-level monetization rules APIsclient.zero_trust.cws with basic_auth_credentials (and secrets), deployments,
domain_acls, policies, policy_sets, rego_metadata, rego_modules, tenant_structures (and nodes), and
workloads APIsclient.billing.spend_policies with create(), update(), list(), delete(), and get(),
plus activity and audit listing sub-resourcesclient.zero_trust.access.user_populations (and its users sub-resource) with full CRUDclient.zero_trust.access.mfa.authenticator_catalog and client.zero_trust.access.logs.jit_requestsmfa_authenticators and passkeys delete sub-resources to client.zero_trust.access.usersclient.zero_trust.casb.posture.asset_schemas; add create(), update(), delete(), and
validate() to client.zero_trust.casb.posture.finding_typesclient.zero_trust.dlp.validators (and its proximity_words sub-resource)client.zero_trust.gateway.dns_destination_ipsdelete() and get() to client.zero_trust.identity_providers.scim.groups and scim.usersclient.dns.settings.account.nameserver_sets with create(), list(), delete(), and get()client.r2.buckets.jobs with create(), list(), and get()client.aisearch.namespaces.instances.move()client.api_gateway.discovery.operations.edit()client.d1.database.undelete()client.workers.beta.workers.versions.profile()client.zero_trust.access.custom_pages.validate()K2 (client.k2)
streams.create(), streams.update(), streams.list(), streams.delete(), and streams.get()streams.subscriptions.list()Monetization (client.monetization)
rules.update(), rules.delete(), rules.delete_rule(), rules.edit_rule(), rules.get(), and rules.get_rule()Zero Trust CWS (client.zero_trust.cws)
basic_auth_credentials.create(), list(), delete(), get(), and basic_auth_credentials.secrets.*deployments.create(), update(), list(), delete(), and get()domain_acls.create(), update(), list(), delete(), and get()policies.create(), update(), list(), delete(), and get()policy_sets.create(), update(), list(), delete(), and get()rego_metadata.create(), update(), list(), delete(), and get()rego_modules.create(), update(), list(), delete(), and get()tenant_structures.create(), update(), list(), delete(), get(), and tenant_structures.nodes.*workloads.create(), update(), list(), delete(), and get()Billing Spend Policies (client.billing.spend_policies)
create(), update(), list(), delete(), and get()activity.list() and audit.list()Zero Trust Access User Populations (client.zero_trust.access.user_populations)
create(), update(), list(), delete(), and get()users.create(), users.update(), users.list(), users.delete(), users.get(), and users.replace()Your coding agent can read these notes before it upgrades. Set up the MCP server →
This release adds the Containers, R2 Data Catalog, and Cloudforce One threat signals APIs, plus cache invalidation and a registrar transfer-check meth
Full Changelog: v5.8.0...v5.9.0
This release adds the Containers, R2 Data Catalog, and Cloudforce One threat signals APIs, plus cache invalidation and a registrar transfer-check method.
client.addressing.address_maps.zones.update() and delete() have been removed, along with the
ZoneUpdateResponse and ZoneDeleteResponse types.client.email_security.phishguard.reports.list() now returns SyncV4PagePaginationArray instead of
SyncSinglePage. Auto-iteration is unchanged; code reading page-level fields may need updating.client.containers with application, instance, rollout, version, image, and registry APIsclient.basin_catalog (R2 Data Catalog) with catalog, credential, namespace, table, and maintenance-config APIsclient.cloudforce_one.threat_signals with article, category, feed, indicator, search, and skill APIsclient.cache.invalidate() and client.cache.invalidate_environment()client.registrar.transfer_check()This release adds Managed Defense vulnerability discovery, Field Extractors, billing and subscription APIs, Magic Transit BGP filter profiles, registr…
Full Changelog: v5.7.0...v5.8.0
This release adds Managed Defense vulnerability discovery, Field Extractors, billing and subscription APIs, Magic Transit BGP filter profiles, registrar transfer APIs, Zero Trust posture policies, and zone observability tracing. It also includes generated signature and response-model corrections. Review the breaking changes before upgrading.
See the v5.8.0 Migration Guide for upgrade examples.
client.addressing.address_maps.accounts.update() and delete() now take
member_account_id as the positional identifier and address_map_id as a keyword argument.body parameters were removed from token value updates, Address Maps IP and zone
updates, Cache Reserve clear, DNS scan and zone transfer actions, Email Routing enable/disable, Access bookmarks,
and Gateway certificate activation/deactivation.jurisdiction was renamed to cf_r2_jurisdiction across bucket, object, domain,
lifecycle, lock, CORS, event-notification, and Sippy operations. The new keyword also accepts fedramp-high.None. The Override,
OverrideDeleteResponse, RateLimit, RateLimitDeleteResponse, WAFRule, and RewriteAction exports were
removed. Firewall bulk edit/update now require an id instead of a body collection, and WAF package retrieval
now returns a raw string/object union.RuleUpdateParams.rules is now required.list(), delete(), and get() now use
the shared MTLSCertificate type; create() still returns Optional[MTLSCertificateCreateResponse]. Hyperdrive
create parameters are now origin/integration variants, replacing direct Origin, Caching, and MTLS helper
imports.SyncV4PagePagination and adds page/date filters; Gateway
list items and PAC files now return SyncV4PagePaginationArray and add page controls; device override-code
listing now returns Optional[OverrideCodeListResponse].client.email_routing.dns.delete() now uses DELETE and returns Optional[Settings] instead
of a page of DNS records. dns.get() is now optional and returns List[DNSRecord] rather than an envelope union.Optional[...]; callers must handle None.url or html. Session endpoints such as devtools.browser.create() are unaffected. Nested Viewport,
Cookie, and PDFOptions imports moved under generated variant types.SourceField, SourceFieldParam,
ListField, ListFieldParam, StructField, and StructFieldParam types.ApplicationCreateParams for Resource Library applications is now a union requiring either
hostnames or ip_subnets. Access Browser RDP and Infrastructure target_attributes response fields are now
optional.BlockRule to RuleBlockRule,
CompressResponseRule to RuleResponseCompressionRule, and SetConfigRule to RuleSetConfigurationRule;
several response rule fields are now required.type, and Workers domain environment are now
required.primary
or site_id.SKIPPED, message status no longer includes
DISCOVERING, and bulk responses add required cancellation/skip counts.Okta or Workday.created_at, selected billing usage fields, and Workers observability
request_id fields are now optional.date/datetime and int
instead of str and float; session participant per_page is now an int.ResponseInfo entries.stream.Clip, stream.Playback, stream.Watermark, and cache.State were removed, along with
nested types from the removed legacy rate-limit models.client.managed_defense.vulnerability_discovery with repository, scan, and report APIsclient.field_extractors with update(), delete(), and get() methodsclient.hyperdrive.configs.restart()force to beta worker deletion and pagination/date filters to deployment listingprofile_type filter for custom policy listingobjectHost, Status, and ValidationMethod aliasesstandalone and Idempotency-Key account creation optionstransfer_pending; Waiting Rooms Latvian locale; zone upload limits through 5000; Queues jurisdiction; AI Gateway
BYOK-only mode; Logpush attack-traffic filtering; Resource Tagging CWS variants; and Rulesets WebMCP settingsManaged Defense Vulnerability Discovery (client.managed_defense.vulnerability_discovery)
repositories.create(), repositories.list(), and repositories.get()scans.create(), scans.list(), scans.get(), and scans.get_report()reports.get()Field Extractors (client.field_extractors)
update()delete()get()Magic Transit BGP Filter Profiles (client.magic_transit.bgp_filter_profiles)
create(), update(), list(), delete(), and get()Zero Trust CASB Posture Policies (client.zero_trust.casb.posture.policies)
create(), update(), list(), delete(), and get()Zone Observability Tracing (client.zones.observability.tracing)
settings.update(), settings.delete(), and settings.get()rules.update(), rules.delete(), and rules.get()intel: The deprecated dismiss() method has been removed from client.intel.attack_surface_report.issues . The IssueDismissResponse and IssueDismissPara…
Full Changelog: v5.6.0...v5.7.0
create_independent_livestream() method has been removed from client.realtime_kit.livestreams. The LivestreamCreateIndependentLivestreamParams and LivestreamCreateIndependentLivestreamResponse types are no longer available.dismiss() method has been removed from client.intel.attack_surface_report.issues. The IssueDismissResponse and IssueDismissParams types are no longer available.Setting type has been removed from cloudflare.types.page_shield. The get() method now returns Optional[PageShieldGetResponse] and the update() method returns PageShieldUpdateResponse. The Connection type has been replaced by ConnectionGetResponse and ConnectionListResponse. The Script type has been replaced by ScriptListResponse. The Policy type has been replaced by per-method response types.schemas.delete() method return type changed from SchemaDeleteResponse to object. The SchemaDeleteResponse type has been removed from cloudflare.types.schema_validation.HealthCheckParam type has been removed from cloudflare.types.magic_transit. The IPSECTunnelPSKGenerateParams type has been removed from cloudflare.types.magic_transit.client.email_security.settings.content_policies resource with create(), list(), delete(), batch(), edit(), and get() methodsclient.email_sending.suppressions resource with create(), list(), delete(), edit(), get(), and import_() methods; add edit() to client.email_sending.subdomainsclient.logpush.transformers resource with create(), update(), list(), delete(), get(), and preview() methods; add client.logpush.transformers.content and client.logpush.transformers.versions sub-resourcesclient.spectrum.protocols resource with list() methodclient.zones.nel resource with edit() and get() methodsclient.ssl.recommendations resource with get() methodclient.user.spectrum_analytics.zones.reports resource with get() methodclient.browser_rendering.devtools.browser.live_view resource with create() methodclient.precursor resource with update() and get() methodsbatch() to client.email_security.settings.allow_policies, client.email_security.settings.block_senders, and client.email_security.settings.trusted_domains; add create(), update(), and batch() to client.email_security.settings.domainsdelete() to client.addressing.prefixes.bgp_prefixesdelete() to client.r2_data_catalogcreate(), update(), and delete() to client.zero_trust.resource_library.applicationsreplace_preset_by_id() to client.realtime_kit.presetsupdate() to client.content_scanning.payloadsedit() to client.token_validation.configuration.credentialsLogpush Transformers (client.logpush.transformers)
create(*, account_id, **params) -> Optional[TransformerCreateResponse]update(transformer_id, *, account_id, **params) -> Optional[TransformerUpdateResponse]list(*, account_id) -> SyncSinglePage[TransformerListResponse]delete(transformer_id, *, account_id) -> Optional[TransformerDeleteResponse]get(transformer_id, *, account_id) -> Optional[TransformerGetResponse]preview(*, account_id, **params) -> SyncSinglePage[TransformerPreviewResponse]New types:
from cloudflare.types.logpush import (
TransformerCreateResponse,
TransformerUpdateResponse,
TransformerListResponse,
TransformerDeleteResponse,
TransformerGetResponse,
TransformerPreviewResponse,
)Logpush Transformer Content (client.logpush.transformers.content)
get(transformer_id, *, account_id) -> ContentGetResponseLogpush Transformer Versions (client.logpush.transformers.versions)
list(transformer_id, *, account_id, **params) -> SyncSinglePage[VersionListResponse]Email Security Content Policies (client.email_security.settings.content_policies)
create(*, account_id, **params) -> Optional[ContentPolicyCreateResponse]list(*, account_id, **params) -> SyncV4PagePaginationArray[ContentPolicyListResponse]delete(policy_id, *, account_id) -> Optional[ContentPolicyDeleteResponse]batch(*, account_id, **params) -> Optional[ContentPolicyBatchResponse]edit(policy_id, *, account_id, **params) -> Optional[ContentPolicyEditResponse]get(policy_id, *, account_id) -> Optional[ContentPolicyGetResponse]New types:
from cloudflare.types.email_security.settings import (
ContentPolicyCreateResponse,
ContentPolicyListResponse,
ContentPolicyDeleteResponse,
ContentPolicyBatchResponse,
ContentPolicyEditResponse,
ContentPolicyGetResponse,
)Email Sending Suppressions (client.email_sending.suppressions)
create(*, account_id, **params) -> SuppressionCreateResponselist(*, account_id, **params) -> SyncCursorPagination[SuppressionListResponse]delete(suppression_id, *, account_id) -> SuppressionDeleteResponseedit(suppression_id, *, account_id, **params) -> SuppressionEditResponseget(suppression_id, *, account_id) -> SuppressionGetResponseimport_(*, account_id, **params) -> SuppressionImportResponseNew types:
from cloudflare.types.email_sending import (
SuppressionCreateResponse,
SuppressionListResponse,
SuppressionDeleteResponse,
SuppressionEditResponse,
SuppressionGetResponse,
SuppressionImportResponse,
)Zones NEL (client.zones.nel)
edit(*, zone_id, **params) -> Settingget(*, zone_id) -> SettingSpectrum Protocols (client.spectrum.protocols)
list(*, zone_id) -> SyncSinglePage[ProtocolListResponse]New types:
from cloudflare.types.spectrum import ProtocolListResponseSSL Recommendations (client.ssl.recommendations)
get(*, zone_id) -> RecommendationGetResponseNew types:
from cloudflare.types.ssl import RecommendationGetResponseUser Spectrum Analytics Zone Reports (client.user.spectrum_analytics.zones.reports)
get(*, **params) -> ReportGetResponseNew types:
from cloudflare.types.user.spectrum_analytics.zones import ReportGetResponseBrowser Rendering Live View (client.browser_rendering.devtools.browser.live_view)
create(browser_session_id, *, account_id, **params) -> LiveViewCreateResponsePrecursor (client.precursor)
Top-level resource for precursor configuration management.
update(*, account_id, **params) -> Optional[PrecursorConfig]get(*, account_id) -> Optional[PrecursorConfig]New types:
from cloudflare.types.precursor import PrecursorConfigaccounts: Removed create() and get() from client.accounts.subscriptions
create() and get() from client.accounts.subscriptionsCertificateAuthority typeHostnameAssociation typeindicator_types sub-resource (moved to indicators.types)Status typeconfigs.list() pagination changed to SyncV4PagePaginationArray/{account_or_zone}/{account_or_zone_id}/ patternrotate() from relays.tokens; replaced with create(), list(), delete()MTLSCertificate replaced with per-method response typesHost, Status, ValidationMethod types; hosts param changed to strsetup_flows from CASB applications; get() endpoint changedSee CHANGELOG.md for full details and new type listings.
Full Changelog: v5.5.0...v5.6.0
create() and get() methods have been removed from client.accounts.subscriptions. The SubscriptionCreateParams type is no longer available.CertificateAuthority type has been removed from cloudflare.types.acm.HostnameAssociation type has been removed from cloudflare.types.certificate_authorities.indicator_types sub-resource has been removed from client.cloudforce_one.threat_events. Use the new client.cloudforce_one.threat_events.indicators.types resource instead.client.hyperdrive.configs.list() changed from SyncSinglePage to SyncV4PagePaginationArray. Code that relied on single-page iteration semantics may need adjustment.client.load_balancers now use a polymorphic /{account_or_zone}/{account_or_zone_id}/load_balancers endpoint pattern instead of the previous /zones/{zone_id}/load_balancers. Method signatures now accept either account_id or zone_id.rotate() method and TokenRotateResponse type have been removed from client.moq.relays.tokens. Use the new create(), list(), and delete() methods instead.MTLSCertificate type has been replaced with MTLSCertificateGetResponse, MTLSCertificateListResponse, and MTLSCertificateDeleteResponse. The return types of list(), delete(), and get() have changed accordingly.Status type has been removed from cloudflare.types.custom_certificates.Host, Status, and ValidationMethod types have been removed from cloudflare.types.ssl. The hosts parameter on client.ssl.certificate_packs.create() changed from SequenceNotStr[Host] to SequenceNotStr[str].setup_flows sub-resource has been removed from client.zero_trust.casb.applications. The get() method endpoint changed from /accounts/{account_id}/one/applications/{slug} to /accounts/{account_id}/one/applications/{application_id}.summary(), timeseries(), and top_n() methods, plus data_security.content_findings and data_security.findings sub-resources (7245164)client.ai_audit.robots resource with bulk_get() and get() methods (7245164)aggregate, graphql, graph, queries, relationships, indicators (with aggregate, types, by_dataset), tags (with categories, indicators), target_industries, categories, and datasets (7245164)client.magic_transit.connectors.interrupts resource with create() and list() methods (7245164)create(), list(), and delete() methods to client.moq.relays.tokens (7245164)check(), search(), and sub-resources for registrations, registration_status, and update_status (7245164)client.zero_trust.casb.applications.auth_methods resource with list() method (7245164)client.zero_trust.casb.posture with sub-resources for findings (list, export, ignore, unignore, tune/reset severity), finding_types, content, exports, remediations, and webhooks (7245164)AIAudit Robots (client.ai_audit.robots)
bulk_get(*, zone_id, **params) -> Optional[RobotBulkGetResponse]get(*, zone_id, **params) -> Optional[RobotGetResponse]New types:
from cloudflare.types.ai_audit import RobotBulkGetResponse, RobotGetResponse
MagicTransit Connector Interrupts (client.magic_transit.connectors.interrupts)
create(connector_id, *, account_id, **params) -> InterruptCreateResponselist(connector_id, *, account_id) -> SyncSinglePage[InterruptListResponse]New types:
from cloudflare.types.magic_transit.connectors import (
InterruptCreateResponse,
InterruptListResponse,
)
CASB Application Auth Methods (client.zero_trust.casb.applications.auth_methods)
list(application_id, *, account_id) -> AuthMethodListResponseNew types:
from cloudflare.types.zero_trust.casb.applications import AuthMethodListResponse
MoQ Relay Tokens (client.moq.relays.tokens)
create(relay_id, *, account_id, **params) -> Optional[TokenCreateResponse]list(relay_id, *, account_id) -> Optional[TokenListResponse]delete(jti, *, account_id, relay_id) -> TokenDeleteResponseNew types:
from cloudflare.types.moq.relays import (
TokenCreateResponse,
TokenListResponse,
TokenDeleteResponse,
)
CloudforceOne ThreatEvents Sub-Resources (client.cloudforce_one.threat_events)
The following sub-resources were added under client.cloudforce_one.threat_events:
aggregategraphqlgraphqueriesrelationshipsindicators (with aggregate, types, by_dataset sub-resources)tags (with categories, indicators sub-resources)target_industriescategoriesdatasetsAnalyticsQuery (client.analytics_query)
Query analytics data across datasets with summary, timeseries, and top-N aggregations.
summary(dataset, *, account_id, **params) -> AnalyticsQuerySummaryResponsetimeseries(dataset, *, account_id, **params) -> AnalyticsQueryTimeseriesResponsetop_n(dataset, *, account_id, **params) -> SyncSinglePage[AnalyticsQueryTopNResponse]New types:
from cloudflare.types import (
AnalyticsQuerySummaryResponse,
AnalyticsQueryTimeseriesResponse,
AnalyticsQueryTopNResponse,
)
DataSecurity ContentFindings (client.analytics_query.data_security.content_findings)
top_n(*, account_id, **params) -> SyncSinglePage[ContentFindingTopNResponse]DataSecurity Findings (client.analytics_query.data_security.findings)
summary(*, account_id, **params) -> FindingSummaryResponsetimeseries(*, account_id, **params) -> FindingTimeseriesResponseRegistrarSandbox (client.registrar_sandbox)
Sandbox environment for domain registration operations.
check(*, account_id, **params) -> RegistrarSandboxCheckResponsesearch(*, account_id, **params) -> RegistrarSandboxSearchResponseRegistrations (client.registrar_sandbox.registrations)
create(*, account_id, **params) -> RegistrationCreateResponselist(*, account_id, **params) -> SyncCursorPagination[RegistrationListResponse]edit(domain_id, *, account_id, **params) -> RegistrationEditResponseget(domain_id, *, account_id) -> RegistrationGetResponseRegistrationStatus (client.registrar_sandbox.registration_status)
get(domain_name, *, account_id) -> RegistrationStatusGetResponseNew types:
from cloudflare.types.registrar_sandbox import RegistrationStatusGetResponse
UpdateStatus (client.registrar_sandbox.update_status)
get(domain_name, *, account_id) -> UpdateStatusGetResponseNew types:
from cloudflare.types.registrar_sandbox import UpdateStatusGetResponse
CASB Posture (client.zero_trust.casb.posture)
Full CASB posture management with findings, remediation, and webhook support.
posture.findings.list(*, account_id, **params) -> SyncV4PagePaginationArray[FindingListResponse]posture.findings.export(*, account_id, **params) -> Optional[FindingExportResponse]posture.findings.get(finding_id, *, account_id) -> Optional[FindingGetResponse]posture.findings.ignore(*, account_id, **params) -> Optional[FindingIgnoreResponse]posture.findings.unignore(*, account_id, **params) -> Optional[FindingUnignoreResponse]posture.findings.tune_severity(finding_id, *, account_id, **params) -> Optional[FindingTuneSeverityResponse]posture.findings.reset_severity(finding_id, *, account_id) -> Optional[FindingResetSeverityResponse]posture.findings.instances.list(*, account_id, **params) -> SyncV4PagePaginationArray[InstanceListResponse]posture.webhooks.create(*, account_id, **params) -> WebhookCreateResponseposture.webhooks.list(*, account_id) -> SyncSinglePage[WebhookListResponse]posture.remediations.jobs.create(*, account_id, **params) -> JobCreateResponseposture.remediations.jobs.list(*, account_id, **params) -> SyncV4PagePaginationArray[JobListResponse]New types:
from cloudflare.types.zero_trust.casb.posture import (
FindingListResponse,
FindingExportResponse,
FindingGetResponse,
FindingIgnoreResponse,
FindingUnignoreResponse,
FindingTuneSeverityResponse,
FindingResetSeverityResponse,
)
FindingTypes (client.zero_trust.casb.posture.finding_types)
list(*, account_id, **params) -> SyncV4PagePaginationArray[FindingTypeListResponse]get(finding_type_id, *, account_id) -> Optional[FindingTypeGetResponse]New types:
from cloudflare.types.zero_trust.casb.posture import (
FindingTypeListResponse,
FindingTypeGetResponse,
)
Content (client.zero_trust.casb.posture.content)
list(*, account_id, **params) -> SyncV4PagePaginationArray[ContentListResponse]export(*, account_id, **params) -> Optional[ContentExportResponse]New types:
from cloudflare.types.zero_trust.casb.posture import (
ContentListResponse,
ContentExportResponse,
)
Exports (client.zero_trust.casb.posture.exports)
list(*, account_id, **params) -> SyncV4PagePaginationArray[ExportListResponse]get(id, *, account_id) -> Optional[ExportGetResponse]New types:
from cloudflare.types.zero_trust.casb.posture import (
ExportListResponse,
ExportGetResponse,
)
ssl: The recommendations sub-resource has been removed. client.ssl.recommendations.get() and the RecommendationGetResponse type are no longer availabl
Full Changelog: v5.4.0...v5.5.0
recommendations sub-resource has been removed. client.ssl.recommendations.get() and the RecommendationGetResponse type are no longer available.list method has been removed from client.email_routing.rules. Only create, update, delete, and get remain. The RuleListParams type has been removed.UserPolicyCheckGeo type has been removed from cloudflare.types.zero_trust.access.applications. The geo information is now inlined as UserIdentityGeo within UserPolicyCheckListResponse.client.zero_trust.devices.ip_profiles.list() changed from SyncSinglePage to SyncV4PagePaginationArray. Code that relied on single-page iteration semantics may need adjustment.SourceParamsWebCrawlerStoreOptions type and the store_options field on SourceParamsWebCrawler have been removed from instance create/update params and responses. The parse_type enum value "feed-rss" has been removed (only "sitemap" and "crawl" remain). The search_query field on InstanceSearchResponse and NamespaceSearchResponse changed from required str to Optional[str]. A new required query_kind field (Literal["text", "image", "multimodal"]) has been added to search responses.Organization and related params, MfaSSHPivKeyRequirements has been renamed to MfaPivKeyRequirements, the mfa_ssh_piv_key_requirements field has been renamed to mfa_piv_key_requirements, and the allowed_authenticators enum value "ssh_piv_key" has been changed to "piv_key".@cf/qwen/qwen3-vl-embedding-2b embedding model (de12426)WorkerDestination, PreviewWorkerDestination, AllWorkersDestination, AllPreviewWorkersDestination) to Access applications and eager_redirect_cookie_setting field to self-hosted applications (de12426)primary and site_id fields to connector create/edit params (de12426)Vary cache settings with ActionParametersVary, ActionParametersVaryDefault, and ActionParametersVaryHeaders types (de12426)threat_events.datasets.list() now accepts optional params (de12426)expected_disposition param to investigate.move.create() and investigate.move.bulk() (de12426)support_subaddress field to Settings response type (de12426)max_ttl_secs field to GatewayConfigurationSettings and new MaxTTL type to gateway Location for DNS TTL cap control (de12426)GlobalAcceleration type to default and custom device policy settings (de12426)category field to PermissionGroupGetResponse and PermissionGroupListResponse for account and user tokens (de12426)EmailAuth (client.email_auth)
DMARC report management and SPF inspection for email authentication.
DMARCReports (client.email_auth.dmarc_reports)
edit(*, zone_id, **params) -> Optional[DMARCReportEditResponse]get(*, zone_id) -> Optional[DMARCReportGetResponse]New types:
from cloudflare.types.email_auth import DMARCReportEditResponse, DMARCReportGetResponse
SPF Inspect (client.email_auth.spf.inspect)
get(*, zone_id, **params) -> Optional[InspectGetResponse]New types:
from cloudflare.types.email_auth.spf import InspectGetResponse
MoQ (client.moq)
Media over QUIC relay management.
Relays (client.moq.relays)
create(*, account_id, **params) -> Optional[RelayCreateResponse]update(relay_id, *, account_id, **params) -> Optional[RelayUpdateResponse]list(*, account_id, **params) -> SyncSinglePage[RelayListResponse]delete(relay_id, *, account_id) -> objectget(relay_id, *, account_id) -> Optional[RelayGetResponse]New types:
from cloudflare.types.moq import (
RelayCreateResponse,
RelayUpdateResponse,
RelayListResponse,
RelayGetResponse,
)
Tokens (client.moq.relays.tokens)
rotate(relay_id, *, account_id, **params) -> Optional[TokenRotateResponse]New types:
from cloudflare.types.moq.relays import TokenRotateResponse
Log Explorer (client.logs.log_explorer)
SQL-based log querying and dataset management.
Query (client.logs.log_explorer.query)
sql(body, *, account_id, zone_id, **params) -> SyncSinglePage[QuerySqlResponse]New types:
from cloudflare.types.logs.log_explorer import QuerySqlResponse
Datasets (client.logs.log_explorer.datasets)
create(*, account_id, zone_id, **params) -> Optional[Dataset]update(dataset_id, *, account_id, zone_id, **params) -> Optional[Dataset]list(*, account_id, zone_id, **params) -> SyncSinglePage[DatasetSummary]get(dataset_id, *, account_id, zone_id) -> Optional[Dataset]Available (client.logs.log_explorer.datasets.available)
list(*, account_id, zone_id) -> SyncSinglePage[AvailableDataset]New types:
from cloudflare.types.logs.log_explorer import (
Dataset,
DatasetSummary,
CreateRequest,
UpdateRequest,
)
from cloudflare.types.logs.log_explorer.datasets import AvailableDataset, AvailableList
Email Security Investigate Bulk (client.email_security.investigate.bulk)
Bulk message movement and quarantine release operations.
create(*, account_id, **params) -> BulkCreateResponselist(*, account_id, **params) -> SyncV4PagePaginationArray[BulkListResponse]delete(job_id, *, account_id) -> BulkDeleteResponseget(job_id, *, account_id) -> BulkGetResponseCancel (client.email_security.investigate.bulk.cancel)
create(job_id, *, account_id) -> CancelCreateResponseMessages (client.email_security.investigate.bulk.messages)
list(job_id, *, account_id, **params) -> SyncV4PagePaginationArray[MessageListResponse]New types:
from cloudflare.types.email_security.investigate import (
BulkCreateResponse,
BulkListResponse,
BulkDeleteResponse,
BulkGetResponse,
)
from cloudflare.types.email_security.investigate.bulk import (
CancelCreateResponse,
MessageListResponse,
)
ai_gateway: add custom_providers sub-resource
Full Changelog: v5.3.0...v5.4.0
custom_providers sub-resource (b982ff3)client.zones.ct.alerting) (5bb529c)fields parameter to client.d1.database.get (2b0e738)flagship resource with apps, flags, changelog, and evaluate endpoints (2b0e738)cf1_sites sub-resource with ramps, and ipsec_tunnels.psk_set method (5d8e422)origin_tls_compliance_modes resource (2b0e738)auto_origin_tls_kex sub-resource (2b0e738)tenants top-level resource and user.tenants sub-resource (7677b4c)sensitivity_groups, data_tag_categories, and data_classes sub-resources (2b0e738)tunnels.warp_connector.configurations sub-resource (2b0e738)OAuthScopeListResponse type import path moved from cloudflare.types.iam.oauth_scopes to cloudflare.types.iam (2b0e738)client.tenants)get(tenant_id) -> Tenanttenants.account_types.list(tenant_id) -> SyncSinglePage[AccountTypeListResponse]tenants.accounts.list(tenant_id) -> SyncSinglePage[TenantAccount]tenants.entitlements.get(tenant_id) -> TenantEntitlementstenants.memberships.list(tenant_id) -> SyncSinglePage[TenantMembership]New types:
from cloudflare.types.tenants import (
Tenant,
AccountTypeListResponse,
TenantAccount,
TenantEntitlements,
TenantMembership,
)
client.flagship)flagship.apps.create(*, account_id, **params) -> AppCreateResponseflagship.apps.update(app_id, *, account_id, **params) -> AppUpdateResponseflagship.apps.list(*, account_id) -> SyncSinglePage[AppListResponse]flagship.apps.delete(app_id, *, account_id) -> AppDeleteResponseflagship.apps.get(app_id, *, account_id) -> AppGetResponseflagship.apps.flags.create(app_id, *, account_id, **params) -> FlagCreateResponseflagship.apps.flags.update(flag_key, *, account_id, app_id, **params) -> FlagUpdateResponseflagship.apps.flags.list(app_id, *, account_id, **params) -> SyncCursorPaginationAfter[FlagListResponse]flagship.apps.flags.delete(flag_key, *, account_id, app_id) -> FlagDeleteResponseflagship.apps.flags.get(flag_key, *, account_id, app_id) -> FlagGetResponseflagship.apps.flags.changelog.list(flag_key, *, account_id, app_id, **params) -> SyncCursorPaginationAfter[ChangelogListResponse]flagship.apps.evaluate.get(app_id, *, account_id, **params) -> EvaluateGetResponseNew types:
from cloudflare.types.flagship import (
AppCreateResponse,
AppUpdateResponse,
AppListResponse,
AppDeleteResponse,
AppGetResponse,
)
from cloudflare.types.flagship.apps import (
FlagCreateResponse,
FlagUpdateResponse,
FlagListResponse,
FlagDeleteResponse,
FlagGetResponse,
EvaluateGetResponse,
)
from cloudflare.types.flagship.apps.flags import ChangelogListResponse
client.origin_tls_compliance_modes)update(*, zone_id, **params) -> Optional[OriginTLSComplianceModeUpdateResponse]delete(*, zone_id) -> Optional[OriginTLSComplianceModeDeleteResponse]edit(*, zone_id, **params) -> Optional[OriginTLSComplianceModeEditResponse]get(*, zone_id) -> Optional[OriginTLSComplianceModeGetResponse]New types:
from cloudflare.types.origin_tls_compliance_modes import (
OriginTLSComplianceModeUpdateResponse,
OriginTLSComplianceModeDeleteResponse,
OriginTLSComplianceModeEditResponse,
OriginTLSComplianceModeGetResponse,
)
client.ai_gateway.custom_providers)create(*, account_id, **params) -> CustomProviderCreateResponselist(*, account_id, **params) -> SyncV4PagePaginationArray[CustomProviderListResponse]delete(id, *, account_id) -> CustomProviderDeleteResponseget(id, *, account_id) -> CustomProviderGetResponseNew types:
from cloudflare.types.ai_gateway import (
CustomProviderCreateResponse,
CustomProviderListResponse,
CustomProviderDeleteResponse,
CustomProviderGetResponse,
)
client.magic_transit.cf1_sites)create(*, account_id, **params) -> SyncSinglePage[Cf1Site]update(cf1_site_id, *, account_id, **params) -> Cf1Sitelist(*, account_id) -> SyncSinglePage[Cf1Site]delete(cf1_site_id, *, account_id) -> Cf1Siteget(cf1_site_id, *, account_id) -> Cf1Sitecf1_sites.ramps.create(cf1_site_id, *, account_id, **params) -> SyncSinglePage[Ramp]cf1_sites.ramps.list(cf1_site_id, *, account_id) -> SyncSinglePage[Ramp]cf1_sites.ramps.delete(ramp_id, *, account_id, cf1_site_id) -> Rampcf1_sites.ramps.get(ramp_id, *, account_id, cf1_site_id) -> RampNew types:
from cloudflare.types.magic_transit import Cf1Site
from cloudflare.types.magic_transit.cf1_sites import Ramp
client.magic_transit.ipsec_tunnels)psk_set(*, account_id, **params) -> IPSECTunnelPSKSetResponseNew types:
from cloudflare.types.magic_transit import IPSECTunnelPSKSetResponse
client.ssl.auto_origin_tls_kex)edit(*, zone_id, **params) -> AutoOriginTLSKexEditResponseget(*, zone_id) -> AutoOriginTLSKexGetResponseNew types:
from cloudflare.types.ssl import AutoOriginTLSKexEditResponse, AutoOriginTLSKexGetResponse
client.zones.ct.alerting)edit(*, zone_id, **params) -> Optional[AlertingEditResponse]get(*, zone_id) -> Optional[AlertingGetResponse]New types:
from cloudflare.types.zones.ct import AlertingEditResponse, AlertingGetResponse
client.user.tenants)list() -> SyncSinglePage[Organization]client.zero_trust.dlp.sensitivity_groups)create(*, account_id, **params) -> Optional[SensitivityGroupCreateResponse]update(sensitivity_group_id, *, account_id, **params) -> Optional[SensitivityGroupUpdateResponse]list(*, account_id) -> SyncSinglePage[SensitivityGroupListResponse]delete(sensitivity_group_id, *, account_id) -> objectget(sensitivity_group_id, *, account_id) -> Optional[SensitivityGroupGetResponse]sensitivity_groups.levels.create(...) / update(...) / list(...) / delete(...) / get(...)sensitivity_groups.levels.order.update(...) / get(...)client.zero_trust.dlp.data_tag_categories)create(*, account_id, **params) -> Optional[DataTagCategoryCreateResponse]update(category_id, *, account_id, **params) -> Optional[DataTagCategoryUpdateResponse]list(*, account_id) -> SyncSinglePage[DataTagCategoryListResponse]delete(category_id, *, account_id) -> objectget(category_id, *, account_id) -> Optional[DataTagCategoryGetResponse]data_tag_categories.data_tags.create(...) / update(...) / list(...) / delete(...) / get(...)client.zero_trust.dlp.data_classes)create(*, account_id, **params) -> Optional[DataClassCreateResponse]update(data_class_id, *, account_id, **params) -> Optional[DataClassUpdateResponse]list(*, account_id) -> SyncSinglePage[DataClassListResponse]delete(data_class_id, *, account_id) -> objectget(data_class_id, *, account_id) -> Optional[DataClassGetResponse]client.zero_trust.tunnels.warp_connector.configurations)update(tunnel_id, *, account_id, **params) -> Optional[ConfigurationUpdateResponse]get(tunnel_id, *, account_id) -> Optional[ConfigurationGetResponse]New types:
from cloudflare.types.zero_trust.tunnels.warp_connector import (
ConfigurationUpdateResponse,
ConfigurationGetResponse,
)
client.d1.database.get now accepts an optional fields parameter to select which fields to include in the response.
# Before (still works)
db = client.d1.database.get(database_id, account_id="...")
# New: select specific fields
db = client.d1.database.get(database_id, account_id="...", fields=["name", "uuid", "file_size"])
client.iam.oauth_scopes module was flattened from a sub-package to a single module. The OAuthScopeListResponse type import path changed:
# Before
from cloudflare.types.iam.oauth_scopes import OAuthScopeListResponse
# After
from cloudflare.types.iam import OAuthScopeListResponse
Full Changelog: v5.3.0...v5.4.0
Merge pull request #2729 from cloudflare/release-please--branches--ma…
Merge pull request #2729 from cloudflare/release-please--branches--ma…
…in--changes--next
release: 5.3.0
Full Changelog: v5.2.0...v5.3.0
The cache.origin_cloud_regions resource has been significantly reworked. Endpoints changed from /zones/{zone_id}/cache/origin_cloud_regions to /zones/
Full Changelog: v5.1.0...v5.2.0
The cache.origin_cloud_regions resource has been significantly reworked.
Endpoints changed from /zones/{zone_id}/cache/origin_cloud_regions to
/zones/{zone_id}/origin/cloud_regions, several methods were removed or
renamed, and return types were consolidated.
Removed methods:
create -- replaced by update (PUT single item)edit -- removed (use update instead)bulk_edit -- renamed to bulk_updateChanged return types:
list now returns SyncV4PagePaginationArray[OriginCloudRegion] (was Optional[OriginCloudRegionListResponse])get now returns Optional[OriginCloudRegion] (was Optional[OriginCloudRegionGetResponse])Removed types:
OriginCloudRegionCreateResponseOriginCloudRegionListResponseOriginCloudRegionBulkEditResponseOriginCloudRegionEditResponseOriginCloudRegionGetResponseNew types:
from cloudflare.types.cache import (
OriginCloudRegion,
OriginCloudRegionBulkUpdateResponse,
)
The api_gateway.discovery.operations.edit method and its associated
OperationEditResponse type have been removed. Use bulk_edit instead.
purge_environment method and smart_tiered_cache.create method (b7ae845)secrets.bulk_update method (0bdb685)secrets.bulk_update method (7bfed3c)stores.delete now accepts optional params (636414f)dynamic_routing.list now accepts optional params (4923bbb)New top-level service at client.ddos_protection for managing Advanced TCP
Protection configurations including allowlists, prefixes, SYN protection
(filters and rules), TCP flow protection (filters and rules), and protection
status.
from cloudflare.types.ddos_protection.advanced_tcp_protection import (
AllowlistCreateResponse,
AllowlistListResponse,
PrefixCreateResponse,
PrefixListResponse,
StatusEditResponse,
StatusGetResponse,
)
Key methods:
ddos_protection.advanced_tcp_protection.allowlist.create/list/bulk_deleteddos_protection.advanced_tcp_protection.prefixes.create/list/bulk_create/bulk_deleteddos_protection.advanced_tcp_protection.syn_protection.filters.create/list/bulk_deleteddos_protection.advanced_tcp_protection.syn_protection.rules.create/list/bulk_deleteddos_protection.advanced_tcp_protection.tcp_flow_protection.filters.create/list/bulk_deleteddos_protection.advanced_tcp_protection.tcp_flow_protection.rules.create/list/bulk_deleteddos_protection.advanced_tcp_protection.status.edit/getEach collection also has an .items sub-resource for individual item
delete, edit, and get operations.
New top-level service at client.ai_security for managing zone-level AI
security settings and custom topics.
from cloudflare.types.ai_security import (
AISecurityUpdateResponse,
AISecurityGetResponse,
CustomTopicUpdateResponse,
CustomTopicGetResponse,
)
Methods:
ai_security.update/get -- manage AI security settings for a zoneai_security.custom_topics.update/get -- manage custom topicsNew client.ai_gateway.billing sub-resource with credit balance, invoice
history/preview, usage history, topup management, and spending limits.
from cloudflare.types.ai_gateway import (
BillingCreditBalanceResponse,
BillingInvoiceHistoryResponse,
BillingInvoicePreviewResponse,
BillingUsageHistoryResponse,
)
from cloudflare.types.ai_gateway.billing import (
TopupCreateResponse,
TopupStatusResponse,
SpendingLimitGetResponse,
)
from cloudflare.types.ai_gateway.billing.topup import (
ConfigCreateResponse,
ConfigGetResponse,
)
New client.r2.buckets.objects sub-resource for managing objects within R2
buckets.
from cloudflare.types.r2.buckets import (
ObjectListResponse,
ObjectDeleteResponse,
ObjectUploadResponse,
)
Methods:
r2.buckets.objects.list -- list objects in a bucket (cursor-paginated)r2.buckets.objects.delete -- delete an objectr2.buckets.objects.get -- download an object (returns BinaryAPIResponse)r2.buckets.objects.upload -- upload an objectNew sub-resources:
Access SAML Certificates (client.zero_trust.access.saml_certificates):
list, get, get_pem (returns BinaryAPIResponse), rotateIdentity Provider SAML Certificate (client.zero_trust.identity_providers.saml_certificate):
createResource Library (client.zero_trust.resource_library):
applications.list/get -- browse resource library applicationscategories.list/get -- browse resource library categoriesFull Changelog: v5.1.0...v5.2.0
Merge pull request #2714 from cloudflare/release-please--branches--ma…
Merge pull request #2714 from cloudflare/release-please--branches--ma…
…in--changes--next
release: 5.1.0
Full Changelog: v5.0.0...v5.1.0
audit_logs, classification, and context sub-resources to insights (ed7d261)deployment_groups sub-resource to devices (7121a55)AuditLogs (client.security_center.insights.audit_logs)
list(*, account_id, zone_id, **params) -> SyncCursorPagination[AuditLogListResponse]list_by_insight(issue_id, *, account_id, zone_id, **params) -> SyncCursorPagination[AuditLogListByInsightResponse]New types:
from cloudflare.types.security_center.insights import (
AuditLogListResponse,
AuditLogListByInsightResponse,
)
Classification (client.security_center.insights.classification)
update(issue_id, *, account_id, zone_id, **params) -> ClassificationUpdateResponseNew types:
from cloudflare.types.security_center.insights import ClassificationUpdateResponse
Context (client.security_center.insights.context)
get(issue_id, *, account_id) -> Optional[ContextGetResponse]New types:
from cloudflare.types.security_center.insights import ContextGetResponse
New sub-resource client.zero_trust.devices.deployment_groups:
create(*, account_id, **params) -> DeploymentGrouplist(*, account_id, **params) -> SyncV4PagePaginationArray[DeploymentGroup]delete(group_id, *, account_id) -> DeploymentGroupDeleteResponseedit(group_id, *, account_id, **params) -> DeploymentGroupget(group_id, *, account_id) -> DeploymentGroupNew types:
from cloudflare.types.zero_trust.devices import DeploymentGroup, DeploymentGroupDeleteResponse
VulnerabilityScanner (vulnerability_scanner): Vulnerability scanning, credential sets, and target environments
Full Changelog: v4.3.1...v5.0.0
This is a major release of the Cloudflare Python SDK. It drops support for Python 3.8, adds 11 new API services, introduces optional aiohttp backend support for improved async concurrency, and includes hundreds of type and method updates across the entire API surface.
Please review the breaking changes below before upgrading. A migration guide is available at docs/migration-guides/v5.0.0-migration-guide.md.
typing-extensions minimum version bumped from >=4.10 to >=4.14.Additionally, the following resources have breaking changes:
abusereportsacm.totaltlsapigateway.configurationscloudforceone.threateventsd1.databaseintel.indicatorfeedslogpush.edgeorigintlsclientauth.hostnamesqueues.consumersradar.bgprulesets.rulesschemavalidation.schemassnippetszerotrust.dlpzerotrust.networksSee the v5.0.0 Migration Guide for upgrade instructions and resource-specific guidance.
aiohttp HTTP backend for improved concurrency performance. Install with pip install cloudflare[aiohttp] and use DefaultAioHttpClient() as the http_client parameter.The following top-level resources are new in this release:
aisearch): AI-powered search capabilitiesconnectivity): Connectivity testing and diagnosticsemail_sending): Email send and send_raw endpointsfraud): Fraud detection and preventiongoogle_tag_gateway): Google Tag Gateway managementorganizations): Organization audit logs and managementr2_data_catalog): R2 Data Catalog operationsrealtime_kit): Realtime communication (Calls/TURN)resource_tagging): Resource tagging and labelingtoken_validation): Token validation configuration and rulesvulnerability_scanner): Vulnerability scanning, credential sets, and target environmentsNearly every existing service received type and method updates through composite API spec refreshes. Notable updates include:
polymorphic_serialization parameter to model_dump overrides (342b5a8)BaseModel base to response SchemaFieldStruct/SchemaFieldList stubs (d33af8b)model_rebuild/update_forward_refs for SharedEntryCustomEntry classes (25ec10c)RunQueryParametersNeedleValue a BaseModel with arbitrary_types_allowed (6b7efbc)notification_url field in webhook response types (fc9fb2f)type: ignore[call-arg] placement for mypy compatibility (fac9404)consumer model (3f5cf39)VulnerabilityScanner -- Full CRUD for vulnerability scanning
This is a beta release. The API surface may change before the stable release.
Full diff: v5.0.0-beta.1...v5.0.0-beta.2
This release adds 163 new methods across 4 new top-level resources and numerous sub-resource
expansions, restructures the api.md surface into per-resource files, and includes codegen
updates across all existing resources.
account_id and zone_id configurationYou can now set account_id and zone_id once on the client instead of passing them to every
method call. When set, these values are used as defaults for all methods that accept them. You
can still override per-call by passing the parameter explicitly.
from cloudflare import Cloudflare
# Set account_id once at the client level
client = Cloudflare(account_id="my-account-id")
# No need to pass account_id on every call
workers = client.workers.scripts.list()
rules = client.rules.lists.list()
Both options also read from environment variables:
account_id from CLOUDFLARE_ACCOUNT_IDzone_id from CLOUDFLARE_ZONE_ID# Or configure via environment variables
# export CLOUDFLARE_ACCOUNT_ID=my-account-id
# export CLOUDFLARE_ZONE_ID=my-zone-id
client = Cloudflare()
All methods that previously required account_id or zone_id as a positional/keyword argument
now accept None as a default and fall back to the client-level value. If neither is set, a
ValueError is raised with a clear message.
AISearch: aisearch.instances.items (get, list) has been replaced by the new
namespace-based architecture under aisearch.namespaces.instances.items (see New Resources
below)
Registrar: registrar.domains (get, list, update) has been replaced by
registrar.registrations with expanded functionality including create, edit, get, list,
plus new registrar.check, registrar.search, registrar.registration_status.get, and
registrar.update_status.get methods
cloudforce_one.threat_events.deleteVulnerabilityScanner -- Full CRUD for vulnerability scanning
credential_sets -- create, delete, edit, get, list, updatecredential_sets.credentials -- create, delete, edit, get, list, updatescans -- create, get, listtarget_environments -- create, delete, edit, get, list, updateGoogleTagGateway -- Google Tag Gateway configuration
config -- get, updateEmailSending -- Email sending with subdomain management
send, send_rawsubdomains -- create, delete, get, listsubdomains.dns -- getResourceTagging -- Resource tagging and key/value management
listaccount_tags -- delete, get, updatezone_tags -- delete, get, updatekeys -- listvalues -- listAISearch (restructured) -- Expanded namespace-based architecture
aisearch.namespaces -- create, delete, list, read, search, update,
chat_completionsaisearch.namespaces.instances -- create, list, read, search, stats, update,
chat_completionsaisearch.namespaces.instances.items -- chunks, create_or_update, delete, download,
get, list, logs, sync, uploadaisearch.namespaces.instances.jobs -- create, get, list, logs, updateAPIGateway Labels -- Label management for API Gateway operations
api_gateway.labels -- listapi_gateway.labels.managed -- getapi_gateway.labels.managed.resources.operation -- updateapi_gateway.labels.user -- bulk_create, bulk_delete, delete, edit, get, updateapi_gateway.labels.user.resources.operation -- updateapi_gateway.operations.labels -- bulk_create, bulk_delete, bulk_update, create,
delete, updateBrowserRendering -- DevTools and crawl APIs
browser_rendering.crawl -- create, delete, getbrowser_rendering.devtools.browser -- connect, create, delete, launch, protocol,
versionbrowser_rendering.devtools.browser.page -- getbrowser_rendering.devtools.browser.targets -- activate, create, get, listbrowser_rendering.devtools.session -- get, listCustom Pages Assets -- Custom page asset management
custom_pages.assets -- create, delete, get, list, updateACM Custom Trust Store -- Custom origin trust store
acm.custom_trust_store -- create, delete, get, listWorkers Observability Destinations -- Log destinations for Workers observability
workers.observability.destinations -- create, delete, list, updateRegistrar (expanded) -- Domain registration with full lifecycle management
registrar.registrations -- create, edit, get, listregistrar.check, registrar.searchregistrar.registration_status -- getregistrar.update_status -- getZero Trust additions
zero_trust.access.users -- create, delete, get, updatezero_trust.devices.ip_profiles -- create, delete, get, list, updatezero_trust.dex.rules -- create, delete, get, list, updatezero_trust.dlp.settings -- delete, edit, get, updatezero_trust.gateway.pacfiles -- create, delete, get, list, updatezero_trust.networks.subnets.warp -- create, delete, edit, getzero_trust.tunnels.warp_connector.connections -- getzero_trust.tunnels.warp_connector.connectors -- getzero_trust.tunnels.warp_connector.failover -- updateZones Environments -- Zone environment management
zones.environments -- create, delete, edit, list, rollback, updateRadar additions
radar.agent_readiness -- summaryradar.ai.markdown_for_agents -- summary, timeseriesradar.entities.asns -- botnet_threat_feedradar.post_quantum.origin -- summary, timeseries_groupsradar.post_quantum.tls -- supportBilling Usage -- PayGo billing usage
billing.usage -- paygoEmail Security -- PhishGuard reporting
email_security.phishguard.reports -- listBrand Protection -- v2 endpoints
brand_protection.v2 additionsmodel_rebuild()/update_forward_refs() calls for
CustomProfileSharedEntryCustomEntry and IntegrationProfileSharedEntryCustomEntry, fixing
pydantic v1 validation errors on DLP profile types.RunQueryParametersNeedleValue a BaseModel with
arbitrary_types_allowed to prevent pydantic config errors.api.md has been restructured from a single monolithic file into per-resource files under
src/cloudflare/resources/*/api.md. The root api.md now contains shared types and links to
each resource's documentation.Full Changelog: v5.0.0-beta.1...v5.0.0-beta.2
In this release, you'll see a large number of breaking changes. This is primarily due to a change in OpenAPI definitions, which our libraries are base…
Disclaimer: Please note that v5.0.0-beta.1 is in Beta and we are still testing it for stability.
Full Changelog: v4.3.1...v5.0.0-beta.1
In this release, you'll see a large number of breaking changes. This is primarily due to a change in OpenAPI definitions, which our libraries are based off of, and codegen updates that we rely on to read those OpenAPI definitions and produce our SDK libraries. As the codegen is always evolving and improving, so are our code bases.
There may be changes that are not captured in this changelog. Feel free to open an issue to report any inaccuracies, and we will make sure it gets into the changelog before the v5.0.0 release.
Most of the breaking changes below are caused by improvements to the accuracy of the base OpenAPI schemas, which sometimes translates to breaking changes in downstream clients that depend on those schemas.
Please ensure you read through the list of changes below and the migration guide before moving to this version - this will help you understand any down or upstream issues it may cause to your environments.
The following resources have breaking changes. See the v5 Migration Guide for detailed migration instructions.
abusereportsacm.totaltlsapigateway.configurationscloudforceone.threateventsd1.databaseintel.indicatorfeedslogpush.edgeorigintlsclientauth.hostnamesqueues.consumersradar.bgprulesets.rulesschemavalidation.schemassnippetszerotrust.dlpzerotrust.networksabusereports - Abuse report managementabusereports.mitigations - Abuse report mitigation actionsai.tomarkdown - AI-powered markdown conversionaigateway.dynamicrouting - AI Gateway dynamic routing configurationaigateway.providerconfigs - AI Gateway provider configurationsaisearch - AI-powered search functionalityaisearch.instances - AI Search instance managementaisearch.tokens - AI Search authentication tokensalerting.silences - Alert silence managementbrandprotection.logomatches - Brand protection logo match detectionbrandprotection.logos - Brand protection logo managementbrandprotection.matches - Brand protection match resultsbrandprotection.queries - Brand protection query managementcloudforceone.binarystorage - CloudForce One binary storageconnectivity.directory - Connectivity directory servicesd1.database - D1 database managementdiagnostics.endpointhealthchecks - Endpoint health check diagnosticsfraud - Fraud detection and preventioniam.sso - IAM Single Sign-On configurationloadbalancers.monitorgroups - Load balancer monitor groupsorganizations - Organization managementorganizations.organizationprofile - Organization profile settingsorigintlsclientauth.hostnamecertificates - Origin TLS client auth hostname certificatesorigintlsclientauth.hostnames - Origin TLS client auth hostnamesorigintlsclientauth.zonecertificates - Origin TLS client auth zone certificatespipelines - Data pipeline managementpipelines.sinks - Pipeline sink configurationspipelines.streams - Pipeline stream configurationsqueues.subscriptions - Queue subscription managementr2datacatalog - R2 Data Catalog integrationr2datacatalog.credentials - R2 Data Catalog credentialsr2datacatalog.maintenanceconfigs - R2 Data Catalog maintenance configurationsr2datacatalog.namespaces - R2 Data Catalog namespacesradar.bots - Radar bot analyticsradar.ct - Radar certificate transparency dataradar.geolocations - Radar geolocation datarealtimekit.activesession - Real-time Kit active session managementrealtimekit.analytics - Real-time Kit analyticsrealtimekit.apps - Real-time Kit application managementrealtimekit.livestreams - Real-time Kit live streamingrealtimekit.meetings - Real-time Kit meeting managementrealtimekit.presets - Real-time Kit preset configurationsrealtimekit.recordings - Real-time Kit recording managementrealtimekit.sessions - Real-time Kit session managementrealtimekit.webhooks - Real-time Kit webhook configurationstokenvalidation.configuration - Token validation configurationtokenvalidation.rules - Token validation rulesworkers.beta - Workers beta featuresacm.totaltlsedit() - Added endpoint: /zones/{zone_id}/acm/total_tlsupdate() - Added endpoint: /zones/{zone_id}/acm/total_tlscloudforceone.threateventslist() - Added endpoint: /accounts/{account_id}/cloudforce-one/events/targetIndustriescontentscanningcreate() - Added endpoint: /zones/{zone_id}/content-upload-scan/settingsget() - Added endpoint: /zones/{zone_id}/content-upload-scan/settingsupdate() - Added endpoint: /zones/{zone_id}/content-upload-scan/settingsdns.recordsscan_list() - Added endpoint: /zones/{zone_id}/dns_records/scan/reviewscan_review() - Added endpoint: /zones/{zone_id}/dns_records/scan/reviewscan_trigger() - Added endpoint: /zones/{zone_id}/dns_records/scan/triggerintel.indicatorfeedscreate() - Added endpoint: /accounts/{account_id}/intel/indicator-feeds/permissions/adddelete() - Added endpoint: /accounts/{account_id}/intel/indicator-feeds/permissions/removelist() - Added endpoint: /accounts/{account_id}/intel/indicator-feeds/permissions/viewleakedcredentialchecks.detectionsget() - Added endpoint: /zones/{zone_id}/leaked-credential-checks/detections/{detection_id}queues.consumerslist() - Added endpoint: /accounts/{account_id}/queues/{queue_id}/consumersradar.aisummary() - Added endpoint: /radar/ai/bots/summary/{dimension}timeseries() - Added endpoint: /radar/ai/bots/timeseriestimeseries_groups() - Added endpoint: /radar/ai/bots/timeseries_groups/{dimension}radar.bgpchanges() - Added endpoint: /radar/bgp/rpki/aspa/changessnapshot() - Added endpoint: /radar/bgp/rpki/aspa/snapshotworkers.subdomainsdelete() - Added endpoint: /accounts/{account_id}/workers/subdomainzerotrust.networkscreate() - Added endpoint: /accounts/{account_id}/zerotrust/routes/hostnamedelete() - Added endpoint: /accounts/{account_id}/zerotrust/routes/hostname/{hostname_route_id}edit() - Added endpoint: /accounts/{account_id}/zerotrust/routes/hostname/{hostname_route_id}get() - Added endpoint: /accounts/{account_id}/zerotrust/routes/hostname/{hostname_route_id}list() - Added endpoint: /accounts/{account_id}/zerotrust/routes/hostnameFull Changelog: v4.3.1...v5.0.0-beta.1
get_bookmark and restore endpoints (f2464a6)api: Update zone subscription paths
Full Changelog: v4.3.0...v4.3.1
api: mark some methods as deprecated
Full Changelog: v4.2.0...v4.3.0
access_settings: add CRUD support
Full Changelog: v4.1.0...v4.2.0
api: rename browsing_rendering to browser_rendering
Full Changelog: v4.0.0...v4.1.0
bulk support (#2551) (45d91e2)addressing: reshuffle relationship in the namespace to align with the product
Full Changelog: v3.1.1...v4.0.0
cf-r2-jurisdiction to more usable jurisdiction parameter (#2310)cf-r2-jurisdiction to more usable jurisdiction parameter (#2309)cf-r2-jurisdiction to more usable jurisdiction parameter (#2308)get (#2304)entries update due to HTTP 422 in prism (#2331) (0a952c0)delta model (#2242) (571fe0e)anyOf properties from component (#2342) (2a3b8c5)get (#2304) (c10d3b7)model_type rename to paths as well (#2156) (9abf6d5)cors support (#2196) (8ed5f71)cf-r2-jurisdiction to more usable jurisdiction parameter (#2308) (5dfdcbd)cf-r2-jurisdiction to more usable jurisdiction parameter (#2309) (fd63955)cf-r2-jurisdiction to more usable jurisdiction parameter (#2310) (a1ef1be)origin_max_http_version model (#2311) (20fbd7d)cls fields (#2350) (a1e865f)body_param_name for bulk rules endpoint (#2139) (a88b77d)Omit type public (#2241) (4b2bf34)cached-property dep (#2208) (9218b3b)Nothing published for this version
> v3.x of this library is a ground-up rewrite of the SDK, using code generation from our OpenAPI spec.
[!WARNING]
v3.xof this library is a ground-up rewrite of the SDK, using code generation from our OpenAPI spec.This package should be in a usable state for many projects, but expect frequent minor breaking changes as we rename methods and types. If this isn't suitable for you project, we recommend pinning to the
2.xreleases for now.
Full Changelog: v3.0.1...v3.1.0
Full Changelog: v3.0.0...v3.0.1 ### Features * remove --pre
> v3.x of this library is a ground-up rewrite of the SDK, using code generation from our OpenAPI spec.
[!WARNING]
v3.xof this library is a ground-up rewrite of the SDK, using code generation from our OpenAPI spec.This package should be in a usable state for many projects, but expect frequent minor breaking changes as we rename methods and types. If this isn't suitable for you project, we recommend pinning to the
2.xreleases for now.
Full Changelog: v3.0.0-beta.10...v3.0.0
One column per quarter.