cloudflare-python/api.md
2024-07-16 11:07:14 +00:00

499 KiB

Shared Types

from cloudflare.types import (
    ASN,
    AuditLog,
    CertificateCA,
    CertificateRequestType,
    CloudflareTunnel,
    ErrorData,
    Identifier,
    LoadBalancerPreview,
    Member,
    PaginationInfo,
    Permission,
    PermissionGrant,
    ResponseInfo,
    Result,
    Role,
    SortDirection,
)

Accounts

Types:

from cloudflare.types.accounts import (
    Account,
    AccountUpdateResponse,
    AccountListResponse,
    AccountGetResponse,
)

Methods:

Members

Types:

from cloudflare.types.accounts import (
    Status,
    UserWithInviteCode,
    MemberCreateResponse,
    MemberUpdateResponse,
    MemberListResponse,
    MemberDeleteResponse,
    MemberGetResponse,
)

Methods:

Roles

Types:

from cloudflare.types.accounts import RoleGetResponse

Methods:

OriginCACertificates

Types:

from cloudflare.types.origin_ca_certificates import (
    OriginCACertificate,
    OriginCACertificateCreateResponse,
    OriginCACertificateDeleteResponse,
    OriginCACertificateGetResponse,
)

Methods:

IPs

Types:

from cloudflare.types.ips import IPs, JDCloudIPs, IPListResponse

Methods:

Memberships

Types:

from cloudflare.types.memberships import (
    Membership,
    MembershipUpdateResponse,
    MembershipDeleteResponse,
    MembershipGetResponse,
)

Methods:

User

Types:

from cloudflare.types.user import UserEditResponse, UserGetResponse

Methods:

AuditLogs

Methods:

Billing

History

Types:

from cloudflare.types.user.billing import BillingHistory

Methods:

Profile

Types:

from cloudflare.types.user.billing import ProfileGetResponse

Methods:

Invites

Types:

from cloudflare.types.user import Invite, InviteEditResponse, InviteGetResponse

Methods:

Organizations

Types:

from cloudflare.types.user import Organization, OrganizationDeleteResponse, OrganizationGetResponse

Methods:

Subscriptions

Types:

from cloudflare.types.user import (
    RatePlan,
    Subscription,
    SubscriptionComponent,
    SubscriptionZone,
    SubscriptionUpdateResponse,
    SubscriptionDeleteResponse,
    SubscriptionEditResponse,
    SubscriptionGetResponse,
)

Methods:

Tokens

Types:

from cloudflare.types.user import (
    CIDRList,
    Policy,
    Token,
    TokenCreateResponse,
    TokenUpdateResponse,
    TokenListResponse,
    TokenDeleteResponse,
    TokenGetResponse,
    TokenVerifyResponse,
)

Methods:

PermissionGroups

Types:

from cloudflare.types.user.tokens import PermissionGroupListResponse

Methods:

Value

Types:

from cloudflare.types.user.tokens import Value

Methods:

Zones

Types:

from cloudflare.types.zones import Type, Zone, ZoneDeleteResponse

Methods:

ActivationCheck

Types:

from cloudflare.types.zones import ActivationCheckTriggerResponse

Methods:

Settings

Types:

from cloudflare.types.zones import (
    AdvancedDDoS,
    AlwaysOnline,
    AlwaysUseHTTPS,
    AutomaticHTTPSRewrites,
    AutomaticPlatformOptimization,
    Brotli,
    BrowserCacheTTL,
    BrowserCheck,
    CacheLevel,
    ChallengeTTL,
    Ciphers,
    DevelopmentMode,
    EarlyHints,
    EmailObfuscation,
    FontSettings,
    H2Prioritization,
    HotlinkProtection,
    HTTP2,
    HTTP3,
    ImageResizing,
    IPGeolocation,
    IPV6,
    MinTLSVersion,
    Minify,
    Mirage,
    MobileRedirect,
    NEL,
    OpportunisticEncryption,
    OpportunisticOnion,
    OrangeToOrange,
    OriginErrorPagePassThru,
    OriginMaxHTTPVersion,
    Polish,
    PrefetchPreload,
    ProxyReadTimeout,
    PseudoIPV4,
    ResponseBuffering,
    RocketLoader,
    SecurityHeaders,
    SecurityLevel,
    ServerSideExcludes,
    SortQueryStringForCache,
    SSL,
    SSLRecommender,
    TLS1_3,
    TLSClientAuth,
    TrueClientIPHeader,
    WAF,
    WebP,
    Websocket,
    ZeroRTT,
    SettingEditResponse,
    SettingGetResponse,
)

Methods:

CustomNameservers

Types:

from cloudflare.types.zones import CustomNameserverUpdateResponse, CustomNameserverGetResponse

Methods:

Holds

Types:

from cloudflare.types.zones import ZoneHold

Methods:

Subscriptions

Types:

from cloudflare.types.zones import SubscriptionCreateResponse, SubscriptionGetResponse

Methods:

LoadBalancers

Types:

from cloudflare.types.load_balancers import (
    AdaptiveRouting,
    CheckRegion,
    DefaultPools,
    FilterOptions,
    Header,
    Host,
    LoadBalancer,
    LoadShedding,
    LocationStrategy,
    NotificationFilter,
    Origin,
    OriginSteering,
    RandomSteering,
    Rules,
    SessionAffinity,
    SessionAffinityAttributes,
    SteeringPolicy,
    LoadBalancerDeleteResponse,
)

Methods:

Monitors

Types:

from cloudflare.types.load_balancers import Monitor, MonitorDeleteResponse

Methods:

Previews

Types:

from cloudflare.types.load_balancers.monitors import PreviewCreateResponse

Methods:

References

Types:

from cloudflare.types.load_balancers.monitors import ReferenceGetResponse

Methods:

  • client.load_balancers.monitors.references.get(monitor_id, *, account_id) -> Optional

Pools

Types:

from cloudflare.types.load_balancers import Pool, PoolDeleteResponse

Methods:

Health

Types:

from cloudflare.types.load_balancers.pools import HealthCreateResponse, HealthGetResponse

Methods:

References

Types:

from cloudflare.types.load_balancers.pools import ReferenceGetResponse

Methods:

  • client.load_balancers.pools.references.get(pool_id, *, account_id) -> Optional

Previews

Types:

from cloudflare.types.load_balancers import PreviewGetResponse

Methods:

Regions

Types:

from cloudflare.types.load_balancers import RegionListResponse, RegionGetResponse

Methods:

Searches

Types:

from cloudflare.types.load_balancers import SearchGetResponse

Methods:

Cache

Types:

from cloudflare.types.cache import CachePurgeResponse

Methods:

CacheReserve

Types:

from cloudflare.types.cache import (
    CacheReserve,
    CacheReserveClear,
    State,
    CacheReserveClearResponse,
    CacheReserveEditResponse,
    CacheReserveGetResponse,
    CacheReserveStatusResponse,
)

Methods:

SmartTieredCache

Types:

from cloudflare.types.cache import (
    SmartTieredCacheDeleteResponse,
    SmartTieredCacheEditResponse,
    SmartTieredCacheGetResponse,
)

Methods:

Variants

Types:

from cloudflare.types.cache import (
    CacheVariant,
    CacheVariantIdentifier,
    VariantEditResponse,
    VariantGetResponse,
)

Methods:

RegionalTieredCache

Types:

from cloudflare.types.cache import (
    RegionalTieredCache,
    RegionalTieredCacheEditResponse,
    RegionalTieredCacheGetResponse,
)

Methods:

SSL

Analyze

Types:

from cloudflare.types.ssl import AnalyzeCreateResponse

Methods:

CertificatePacks

Types:

from cloudflare.types.ssl import (
    Host,
    RequestValidity,
    Status,
    ValidationMethod,
    CertificatePackListResponse,
    CertificatePackDeleteResponse,
    CertificatePackEditResponse,
    CertificatePackGetResponse,
)

Methods:

Order

Types:

from cloudflare.types.ssl.certificate_packs import OrderCreateResponse

Methods:

Quota

Types:

from cloudflare.types.ssl.certificate_packs import QuotaGetResponse

Methods:

  • client.ssl.certificate_packs.quota.get(*, zone_id) -> Optional

Recommendations

Types:

from cloudflare.types.ssl import RecommendationGetResponse

Methods:

  • client.ssl.recommendations.get(zone_identifier) -> Optional

Universal

Settings

Types:

from cloudflare.types.ssl.universal import UniversalSSLSettings

Methods:

Verification

Types:

from cloudflare.types.ssl import Verification, VerificationEditResponse, VerificationGetResponse

Methods:

Subscriptions

Types:

from cloudflare.types.subscriptions import (
    SubscriptionCreateResponse,
    SubscriptionUpdateResponse,
    SubscriptionDeleteResponse,
    SubscriptionGetResponse,
)

Methods:

ACM

TotalTLS

Types:

from cloudflare.types.acm import CertificateAuthority, TotalTLSCreateResponse, TotalTLSGetResponse

Methods:

Argo

SmartRouting

Types:

from cloudflare.types.argo import SmartRoutingEditResponse, SmartRoutingGetResponse

Methods:

TieredCaching

Types:

from cloudflare.types.argo import TieredCachingEditResponse, TieredCachingGetResponse

Methods:

Plans

Types:

from cloudflare.types.plans import AvailableRatePlan

Methods:

RatePlans

Types:

from cloudflare.types.rate_plans import RatePlan, RatePlanGetResponse

Methods:

CertificateAuthorities

HostnameAssociations

Types:

from cloudflare.types.certificate_authorities import (
    HostnameAssociation,
    TLSHostnameAssociation,
    HostnameAssociationUpdateResponse,
    HostnameAssociationGetResponse,
)

Methods:

  • client.certificate_authorities.hostname_associations.update(*, zone_id, **params) -> Optional
  • client.certificate_authorities.hostname_associations.get(*, zone_id, **params) -> Optional

ClientCertificates

Types:

from cloudflare.types.client_certificates import ClientCertificate

Methods:

CustomCertificates

Types:

from cloudflare.types.custom_certificates import (
    CustomCertificate,
    GeoRestrictions,
    Status,
    CustomCertificateCreateResponse,
    CustomCertificateDeleteResponse,
    CustomCertificateEditResponse,
    CustomCertificateGetResponse,
)

Methods:

Prioritize

Types:

from cloudflare.types.custom_certificates import PrioritizeUpdateResponse

Methods:

CustomHostnames

Types:

from cloudflare.types.custom_hostnames import (
    BundleMethod,
    CustomHostname,
    DCVMethod,
    DomainValidationType,
    CustomHostnameCreateResponse,
    CustomHostnameListResponse,
    CustomHostnameDeleteResponse,
    CustomHostnameEditResponse,
    CustomHostnameGetResponse,
)

Methods:

FallbackOrigin

Types:

from cloudflare.types.custom_hostnames import (
    FallbackOriginUpdateResponse,
    FallbackOriginDeleteResponse,
    FallbackOriginGetResponse,
)

Methods:

CustomNameservers

Types:

from cloudflare.types.custom_nameservers import (
    CustomNameserver,
    CustomNameserverDeleteResponse,
    CustomNameserverAvailabiltyResponse,
    CustomNameserverGetResponse,
)

Methods:

DNS

Types:

from cloudflare.types.dns import DNSAnalyticsNominalMetric, DNSAnalyticsQuery

Records

Types:

from cloudflare.types.dns import (
    ARecord,
    AAAARecord,
    CAARecord,
    CERTRecord,
    CNAMERecord,
    DNSKEYRecord,
    DSRecord,
    HTTPSRecord,
    LOCRecord,
    MXRecord,
    NAPTRRecord,
    NSRecord,
    PTRRecord,
    Record,
    RecordMetadata,
    RecordProcessTiming,
    RecordTags,
    SMIMEARecord,
    SRVRecord,
    SSHFPRecord,
    SVCBRecord,
    TLSARecord,
    TTL,
    TXTRecord,
    URIRecord,
    RecordDeleteResponse,
    RecordExportResponse,
    RecordImportResponse,
    RecordScanResponse,
)

Methods:

Settings

Types:

from cloudflare.types.dns import DNSSetting, Nameserver, SettingEditResponse, SettingGetResponse

Methods:

Analytics

Reports

Types:

from cloudflare.types.dns.analytics import Report

Methods:

Bytimes

Types:

from cloudflare.types.dns.analytics.reports import ByTime

Methods:

Firewall

Types:

from cloudflare.types.dns import (
    AttackMitigation,
    Firewall,
    FirewallIPs,
    UpstreamIPs,
    FirewallDeleteResponse,
)

Methods:

Analytics

Types:

from cloudflare.types.dns.firewall import Delta

Reports

Methods:

  • client.dns.firewall.analytics.reports.get(dns_firewall_id, *, account_id, **params) -> Optional
Bytimes

Methods:

  • client.dns.firewall.analytics.reports.bytimes.get(dns_firewall_id, *, account_id, **params) -> Optional

DNSSEC

Types:

from cloudflare.types.dnssec import DNSSEC, DNSSECDeleteResponse

Methods:

EmailRouting

Types:

from cloudflare.types.email_routing import Settings

Methods:

DNS

Types:

from cloudflare.types.email_routing import DNSRecord, DNSGetResponse

Methods:

  • client.email_routing.dns.get(zone_identifier) -> Optional

Rules

Types:

from cloudflare.types.email_routing import Action, EmailRoutingRule, Matcher

Methods:

CatchAlls

Types:

from cloudflare.types.email_routing.rules import (
    CatchAllAction,
    CatchAllMatcher,
    CatchAllUpdateResponse,
    CatchAllGetResponse,
)

Methods:

  • client.email_routing.rules.catch_alls.update(zone_identifier, **params) -> Optional
  • client.email_routing.rules.catch_alls.get(zone_identifier) -> Optional

Addresses

Types:

from cloudflare.types.email_routing import Address

Methods:

Filters

Types:

from cloudflare.types.filters import FirewallFilter, FilterCreateResponse

Methods:

Firewall

Lockdowns

Types:

from cloudflare.types.firewall import (
    Configuration,
    Lockdown,
    LockdownCIDRConfiguration,
    LockdownIPConfiguration,
    LockdownURL,
    LockdownDeleteResponse,
)

Methods:

Rules

Types:

from cloudflare.types.firewall import (
    FirewallRule,
    Product,
    DeletedFilter,
    RuleCreateResponse,
    RuleEditResponse,
)

Methods:

AccessRules

Types:

from cloudflare.types.firewall import (
    AccessRuleCIDRConfiguration,
    AccessRuleIPConfiguration,
    ASNConfiguration,
    CountryConfiguration,
    IPV6Configuration,
    AccessRuleCreateResponse,
    AccessRuleListResponse,
    AccessRuleDeleteResponse,
    AccessRuleEditResponse,
    AccessRuleGetResponse,
)

Methods:

UARules

Types:

from cloudflare.types.firewall import (
    UARuleCreateResponse,
    UARuleUpdateResponse,
    UARuleListResponse,
    UARuleDeleteResponse,
    UARuleGetResponse,
)

Methods:

WAF

Overrides

Types:

from cloudflare.types.firewall.waf import (
    Override,
    OverrideURL,
    RewriteAction,
    WAFRule,
    OverrideDeleteResponse,
)

Methods:

Packages

Types:

from cloudflare.types.firewall.waf import PackageListResponse, PackageGetResponse

Methods:

Groups

Types:

from cloudflare.types.firewall.waf.packages import Group, GroupEditResponse, GroupGetResponse

Methods:

Rules

Types:

from cloudflare.types.firewall.waf.packages import (
    AllowedModesAnomaly,
    WAFRuleGroup,
    RuleListResponse,
    RuleEditResponse,
    RuleGetResponse,
)

Methods:

Healthchecks

Types:

from cloudflare.types.healthchecks import (
    CheckRegion,
    Healthcheck,
    HTTPConfiguration,
    QueryHealthcheck,
    TCPConfiguration,
    HealthcheckDeleteResponse,
)

Methods:

Previews

Types:

from cloudflare.types.healthchecks import PreviewDeleteResponse

Methods:

KeylessCertificates

Types:

from cloudflare.types.keyless_certificates import (
    KeylessCertificate,
    Tunnel,
    KeylessCertificateDeleteResponse,
)

Methods:

Logpush

Datasets

Fields

Types:

from cloudflare.types.logpush.datasets import FieldGetResponse

Methods:

  • client.logpush.datasets.fields.get(dataset_id, *, account_id, zone_id) -> object

Jobs

Types:

from cloudflare.types.logpush.datasets import JobGetResponse

Methods:

  • client.logpush.datasets.jobs.get(dataset_id, *, account_id, zone_id) -> Optional

Edge

Types:

from cloudflare.types.logpush import InstantLogpushJob, EdgeGetResponse

Methods:

Jobs

Types:

from cloudflare.types.logpush import LogpushJob, OutputOptions, JobDeleteResponse

Methods:

Ownership

Types:

from cloudflare.types.logpush import OwnershipValidation, OwnershipCreateResponse

Methods:

Validate

Types:

from cloudflare.types.logpush import ValidateDestinationResponse, ValidateOriginResponse

Methods:

Logs

Control

Retention

Types:

from cloudflare.types.logs.control import RetentionCreateResponse, RetentionGetResponse

Methods:

Cmb

Config

Types:

from cloudflare.types.logs.control.cmb import CmbConfig, ConfigDeleteResponse

Methods:

RayID

Types:

from cloudflare.types.logs import RayIDGetResponse

Methods:

Received

Types:

from cloudflare.types.logs import ReceivedGetResponse

Methods:

Fields

Types:

from cloudflare.types.logs.received import FieldGetResponse

Methods:

OriginTLSClientAuth

Types:

from cloudflare.types.origin_tls_client_auth import (
    ZoneAuthenticatedOriginPull,
    OriginTLSClientAuthCreateResponse,
    OriginTLSClientAuthDeleteResponse,
    OriginTLSClientAuthGetResponse,
)

Methods:

Hostnames

Types:

from cloudflare.types.origin_tls_client_auth import AuthenticatedOriginPull, HostnameUpdateResponse

Methods:

  • client.origin_tls_client_auth.hostnames.update(*, zone_id, **params) -> Optional
  • client.origin_tls_client_auth.hostnames.get(hostname, *, zone_id) -> Optional

Certificates

Types:

from cloudflare.types.origin_tls_client_auth.hostnames import (
    Certificate,
    CertificateCreateResponse,
    CertificateDeleteResponse,
    CertificateGetResponse,
)

Methods:

Settings

Types:

from cloudflare.types.origin_tls_client_auth import SettingUpdateResponse, SettingGetResponse

Methods:

Pagerules

Types:

from cloudflare.types.pagerules import (
    PageRule,
    Route,
    Target,
    PageruleCreateResponse,
    PageruleUpdateResponse,
    PageruleListResponse,
    PageruleDeleteResponse,
    PageruleEditResponse,
    PageruleGetResponse,
)

Methods:

Settings

Types:

from cloudflare.types.pagerules import SettingListResponse

Methods:

RateLimits

Types:

from cloudflare.types.rate_limits import (
    Action,
    Methods,
    RateLimit,
    RateLimitCreateResponse,
    RateLimitDeleteResponse,
    RateLimitEditResponse,
    RateLimitGetResponse,
)

Methods:

SecondaryDNS

ForceAXFR

Types:

from cloudflare.types.secondary_dns import ForceAXFR

Methods:

Incoming

Types:

from cloudflare.types.secondary_dns import (
    Incoming,
    IncomingCreateResponse,
    IncomingUpdateResponse,
    IncomingDeleteResponse,
    IncomingGetResponse,
)

Methods:

Outgoing

Types:

from cloudflare.types.secondary_dns import (
    DisableTransfer,
    EnableTransfer,
    Outgoing,
    OutgoingStatus,
    OutgoingCreateResponse,
    OutgoingUpdateResponse,
    OutgoingDeleteResponse,
    OutgoingForceNotifyResponse,
    OutgoingGetResponse,
)

Methods:

Status

Methods:

  • client.secondary_dns.outgoing.status.get(*, zone_id) -> str

ACLs

Types:

from cloudflare.types.secondary_dns import ACL, ACLDeleteResponse

Methods:

Peers

Types:

from cloudflare.types.secondary_dns import Peer, PeerDeleteResponse

Methods:

TSIGs

Types:

from cloudflare.types.secondary_dns import TSIG, TSIGDeleteResponse

Methods:

WaitingRooms

Types:

from cloudflare.types.waiting_rooms import (
    AdditionalRoutes,
    CookieAttributes,
    Query,
    WaitingRoom,
    WaitingRoomDeleteResponse,
)

Methods:

Page

Types:

from cloudflare.types.waiting_rooms import PagePreviewResponse

Methods:

Events

Types:

from cloudflare.types.waiting_rooms import Event, EventDeleteResponse

Methods:

Details

Types:

from cloudflare.types.waiting_rooms.events import EventQuery, DetailGetResponse

Methods:

  • client.waiting_rooms.events.details.get(event_id, *, zone_id, waiting_room_id) -> DetailGetResponse

Rules

Types:

from cloudflare.types.waiting_rooms import (
    WaitingRoomRule,
    RuleCreateResponse,
    RuleUpdateResponse,
    RuleDeleteResponse,
    RuleEditResponse,
)

Methods:

Statuses

Types:

from cloudflare.types.waiting_rooms import StatusGetResponse

Methods:

Settings

Types:

from cloudflare.types.waiting_rooms import (
    Setting,
    SettingUpdateResponse,
    SettingEditResponse,
    SettingGetResponse,
)

Methods:

Web3

Hostnames

Types:

from cloudflare.types.web3 import Hostname, HostnameDeleteResponse

Methods:

IPFSUniversalPaths

ContentLists

Types:

from cloudflare.types.web3.hostnames.ipfs_universal_paths import ContentList

Methods:

  • client.web3.hostnames.ipfs_universal_paths.content_lists.update(identifier, *, zone_identifier, **params) -> ContentList
  • client.web3.hostnames.ipfs_universal_paths.content_lists.get(identifier, *, zone_identifier) -> ContentList
Entries

Types:

from cloudflare.types.web3.hostnames.ipfs_universal_paths.content_lists import (
    EntryCreateResponse,
    EntryUpdateResponse,
    EntryListResponse,
    EntryDeleteResponse,
    EntryGetResponse,
)

Methods:

  • client.web3.hostnames.ipfs_universal_paths.content_lists.entries.create(identifier, *, zone_identifier, **params) -> EntryCreateResponse
  • client.web3.hostnames.ipfs_universal_paths.content_lists.entries.update(content_list_entry_identifier, *, zone_identifier, identifier, **params) -> EntryUpdateResponse
  • client.web3.hostnames.ipfs_universal_paths.content_lists.entries.list(identifier, *, zone_identifier) -> Optional
  • client.web3.hostnames.ipfs_universal_paths.content_lists.entries.delete(content_list_entry_identifier, *, zone_identifier, identifier) -> Optional
  • client.web3.hostnames.ipfs_universal_paths.content_lists.entries.get(content_list_entry_identifier, *, zone_identifier, identifier) -> EntryGetResponse

Workers

Types:

from cloudflare.types.workers import (
    Binding,
    D1Binding,
    DispatchNamespaceBinding,
    DurableObjectBinding,
    KVNamespaceBinding,
    MigrationStep,
    MTLSCERTBinding,
    PlacementConfiguration,
    R2Binding,
    ServiceBinding,
    SingleStepMigration,
    SteppedMigration,
    WorkerMetadata,
)

AI

Types:

from cloudflare.types.workers import AIRunResponse

Methods:

Models

Schema

Types:

from cloudflare.types.workers.ai.models import SchemaGetResponse

Methods:

Scripts

Types:

from cloudflare.types.workers import Script, ScriptSetting

Methods:

Schedules

Types:

from cloudflare.types.workers.scripts import Schedule, ScheduleUpdateResponse, ScheduleGetResponse

Methods:

  • client.workers.scripts.schedules.update(script_name, *, account_id, **params) -> Optional
  • client.workers.scripts.schedules.get(script_name, *, account_id) -> Optional

Tail

Types:

from cloudflare.types.workers.scripts import (
    ConsumerScript,
    TailCreateResponse,
    TailDeleteResponse,
    TailGetResponse,
)

Methods:

Content

Methods:

  • client.workers.scripts.content.update(script_name, *, account_id, **params) -> Optional
  • client.workers.scripts.content.get(script_name, *, account_id) -> BinaryAPIResponse

Settings

Methods:

  • client.workers.scripts.settings.edit(script_name, *, account_id, **params) -> Optional
  • client.workers.scripts.settings.get(script_name, *, account_id) -> Optional

Deployments

Types:

from cloudflare.types.workers.scripts import (
    Deployment,
    DeploymentCreateResponse,
    DeploymentGetResponse,
)

Methods:

  • client.workers.scripts.deployments.create(script_name, *, account_id, **params) -> Optional
  • client.workers.scripts.deployments.get(script_name, *, account_id) -> Optional

Versions

Types:

from cloudflare.types.workers.scripts import (
    VersionCreateResponse,
    VersionListResponse,
    VersionGetResponse,
)

Methods:

AccountSettings

Types:

from cloudflare.types.workers import AccountSettingUpdateResponse, AccountSettingGetResponse

Methods:

Domains

Types:

from cloudflare.types.workers import Domain

Methods:

Subdomains

Types:

from cloudflare.types.workers import SubdomainUpdateResponse, SubdomainGetResponse

Methods:

KV

Namespaces

Types:

from cloudflare.types.kv import Namespace, NamespaceUpdateResponse, NamespaceDeleteResponse

Methods:

Bulk

Types:

from cloudflare.types.kv.namespaces import BulkUpdateResponse, BulkDeleteResponse

Methods:

Keys

Types:

from cloudflare.types.kv.namespaces import Key

Methods:

Metadata

Types:

from cloudflare.types.kv.namespaces import MetadataGetResponse

Methods:

  • client.kv.namespaces.metadata.get(key_name, *, account_id, namespace_id) -> Optional

Values

Types:

from cloudflare.types.kv.namespaces import ValueUpdateResponse, ValueDeleteResponse

Methods:

  • client.kv.namespaces.values.update(key_name, *, account_id, namespace_id, **params) -> Optional
  • client.kv.namespaces.values.delete(key_name, *, account_id, namespace_id) -> Optional
  • client.kv.namespaces.values.get(key_name, *, account_id, namespace_id) -> BinaryAPIResponse

DurableObjects

Namespaces

Types:

from cloudflare.types.durable_objects import Namespace

Methods:

Objects

Types:

from cloudflare.types.durable_objects.namespaces import DurableObject

Methods:

Queues

Types:

from cloudflare.types.queues import Queue, QueueCreated, QueueUpdated, QueueDeleteResponse

Methods:

Consumers

Types:

from cloudflare.types.queues import (
    Consumer,
    ConsumerCreateResponse,
    ConsumerUpdateResponse,
    ConsumerDeleteResponse,
    ConsumerGetResponse,
)

Methods:

Messages

Types:

from cloudflare.types.queues import MessageAckResponse, MessagePullResponse

Methods:

APIGateway

Configurations

Types:

from cloudflare.types.api_gateway import Configuration, ConfigurationUpdateResponse

Methods:

Discovery

Types:

from cloudflare.types.api_gateway import DiscoveryOperation, DiscoveryGetResponse

Methods:

Operations

Types:

from cloudflare.types.api_gateway.discovery import OperationEditResponse

Methods:

Operations

Types:

from cloudflare.types.api_gateway import (
    APIShield,
    OperationCreateResponse,
    OperationListResponse,
    OperationDeleteResponse,
    OperationGetResponse,
)

Methods:

SchemaValidation

Types:

from cloudflare.types.api_gateway.operations import (
    SettingsMultipleRequest,
    SchemaValidationUpdateResponse,
    SchemaValidationGetResponse,
)

Methods:

Schemas

Types:

from cloudflare.types.api_gateway import SchemaListResponse

Methods:

Settings

Types:

from cloudflare.types.api_gateway import Settings

SchemaValidation

Methods:

  • client.api_gateway.settings.schema_validation.update(*, zone_id, **params) -> Settings
  • client.api_gateway.settings.schema_validation.edit(*, zone_id, **params) -> Settings
  • client.api_gateway.settings.schema_validation.get(*, zone_id) -> Settings

UserSchemas

Types:

from cloudflare.types.api_gateway import (
    Message,
    PublicSchema,
    SchemaUpload,
    UserSchemaDeleteResponse,
)

Methods:

Operations

Types:

from cloudflare.types.api_gateway.user_schemas import OperationListResponse

Methods:

ManagedHeaders

Types:

from cloudflare.types.managed_headers import (
    RequestModel,
    ManagedHeaderListResponse,
    ManagedHeaderEditResponse,
)

Methods:

PageShield

Types:

from cloudflare.types.page_shield import Setting, PageShieldUpdateResponse

Methods:

Policies

Types:

from cloudflare.types.page_shield import (
    Policy,
    PolicyCreateResponse,
    PolicyUpdateResponse,
    PolicyListResponse,
    PolicyGetResponse,
)

Methods:

Connections

Types:

from cloudflare.types.page_shield import Connection

Methods:

Scripts

Types:

from cloudflare.types.page_shield import Script, ScriptGetResponse

Methods:

Cookies

Types:

from cloudflare.types.page_shield import CookieListResponse, CookieGetResponse

Methods:

Rulesets

Types:

from cloudflare.types.rulesets import (
    Kind,
    Phase,
    Ruleset,
    RulesetCreateResponse,
    RulesetUpdateResponse,
    RulesetListResponse,
    RulesetGetResponse,
)

Methods:

Phases

Types:

from cloudflare.types.rulesets import PhaseUpdateResponse, PhaseGetResponse

Methods:

Versions

Types:

from cloudflare.types.rulesets.phases import VersionListResponse, VersionGetResponse

Methods:

Rules

Types:

from cloudflare.types.rulesets import (
    BlockRule,
    ChallengeRule,
    CompressResponseRule,
    ExecuteRule,
    JSChallengeRule,
    LogRule,
    Logging,
    ManagedChallengeRule,
    RedirectRule,
    RewriteRule,
    RewriteURIPart,
    RouteRule,
    RulesetRule,
    ScoreRule,
    ServeErrorRule,
    SetCacheSettingsRule,
    SetConfigRule,
    SkipRule,
    RuleCreateResponse,
    RuleDeleteResponse,
    RuleEditResponse,
)

Methods:

Versions

Types:

from cloudflare.types.rulesets import VersionListResponse, VersionGetResponse

Methods:

ByTag

Types:

from cloudflare.types.rulesets.versions import ByTagGetResponse

Methods:

  • client.rulesets.versions.by_tag.get(rule_tag, *, account_id, ruleset_id, ruleset_version) -> ByTagGetResponse

URLNormalization

Types:

from cloudflare.types.url_normalization import (
    URLNormalizationUpdateResponse,
    URLNormalizationGetResponse,
)

Methods:

Spectrum

Types:

from cloudflare.types.spectrum import DNS, EdgeIPs, OriginDNS, OriginPort

Analytics

Aggregates

Currents

Types:

from cloudflare.types.spectrum.analytics.aggregates import CurrentGetResponse

Methods:

Events

Types:

from cloudflare.types.spectrum.analytics import Dimension

Bytimes

Types:

from cloudflare.types.spectrum.analytics.events import BytimeGetResponse

Methods:

Summaries

Types:

from cloudflare.types.spectrum.analytics.events import SummaryGetResponse

Methods:

Apps

Types:

from cloudflare.types.spectrum import (
    AppCreateResponse,
    AppUpdateResponse,
    AppListResponse,
    AppDeleteResponse,
    AppGetResponse,
)

Methods:

Addressing

RegionalHostnames

Types:

from cloudflare.types.addressing import (
    RegionalHostnameCreateResponse,
    RegionalHostnameListResponse,
    RegionalHostnameDeleteResponse,
    RegionalHostnameEditResponse,
    RegionalHostnameGetResponse,
)

Methods:

Regions

Types:

from cloudflare.types.addressing.regional_hostnames import RegionListResponse

Methods:

Services

Types:

from cloudflare.types.addressing import ServiceListResponse

Methods:

AddressMaps

Types:

from cloudflare.types.addressing import (
    AddressMap,
    Kind,
    AddressMapCreateResponse,
    AddressMapDeleteResponse,
    AddressMapGetResponse,
)

Methods:

Accounts

Types:

from cloudflare.types.addressing.address_maps import AccountUpdateResponse, AccountDeleteResponse

Methods:

  • client.addressing.address_maps.accounts.update(address_map_id, *, account_id, **params) -> Optional
  • client.addressing.address_maps.accounts.delete(address_map_id, *, account_id) -> Optional

IPs

Types:

from cloudflare.types.addressing.address_maps import IPUpdateResponse, IPDeleteResponse

Methods:

  • client.addressing.address_maps.ips.update(ip_address, *, account_id, address_map_id, **params) -> Optional
  • client.addressing.address_maps.ips.delete(ip_address, *, account_id, address_map_id) -> Optional

Zones

Types:

from cloudflare.types.addressing.address_maps import ZoneUpdateResponse, ZoneDeleteResponse

Methods:

  • client.addressing.address_maps.zones.update(address_map_id, *, zone_id, account_id, **params) -> Optional
  • client.addressing.address_maps.zones.delete(address_map_id, *, zone_id, account_id) -> Optional

LOADocuments

Types:

from cloudflare.types.addressing import LOADocumentCreateResponse

Methods:

Downloads

Methods:

  • client.addressing.loa_documents.downloads.get(loa_document_id, *, account_id) -> BinaryAPIResponse

Prefixes

Types:

from cloudflare.types.addressing import Prefix, PrefixDeleteResponse

Methods:

BGP

Bindings

Types:

from cloudflare.types.addressing.prefixes.bgp import ServiceBinding, BindingDeleteResponse

Methods:

Prefixes

Types:

from cloudflare.types.addressing.prefixes.bgp import BGPPrefix

Methods:

  • client.addressing.prefixes.bgp.prefixes.list(prefix_id, *, account_id) -> SyncSinglePage[BGPPrefix]
  • client.addressing.prefixes.bgp.prefixes.edit(bgp_prefix_id, *, account_id, prefix_id, **params) -> Optional
  • client.addressing.prefixes.bgp.prefixes.get(bgp_prefix_id, *, account_id, prefix_id) -> Optional

Statuses

Types:

from cloudflare.types.addressing.prefixes.bgp import StatusEditResponse, StatusGetResponse

Methods:

  • client.addressing.prefixes.bgp.statuses.edit(prefix_id, *, account_id, **params) -> Optional
  • client.addressing.prefixes.bgp.statuses.get(prefix_id, *, account_id) -> Optional

Delegations

Types:

from cloudflare.types.addressing.prefixes import Delegations, DelegationDeleteResponse

Methods:

AuditLogs

Methods:

Billing

Profiles

Types:

from cloudflare.types.billing import ProfileGetResponse

Methods:

BrandProtection

Types:

from cloudflare.types.brand_protection import (
    Info,
    RuleMatch,
    ScanStatus,
    Submit,
    URLInfoModelResults,
)

Methods:

Diagnostics

Traceroutes

Types:

from cloudflare.types.diagnostics import Traceroute, TracerouteCreateResponse

Methods:

Images

V1

Types:

from cloudflare.types.images import Image, V1ListResponse, V1DeleteResponse

Methods:

Keys

Types:

from cloudflare.types.images.v1 import Key, KeyUpdateResponse, KeyListResponse, KeyDeleteResponse

Methods:

Stats

Types:

from cloudflare.types.images.v1 import Stat

Methods:

  • client.images.v1.stats.get(*, account_id) -> Stat

Variants

Types:

from cloudflare.types.images.v1 import (
    Variant,
    VariantCreateResponse,
    VariantDeleteResponse,
    VariantEditResponse,
    VariantGetResponse,
)

Methods:

Blobs

Methods:

  • client.images.v1.blobs.get(image_id, *, account_id) -> BinaryAPIResponse

V2

Types:

from cloudflare.types.images import V2ListResponse

Methods:

DirectUploads

Types:

from cloudflare.types.images.v2 import DirectUploadCreateResponse

Methods:

Intel

ASN

Methods:

Subnets

Types:

from cloudflare.types.intel.asn import SubnetGetResponse

Methods:

DNS

Types:

from cloudflare.types.intel import DNS, DNSListResponse

Methods:

Domains

Types:

from cloudflare.types.intel import Domain

Methods:

Bulks

Types:

from cloudflare.types.intel.domains import BulkGetResponse

Methods:

DomainHistory

Types:

from cloudflare.types.intel import DomainHistory, DomainHistoryGetResponse

Methods:

IPs

Types:

from cloudflare.types.intel import IP, IPGetResponse

Methods:

IPLists

Types:

from cloudflare.types.intel import IPList, IPListGetResponse

Methods:

Miscategorizations

Types:

from cloudflare.types.intel import MiscategorizationCreateResponse

Methods:

Whois

Types:

from cloudflare.types.intel import Whois, WhoisGetResponse

Methods:

IndicatorFeeds

Types:

from cloudflare.types.intel import (
    IndicatorFeedCreateResponse,
    IndicatorFeedUpdateResponse,
    IndicatorFeedListResponse,
    IndicatorFeedDataResponse,
    IndicatorFeedGetResponse,
)

Methods:

Snapshots

Types:

from cloudflare.types.intel.indicator_feeds import SnapshotUpdateResponse

Methods:

Permissions

Types:

from cloudflare.types.intel.indicator_feeds import (
    PermissionCreateResponse,
    PermissionListResponse,
    PermissionDeleteResponse,
)

Methods:

Sinkholes

Types:

from cloudflare.types.intel import Sinkhole

Methods:

AttackSurfaceReport

IssueTypes

Types:

from cloudflare.types.intel.attack_surface_report import IssueTypeGetResponse

Methods:

  • client.intel.attack_surface_report.issue_types.get(*, account_id) -> Optional

Issues

Types:

from cloudflare.types.intel.attack_surface_report import (
    IssueType,
    SeverityQueryParam,
    IssueListResponse,
    IssueClassResponse,
    IssueDismissResponse,
    IssueSeverityResponse,
    IssueTypeResponse,
)

Methods:

MagicTransit

Types:

from cloudflare.types.magic_transit import HealthCheck, HealthCheckRate, HealthCheckType

Apps

Types:

from cloudflare.types.magic_transit import (
    AppCreateResponse,
    AppUpdateResponse,
    AppListResponse,
    AppDeleteResponse,
)

Methods:

CfInterconnects

Types:

from cloudflare.types.magic_transit import (
    CfInterconnectUpdateResponse,
    CfInterconnectListResponse,
    CfInterconnectGetResponse,
)

Methods:

GRETunnels

Types:

from cloudflare.types.magic_transit import (
    GRETunnelCreateResponse,
    GRETunnelUpdateResponse,
    GRETunnelListResponse,
    GRETunnelDeleteResponse,
    GRETunnelGetResponse,
)

Methods:

IPSECTunnels

Types:

from cloudflare.types.magic_transit import (
    PSKMetadata,
    IPSECTunnelCreateResponse,
    IPSECTunnelUpdateResponse,
    IPSECTunnelListResponse,
    IPSECTunnelDeleteResponse,
    IPSECTunnelGetResponse,
    IPSECTunnelPSKGenerateResponse,
)

Methods:

Routes

Types:

from cloudflare.types.magic_transit import (
    Scope,
    RouteCreateResponse,
    RouteUpdateResponse,
    RouteListResponse,
    RouteDeleteResponse,
    RouteEmptyResponse,
    RouteGetResponse,
)

Methods:

Sites

Types:

from cloudflare.types.magic_transit import Site, SiteLocation

Methods:

ACLs

Types:

from cloudflare.types.magic_transit.sites import ACL, ACLConfiguration, AllowedProtocol, Subnet

Methods:

  • client.magic_transit.sites.acls.create(site_id, *, account_id, **params) -> ACL
  • client.magic_transit.sites.acls.update(acl_id, *, account_id, site_id, **params) -> ACL
  • client.magic_transit.sites.acls.list(site_id, *, account_id) -> SyncSinglePage[ACL]
  • client.magic_transit.sites.acls.delete(acl_id, *, account_id, site_id) -> ACL
  • client.magic_transit.sites.acls.edit(acl_id, *, account_id, site_id, **params) -> ACL
  • client.magic_transit.sites.acls.get(acl_id, *, account_id, site_id) -> ACL

LANs

Types:

from cloudflare.types.magic_transit.sites import (
    DHCPRelay,
    DHCPServer,
    LAN,
    LANStaticAddressing,
    Nat,
    RoutedSubnet,
    LANCreateResponse,
)

Methods:

  • client.magic_transit.sites.lans.create(site_id, *, account_id, **params) -> LANCreateResponse
  • client.magic_transit.sites.lans.update(lan_id, *, account_id, site_id, **params) -> LAN
  • client.magic_transit.sites.lans.list(site_id, *, account_id) -> SyncSinglePage[LAN]
  • client.magic_transit.sites.lans.delete(lan_id, *, account_id, site_id) -> LAN
  • client.magic_transit.sites.lans.edit(lan_id, *, account_id, site_id, **params) -> LAN
  • client.magic_transit.sites.lans.get(lan_id, *, account_id, site_id) -> LAN

WANs

Types:

from cloudflare.types.magic_transit.sites import WAN, WANStaticAddressing, WANCreateResponse

Methods:

  • client.magic_transit.sites.wans.create(site_id, *, account_id, **params) -> WANCreateResponse
  • client.magic_transit.sites.wans.update(wan_id, *, account_id, site_id, **params) -> WAN
  • client.magic_transit.sites.wans.list(site_id, *, account_id) -> SyncSinglePage[WAN]
  • client.magic_transit.sites.wans.delete(wan_id, *, account_id, site_id) -> WAN
  • client.magic_transit.sites.wans.edit(wan_id, *, account_id, site_id, **params) -> WAN
  • client.magic_transit.sites.wans.get(wan_id, *, account_id, site_id) -> WAN

Connectors

Types:

from cloudflare.types.magic_transit import (
    ConnectorUpdateResponse,
    ConnectorListResponse,
    ConnectorEditResponse,
    ConnectorGetResponse,
)

Methods:

MagicNetworkMonitoring

Configs

Types:

from cloudflare.types.magic_network_monitoring import Configuration

Methods:

Full

Methods:

  • client.magic_network_monitoring.configs.full.get(*, account_id) -> Configuration

Rules

Types:

from cloudflare.types.magic_network_monitoring import MagicNetworkMonitoringRule

Methods:

Advertisements

Types:

from cloudflare.types.magic_network_monitoring.rules import Advertisement

Methods:

  • client.magic_network_monitoring.rules.advertisements.edit(rule_id, *, account_id, **params) -> Optional

MTLSCertificates

Types:

from cloudflare.types.mtls_certificates import MTLSCertificate, MTLSCertificateCreateResponse

Methods:

Associations

Types:

from cloudflare.types.mtls_certificates import CertificateAsssociation, AssociationGetResponse

Methods:

  • client.mtls_certificates.associations.get(mtls_certificate_id, *, account_id) -> Optional

Pages

Projects

Types:

from cloudflare.types.pages import (
    Deployment,
    Project,
    Stage,
    ProjectCreateResponse,
    ProjectDeleteResponse,
    ProjectEditResponse,
    ProjectPurgeBuildCacheResponse,
)

Methods:

Deployments

Types:

from cloudflare.types.pages.projects import DeploymentDeleteResponse

Methods:

History

Logs

Types:

from cloudflare.types.pages.projects.deployments.history import LogGetResponse

Methods:

  • client.pages.projects.deployments.history.logs.get(deployment_id, *, account_id, project_name) -> LogGetResponse

Domains

Types:

from cloudflare.types.pages.projects import (
    DomainCreateResponse,
    DomainListResponse,
    DomainDeleteResponse,
    DomainEditResponse,
    DomainGetResponse,
)

Methods:

  • client.pages.projects.domains.create(project_name, *, account_id, **params) -> Optional
  • client.pages.projects.domains.list(project_name, *, account_id) -> SyncSinglePage[object]
  • client.pages.projects.domains.delete(domain_name, *, account_id, project_name) -> object
  • client.pages.projects.domains.edit(domain_name, *, account_id, project_name, **params) -> Optional
  • client.pages.projects.domains.get(domain_name, *, account_id, project_name) -> Optional

PCAPs

Types:

from cloudflare.types.pcaps import (
    PCAP,
    PCAPFilter,
    PCAPCreateResponse,
    PCAPListResponse,
    PCAPGetResponse,
)

Methods:

Ownership

Types:

from cloudflare.types.pcaps import Ownership, OwnershipGetResponse

Methods:

Download

Methods:

  • client.pcaps.download.get(pcap_id, *, account_id) -> BinaryAPIResponse

Registrar

Domains

Types:

from cloudflare.types.registrar import Domain, DomainUpdateResponse, DomainGetResponse

Methods:

RequestTracers

Traces

Types:

from cloudflare.types.request_tracers import Trace, TraceItem, TraceCreateResponse

Methods:

Rules

Lists

Types:

from cloudflare.types.rules import Hostname, ListsList, Redirect, ListDeleteResponse

Methods:

BulkOperations

Types:

from cloudflare.types.rules.lists import OperationStatus, BulkOperationGetResponse

Methods:

  • client.rules.lists.bulk_operations.get(operation_id, *, account_identifier) -> Optional

Items

Types:

from cloudflare.types.rules.lists import (
    ListCursor,
    ListItem,
    ItemCreateResponse,
    ItemUpdateResponse,
    ItemListResponse,
    ItemDeleteResponse,
    ItemGetResponse,
)

Methods:

Storage

Analytics

Types:

from cloudflare.types.storage import Components, Schema

Methods:

Stream

Types:

from cloudflare.types.stream import AllowedOrigins, Video

Methods:

AudioTracks

Types:

from cloudflare.types.stream import Audio, AudioTrackDeleteResponse, AudioTrackGetResponse

Methods:

  • client.stream.audio_tracks.delete(audio_identifier, *, account_id, identifier) -> Optional
  • client.stream.audio_tracks.copy(identifier, *, account_id, **params) -> Optional
  • client.stream.audio_tracks.edit(audio_identifier, *, account_id, identifier, **params) -> Optional
  • client.stream.audio_tracks.get(identifier, *, account_id) -> Optional

Videos

Types:

from cloudflare.types.stream import VideoStorageUsageResponse

Methods:

Clip

Types:

from cloudflare.types.stream import Clip

Methods:

Copy

Methods:

DirectUpload

Types:

from cloudflare.types.stream import DirectUploadCreateResponse

Methods:

Keys

Types:

from cloudflare.types.stream import Keys, KeyDeleteResponse, KeyGetResponse

Methods:

LiveInputs

Types:

from cloudflare.types.stream import LiveInput, LiveInputListResponse

Methods:

  • client.stream.live_inputs.create(*, account_id, **params) -> Optional
  • client.stream.live_inputs.update(live_input_identifier, *, account_id, **params) -> Optional
  • client.stream.live_inputs.list(*, account_id, **params) -> Optional
  • client.stream.live_inputs.delete(live_input_identifier, *, account_id) -> None
  • client.stream.live_inputs.get(live_input_identifier, *, account_id) -> Optional

Outputs

Types:

from cloudflare.types.stream.live_inputs import Output

Methods:

  • client.stream.live_inputs.outputs.create(live_input_identifier, *, account_id, **params) -> Optional
  • client.stream.live_inputs.outputs.update(output_identifier, *, account_id, live_input_identifier, **params) -> Optional
  • client.stream.live_inputs.outputs.list(live_input_identifier, *, account_id) -> SyncSinglePage[Output]
  • client.stream.live_inputs.outputs.delete(output_identifier, *, account_id, live_input_identifier) -> None

Watermarks

Types:

from cloudflare.types.stream import Watermark, WatermarkDeleteResponse

Methods:

Webhooks

Types:

from cloudflare.types.stream import WebhookUpdateResponse, WebhookDeleteResponse, WebhookGetResponse

Methods:

Captions

Types:

from cloudflare.types.stream import Caption, CaptionGetResponse

Methods:

  • client.stream.captions.get(identifier, *, account_id) -> Optional

Language

Types:

from cloudflare.types.stream.captions import LanguageDeleteResponse

Methods:

  • client.stream.captions.language.create(language, *, account_id, identifier) -> Optional
  • client.stream.captions.language.update(language, *, account_id, identifier, **params) -> Optional
  • client.stream.captions.language.delete(language, *, account_id, identifier) -> str
  • client.stream.captions.language.get(language, *, account_id, identifier) -> Optional

Vtt

Types:

from cloudflare.types.stream.captions.language import VttGetResponse

Methods:

  • client.stream.captions.language.vtt.get(language, *, account_id, identifier) -> str

Downloads

Types:

from cloudflare.types.stream import (
    DownloadCreateResponse,
    DownloadDeleteResponse,
    DownloadGetResponse,
)

Methods:

Embed

Types:

from cloudflare.types.stream import EmbedGetResponse

Methods:

  • client.stream.embed.get(identifier, *, account_id) -> str

Token

Types:

from cloudflare.types.stream import TokenCreateResponse

Methods:

Alerting

AvailableAlerts

Types:

from cloudflare.types.alerting import AvailableAlertListResponse

Methods:

  • client.alerting.available_alerts.list(*, account_id) -> Optional

Destinations

Eligible

Types:

from cloudflare.types.alerting.destinations import EligibleGetResponse

Methods:

  • client.alerting.destinations.eligible.get(*, account_id) -> Optional

Pagerduty

Types:

from cloudflare.types.alerting.destinations import (
    Pagerduty,
    PagerdutyCreateResponse,
    PagerdutyDeleteResponse,
    PagerdutyGetResponse,
    PagerdutyLinkResponse,
)

Methods:

Webhooks

Types:

from cloudflare.types.alerting.destinations import (
    Webhooks,
    WebhookCreateResponse,
    WebhookUpdateResponse,
    WebhookDeleteResponse,
)

Methods:

History

Types:

from cloudflare.types.alerting import History

Methods:

Policies

Types:

from cloudflare.types.alerting import (
    Mechanism,
    Policy,
    PolicyFilter,
    PolicyCreateResponse,
    PolicyUpdateResponse,
    PolicyDeleteResponse,
)

Methods:

D1

Types:

from cloudflare.types.d1 import D1

Database

Types:

from cloudflare.types.d1 import (
    QueryResult,
    DatabaseCreateResponse,
    DatabaseListResponse,
    DatabaseDeleteResponse,
    DatabaseQueryResponse,
    DatabaseRawResponse,
)

Methods:

R2

Buckets

Types:

from cloudflare.types.r2 import Bucket, BucketDeleteResponse

Methods:

Sippy

Types:

from cloudflare.types.r2 import Provider, Sippy, SippyDeleteResponse

Methods:

TemporaryCredentials

Types:

from cloudflare.types.r2 import TemporaryCredential, TemporaryCredentialCreateResponse

Methods:

WARPConnector

Types:

from cloudflare.types.warp_connector import (
    WARPConnectorCreateResponse,
    WARPConnectorListResponse,
    WARPConnectorDeleteResponse,
    WARPConnectorEditResponse,
    WARPConnectorGetResponse,
    WARPConnectorTokenResponse,
)

Methods:

WorkersForPlatforms

Dispatch

Namespaces

Types:

from cloudflare.types.workers_for_platforms.dispatch import (
    NamespaceCreateResponse,
    NamespaceListResponse,
    NamespaceDeleteResponse,
    NamespaceGetResponse,
)

Methods:

Scripts

Types:

from cloudflare.types.workers_for_platforms.dispatch.namespaces import Script

Methods:

  • client.workers_for_platforms.dispatch.namespaces.scripts.update(script_name, *, account_id, dispatch_namespace, **params) -> Optional
  • client.workers_for_platforms.dispatch.namespaces.scripts.delete(script_name, *, account_id, dispatch_namespace, **params) -> None
  • client.workers_for_platforms.dispatch.namespaces.scripts.get(script_name, *, account_id, dispatch_namespace) -> Optional
Content

Methods:

  • client.workers_for_platforms.dispatch.namespaces.scripts.content.update(script_name, *, account_id, dispatch_namespace, **params) -> Optional
  • client.workers_for_platforms.dispatch.namespaces.scripts.content.get(script_name, *, account_id, dispatch_namespace) -> BinaryAPIResponse
Settings

Types:

from cloudflare.types.workers_for_platforms.dispatch.namespaces.scripts import (
    SettingEditResponse,
    SettingGetResponse,
)

Methods:

  • client.workers_for_platforms.dispatch.namespaces.scripts.settings.edit(script_name, *, account_id, dispatch_namespace, **params) -> Optional
  • client.workers_for_platforms.dispatch.namespaces.scripts.settings.get(script_name, *, account_id, dispatch_namespace) -> Optional
Bindings

Types:

from cloudflare.types.workers_for_platforms.dispatch.namespaces.scripts import BindingGetResponse

Methods:

  • client.workers_for_platforms.dispatch.namespaces.scripts.bindings.get(script_name, *, account_id, dispatch_namespace) -> Optional
Secrets

Types:

from cloudflare.types.workers_for_platforms.dispatch.namespaces.scripts import (
    SecretUpdateResponse,
    SecretListResponse,
)

Methods:

  • client.workers_for_platforms.dispatch.namespaces.scripts.secrets.update(script_name, *, account_id, dispatch_namespace, **params) -> Optional
  • client.workers_for_platforms.dispatch.namespaces.scripts.secrets.list(script_name, *, account_id, dispatch_namespace) -> SyncSinglePage[SecretListResponse]
Tags

Types:

from cloudflare.types.workers_for_platforms.dispatch.namespaces.scripts import (
    TagUpdateResponse,
    TagListResponse,
    TagDeleteResponse,
)

Methods:

  • client.workers_for_platforms.dispatch.namespaces.scripts.tags.update(script_name, *, account_id, dispatch_namespace, **params) -> Optional
  • client.workers_for_platforms.dispatch.namespaces.scripts.tags.list(script_name, *, account_id, dispatch_namespace) -> SyncSinglePage[TagListResponse]
  • client.workers_for_platforms.dispatch.namespaces.scripts.tags.delete(tag, *, account_id, dispatch_namespace, script_name) -> object

ZeroTrust

Devices

Types:

from cloudflare.types.zero_trust import Device, DeviceGetResponse

Methods:

DEXTests

Types:

from cloudflare.types.zero_trust.devices import (
    DEXTest,
    SchemaData,
    SchemaHTTP,
    DEXTestDeleteResponse,
)

Methods:

Networks

Types:

from cloudflare.types.zero_trust.devices import DeviceNetwork, NetworkDeleteResponse

Methods:

Policies

Types:

from cloudflare.types.zero_trust.devices import SettingsPolicy, PolicyDeleteResponse

Methods:

DefaultPolicy

Types:

from cloudflare.types.zero_trust.devices.policies import DefaultPolicyGetResponse

Methods:

  • client.zero_trust.devices.policies.default_policy.get(*, account_id) -> Optional

Excludes

Types:

from cloudflare.types.zero_trust.devices.policies import (
    SplitTunnelExclude,
    ExcludeUpdateResponse,
    ExcludeGetResponse,
)

Methods:

FallbackDomains

Types:

from cloudflare.types.zero_trust.devices.policies import (
    FallbackDomain,
    FallbackDomainPolicy,
    FallbackDomainUpdateResponse,
    FallbackDomainGetResponse,
)

Methods:

Includes

Types:

from cloudflare.types.zero_trust.devices.policies import (
    SplitTunnelInclude,
    IncludeUpdateResponse,
    IncludeGetResponse,
)

Methods:

Posture

Types:

from cloudflare.types.zero_trust.devices import (
    CarbonblackInput,
    ClientCertificateInput,
    CrowdstrikeInput,
    DeviceInput,
    DeviceMatch,
    DevicePostureRule,
    DiskEncryptionInput,
    DomainJoinedInput,
    FileInput,
    FirewallInput,
    IntuneInput,
    KolideInput,
    OSVersionInput,
    SentineloneInput,
    SentineloneS2sInput,
    TaniumInput,
    UniqueClientIDInput,
    WorkspaceOneInput,
    PostureDeleteResponse,
)

Methods:

Integrations

Types:

from cloudflare.types.zero_trust.devices.posture import Integration, IntegrationDeleteResponse

Methods:

Revoke

Types:

from cloudflare.types.zero_trust.devices import RevokeCreateResponse

Methods:

Settings

Types:

from cloudflare.types.zero_trust.devices import DeviceSettings

Methods:

Unrevoke

Types:

from cloudflare.types.zero_trust.devices import UnrevokeCreateResponse

Methods:

OverrideCodes

Types:

from cloudflare.types.zero_trust.devices import OverrideCodeListResponse

Methods:

  • client.zero_trust.devices.override_codes.list(device_id, *, account_id) -> Optional

IdentityProviders

Types:

from cloudflare.types.zero_trust import (
    AzureAD,
    GenericOAuthConfig,
    IdentityProvider,
    IdentityProviderType,
    SCIMConfig,
    IdentityProviderListResponse,
    IdentityProviderDeleteResponse,
)

Methods:

Organizations

Types:

from cloudflare.types.zero_trust import LoginDesign, Organization, OrganizationRevokeUsersResponse

Methods:

Seats

Types:

from cloudflare.types.zero_trust import Seat, SeatEditResponse

Methods:

Access

Types:

from cloudflare.types.zero_trust import (
    AccessDevicePostureRule,
    AccessRule,
    AnyValidServiceTokenRule,
    AuthenticationMethodRule,
    AzureGroupRule,
    CertificateRule,
    CountryRule,
    DomainRule,
    EmailListRule,
    EmailRule,
    EveryoneRule,
    ExternalEvaluationRule,
    GitHubOrganizationRule,
    GroupRule,
    GSuiteGroupRule,
    IPListRule,
    IPRule,
    OktaGroupRule,
    SAMLGroupRule,
    ServiceTokenRule,
)

Applications

Types:

from cloudflare.types.zero_trust.access import (
    AllowedHeaders,
    AllowedIdPs,
    AllowedMethods,
    AllowedOrigins,
    AppID,
    Application,
    ApplicationType,
    CORSHeaders,
    Decision,
    SaaSAppNameFormat,
    SaaSAppNameIDFormat,
    SaaSAppSource,
    SAMLSaaSApp,
    SelfHostedDomains,
    ApplicationCreateResponse,
    ApplicationUpdateResponse,
    ApplicationListResponse,
    ApplicationDeleteResponse,
    ApplicationGetResponse,
    ApplicationRevokeTokensResponse,
)

Methods:

CAs

Types:

from cloudflare.types.zero_trust.access.applications import (
    CA,
    CACreateResponse,
    CADeleteResponse,
    CAGetResponse,
)

Methods:

  • client.zero_trust.access.applications.cas.create(app_id, *, account_id, zone_id) -> Optional
  • client.zero_trust.access.applications.cas.list(*, account_id, zone_id) -> SyncSinglePage[CA]
  • client.zero_trust.access.applications.cas.delete(app_id, *, account_id, zone_id) -> Optional
  • client.zero_trust.access.applications.cas.get(app_id, *, account_id, zone_id) -> Optional

UserPolicyChecks

Types:

from cloudflare.types.zero_trust.access.applications import (
    UserPolicyCheckGeo,
    UserPolicyCheckListResponse,
)

Methods:

  • client.zero_trust.access.applications.user_policy_checks.list(app_id, *, account_id, zone_id) -> Optional

Policies

Types:

from cloudflare.types.zero_trust.access.applications import (
    ApprovalGroup,
    Policy,
    PolicyCreateResponse,
    PolicyUpdateResponse,
    PolicyListResponse,
    PolicyDeleteResponse,
    PolicyGetResponse,
)

Methods:

  • client.zero_trust.access.applications.policies.create(app_id, *, account_id, zone_id, **params) -> Optional
  • client.zero_trust.access.applications.policies.update(policy_id, *, app_id, account_id, zone_id, **params) -> Optional
  • client.zero_trust.access.applications.policies.list(app_id, *, account_id, zone_id) -> SyncSinglePage[PolicyListResponse]
  • client.zero_trust.access.applications.policies.delete(policy_id, *, app_id, account_id, zone_id) -> Optional
  • client.zero_trust.access.applications.policies.get(policy_id, *, app_id, account_id, zone_id) -> Optional

Certificates

Types:

from cloudflare.types.zero_trust.access import (
    AssociatedHostnames,
    Certificate,
    CertificateDeleteResponse,
)

Methods:

  • client.zero_trust.access.certificates.create(*, account_id, zone_id, **params) -> Optional
  • client.zero_trust.access.certificates.update(certificate_id, *, account_id, zone_id, **params) -> Optional
  • client.zero_trust.access.certificates.list(*, account_id, zone_id) -> SyncSinglePage[Certificate]
  • client.zero_trust.access.certificates.delete(certificate_id, *, account_id, zone_id) -> Optional
  • client.zero_trust.access.certificates.get(certificate_id, *, account_id, zone_id) -> Optional

Settings

Types:

from cloudflare.types.zero_trust.access.certificates import (
    CertificateSettings,
    SettingUpdateResponse,
    SettingGetResponse,
)

Methods:

  • client.zero_trust.access.certificates.settings.update(*, account_id, zone_id, **params) -> Optional
  • client.zero_trust.access.certificates.settings.get(*, account_id, zone_id) -> Optional

Groups

Types:

from cloudflare.types.zero_trust.access import ZeroTrustGroup, GroupDeleteResponse

Methods:

ServiceTokens

Types:

from cloudflare.types.zero_trust.access import (
    ServiceToken,
    ServiceTokenCreateResponse,
    ServiceTokenRotateResponse,
)

Methods:

  • client.zero_trust.access.service_tokens.create(*, account_id, zone_id, **params) -> Optional
  • client.zero_trust.access.service_tokens.update(service_token_id, *, account_id, zone_id, **params) -> Optional
  • client.zero_trust.access.service_tokens.list(*, account_id, zone_id) -> SyncSinglePage[ServiceToken]
  • client.zero_trust.access.service_tokens.delete(service_token_id, *, account_id, zone_id) -> Optional
  • client.zero_trust.access.service_tokens.get(service_token_id, *, account_id, zone_id) -> Optional
  • client.zero_trust.access.service_tokens.refresh(service_token_id, *, account_id) -> Optional
  • client.zero_trust.access.service_tokens.rotate(service_token_id, *, account_id) -> Optional

Bookmarks

Types:

from cloudflare.types.zero_trust.access import Bookmark, BookmarkDeleteResponse

Methods:

Keys

Types:

from cloudflare.types.zero_trust.access import KeyUpdateResponse, KeyGetResponse, KeyRotateResponse

Methods:

Logs

AccessRequests

Types:

from cloudflare.types.zero_trust.access.logs import AccessRequests, AccessRequestListResponse

Methods:

Users

Types:

from cloudflare.types.zero_trust.access import AccessUser

Methods:

ActiveSessions

Types:

from cloudflare.types.zero_trust.access.users import (
    ActiveSessionListResponse,
    ActiveSessionGetResponse,
)

Methods:

LastSeenIdentity

Types:

from cloudflare.types.zero_trust.access.users import Identity

Methods:

  • client.zero_trust.access.users.last_seen_identity.get(user_id, *, account_id) -> Optional

FailedLogins

Types:

from cloudflare.types.zero_trust.access.users import FailedLoginListResponse

Methods:

CustomPages

Types:

from cloudflare.types.zero_trust.access import (
    CustomPage,
    CustomPageWithoutHTML,
    CustomPageDeleteResponse,
)

Methods:

Tags

Types:

from cloudflare.types.zero_trust.access import Tag, TagDeleteResponse

Methods:

Policies

Types:

from cloudflare.types.zero_trust.access import (
    PolicyCreateResponse,
    PolicyUpdateResponse,
    PolicyListResponse,
    PolicyDeleteResponse,
    PolicyGetResponse,
)

Methods:

DEX

Types:

from cloudflare.types.zero_trust import (
    DeviceExperienceMonitor,
    NetworkPath,
    NetworkPathResponse,
    Percentiles,
)

Colos

Types:

from cloudflare.types.zero_trust.dex import ColoListResponse

Methods:

FleetStatus

Types:

from cloudflare.types.zero_trust.dex import LiveStat, FleetStatusLiveResponse

Methods:

Devices

Types:

from cloudflare.types.zero_trust.dex.fleet_status import DeviceListResponse

Methods:

HTTPTests

Types:

from cloudflare.types.zero_trust.dex import HTTPDetails

Methods:

Percentiles

Types:

from cloudflare.types.zero_trust.dex.http_tests import HTTPDetailsPercentiles, TestStatOverTime

Methods:

  • client.zero_trust.dex.http_tests.percentiles.get(test_id, *, account_id, **params) -> Optional

Tests

Types:

from cloudflare.types.zero_trust.dex import AggregateTimePeriod, Tests, TestListResponse

Methods:

UniqueDevices

Types:

from cloudflare.types.zero_trust.dex.tests import UniqueDevices

Methods:

TracerouteTestResults

NetworkPath

Types:

from cloudflare.types.zero_trust.dex.traceroute_test_results import NetworkPathGetResponse

Methods:

  • client.zero_trust.dex.traceroute_test_results.network_path.get(test_result_id, *, account_id) -> Optional

TracerouteTests

Types:

from cloudflare.types.zero_trust.dex import Traceroute, TracerouteTestPercentilesResponse

Methods:

Tunnels

Types:

from cloudflare.types.zero_trust import (
    Connection,
    TunnelCreateResponse,
    TunnelListResponse,
    TunnelDeleteResponse,
    TunnelEditResponse,
    TunnelGetResponse,
)

Methods:

Configurations

Types:

from cloudflare.types.zero_trust.tunnels import (
    ConfigurationUpdateResponse,
    ConfigurationGetResponse,
)

Methods:

Connections

Types:

from cloudflare.types.zero_trust.tunnels import (
    Client,
    ConnectionDeleteResponse,
    ConnectionGetResponse,
)

Methods:

Token

Types:

from cloudflare.types.zero_trust.tunnels import TokenGetResponse

Methods:

Connectors

Methods:

  • client.zero_trust.tunnels.connectors.get(connector_id, *, account_id, tunnel_id) -> Client

Management

Types:

from cloudflare.types.zero_trust.tunnels import ManagementCreateResponse

Methods:

ConnectivitySettings

Types:

from cloudflare.types.zero_trust import (
    ConnectivitySettingEditResponse,
    ConnectivitySettingGetResponse,
)

Methods:

DLP

Datasets

Types:

from cloudflare.types.zero_trust.dlp import Dataset, DatasetArray, DatasetCreation

Methods:

Upload

Types:

from cloudflare.types.zero_trust.dlp.datasets import NewVersion

Methods:

  • client.zero_trust.dlp.datasets.upload.create(dataset_id, *, account_id) -> Optional
  • client.zero_trust.dlp.datasets.upload.edit(version, *, account_id, dataset_id, **params) -> Optional

Patterns

Methods:

PayloadLogs

Types:

from cloudflare.types.zero_trust.dlp import PayloadLogUpdateResponse, PayloadLogGetResponse

Methods:

Profiles

Types:

from cloudflare.types.zero_trust.dlp import (
    ContextAwareness,
    Profile,
    SkipConfiguration,
    ProfileGetResponse,
)

Methods:

Custom

Types:

from cloudflare.types.zero_trust.dlp.profiles import (
    CustomProfile,
    Pattern,
    CustomCreateResponse,
    CustomDeleteResponse,
)

Methods:

Predefined

Types:

from cloudflare.types.zero_trust.dlp.profiles import PredefinedProfile

Methods:

Gateway

Types:

from cloudflare.types.zero_trust import GatewayCreateResponse, GatewayListResponse

Methods:

AuditSSHSettings

Types:

from cloudflare.types.zero_trust.gateway import GatewaySettings

Methods:

  • client.zero_trust.gateway.audit_ssh_settings.update(*, account_id, **params) -> Optional
  • client.zero_trust.gateway.audit_ssh_settings.get(*, account_id) -> Optional

Categories

Types:

from cloudflare.types.zero_trust.gateway import Category

Methods:

AppTypes

Types:

from cloudflare.types.zero_trust.gateway import AppType

Methods:

Configurations

Types:

from cloudflare.types.zero_trust.gateway import (
    ActivityLogSettings,
    AntiVirusSettings,
    BlockPageSettings,
    BodyScanningSettings,
    BrowserIsolationSettings,
    CustomCertificateSettings,
    ExtendedEmailMatching,
    FipsSettings,
    GatewayConfigurationSettings,
    NotificationSettings,
    ProtocolDetection,
    TLSSettings,
    ConfigurationUpdateResponse,
    ConfigurationEditResponse,
    ConfigurationGetResponse,
)

Methods:

Lists

Types:

from cloudflare.types.zero_trust.gateway import (
    GatewayItem,
    GatewayList,
    ListCreateResponse,
    ListDeleteResponse,
)

Methods:

Items

Types:

from cloudflare.types.zero_trust.gateway.lists import ItemListResponse

Methods:

Locations

Types:

from cloudflare.types.zero_trust.gateway import Location, LocationDeleteResponse

Methods:

Logging

Types:

from cloudflare.types.zero_trust.gateway import LoggingSetting

Methods:

ProxyEndpoints

Types:

from cloudflare.types.zero_trust.gateway import (
    GatewayIPs,
    ProxyEndpoint,
    ProxyEndpointDeleteResponse,
    ProxyEndpointGetResponse,
)

Methods:

  • client.zero_trust.gateway.proxy_endpoints.create(*, account_id, **params) -> Optional
  • client.zero_trust.gateway.proxy_endpoints.list(*, account_id) -> Optional
  • client.zero_trust.gateway.proxy_endpoints.delete(proxy_endpoint_id, *, account_id) -> Optional
  • client.zero_trust.gateway.proxy_endpoints.edit(proxy_endpoint_id, *, account_id, **params) -> Optional
  • client.zero_trust.gateway.proxy_endpoints.get(proxy_endpoint_id, *, account_id) -> Optional

Rules

Types:

from cloudflare.types.zero_trust.gateway import (
    DNSResolverSettingsV4,
    DNSResolverSettingsV6,
    GatewayFilter,
    GatewayRule,
    RuleSetting,
    Schedule,
    RuleDeleteResponse,
)

Methods:

Certificates

Types:

from cloudflare.types.zero_trust.gateway import (
    CertificateCreateResponse,
    CertificateListResponse,
    CertificateDeleteResponse,
    CertificateGetResponse,
)

Methods:

Networks

Routes

Types:

from cloudflare.types.zero_trust.networks import NetworkRoute, Route, Teamnet

Methods:

IPs

Methods:

  • client.zero_trust.networks.routes.ips.get(ip, *, account_id, **params) -> Teamnet

Networks

Methods:

  • client.zero_trust.networks.routes.networks.create(ip_network_encoded, *, account_id, **params) -> Route
  • client.zero_trust.networks.routes.networks.delete(ip_network_encoded, *, account_id, **params) -> Route
  • client.zero_trust.networks.routes.networks.edit(ip_network_encoded, *, account_id) -> Route

VirtualNetworks

Types:

from cloudflare.types.zero_trust.networks import (
    VirtualNetwork,
    VirtualNetworkCreateResponse,
    VirtualNetworkDeleteResponse,
    VirtualNetworkEditResponse,
)

Methods:

RiskScoring

Types:

from cloudflare.types.zero_trust import RiskScoringGetResponse, RiskScoringResetResponse

Methods:

Behaviours

Types:

from cloudflare.types.zero_trust.risk_scoring import BehaviourUpdateResponse, BehaviourGetResponse

Methods:

Summary

Types:

from cloudflare.types.zero_trust.risk_scoring import SummaryGetResponse

Methods:

Integrations

Types:

from cloudflare.types.zero_trust.risk_scoring import (
    IntegrationCreateResponse,
    IntegrationUpdateResponse,
    IntegrationListResponse,
    IntegrationDeleteResponse,
    IntegrationGetResponse,
)

Methods:

References

Types:

from cloudflare.types.zero_trust.risk_scoring.integrations import ReferenceGetResponse

Methods:

  • client.zero_trust.risk_scoring.integrations.references.get(reference_id, *, account_id) -> Optional

Challenges

Widgets

Types:

from cloudflare.types.challenges import Widget, WidgetDomain, WidgetListResponse

Methods:

Hyperdrive

Types:

from cloudflare.types.hyperdrive import Configuration, Hyperdrive

Configs

Types:

from cloudflare.types.hyperdrive import ConfigDeleteResponse

Methods:

RUM

SiteInfo

Types:

from cloudflare.types.rum import Site, SiteInfoDeleteResponse

Methods:

Rules

Types:

from cloudflare.types.rum import RUMRule, RuleListResponse, RuleDeleteResponse

Methods:

Vectorize

Indexes

Types:

from cloudflare.types.vectorize import (
    CreateIndex,
    IndexDeleteVectorsByID,
    IndexDimensionConfiguration,
    IndexInsert,
    IndexQuery,
    IndexUpsert,
    IndexDeleteResponse,
    IndexGetByIDsResponse,
)

Methods:

URLScanner

Types:

from cloudflare.types.url_scanner import URLScannerScanResponse

Methods:

Scans

Types:

from cloudflare.types.url_scanner import (
    URLScannerDomain,
    URLScannerTask,
    ScanCreateResponse,
    ScanGetResponse,
    ScanHarResponse,
)

Methods:

Radar

Annotations

Outages

Types:

from cloudflare.types.radar.annotations import OutageGetResponse, OutageLocationsResponse

Methods:

BGP

Types:

from cloudflare.types.radar import BGPTimeseriesResponse

Methods:

Leaks

Events

Types:

from cloudflare.types.radar.bgp.leaks import EventListResponse

Methods:

Top

Types:

from cloudflare.types.radar.bgp import TopPrefixesResponse

Methods:

Ases

Types:

from cloudflare.types.radar.bgp.top import AseGetResponse, AsePrefixesResponse

Methods:

Hijacks

Events

Types:

from cloudflare.types.radar.bgp.hijacks import EventListResponse

Methods:

Routes

Types:

from cloudflare.types.radar.bgp import (
    RouteAsesResponse,
    RouteMoasResponse,
    RoutePfx2asResponse,
    RouteStatsResponse,
)

Methods:

IPs

Types:

from cloudflare.types.radar.bgp import IPTimeseriesResponse

Methods:

Datasets

Types:

from cloudflare.types.radar import DatasetListResponse, DatasetDownloadResponse, DatasetGetResponse

Methods:

DNS

Top

Types:

from cloudflare.types.radar.dns import TopAsesResponse, TopLocationsResponse

Methods:

Netflows

Types:

from cloudflare.types.radar import NetflowTimeseriesResponse

Methods:

Top

Types:

from cloudflare.types.radar.netflows import TopAsesResponse, TopLocationsResponse

Methods:

Types:

from cloudflare.types.radar import SearchGlobalResponse

Methods:

VerifiedBots

Top

Types:

from cloudflare.types.radar.verified_bots import TopBotsResponse, TopCategoriesResponse

Methods:

AS112

Types:

from cloudflare.types.radar import AS112TimeseriesResponse

Methods:

Summary

Types:

from cloudflare.types.radar.as112 import (
    SummaryDNSSECResponse,
    SummaryEdnsResponse,
    SummaryIPVersionResponse,
    SummaryProtocolResponse,
    SummaryQueryTypeResponse,
    SummaryResponseCodesResponse,
)

Methods:

TimeseriesGroups

Types:

from cloudflare.types.radar.as112 import (
    TimeseriesGroupDNSSECResponse,
    TimeseriesGroupEdnsResponse,
    TimeseriesGroupIPVersionResponse,
    TimeseriesGroupProtocolResponse,
    TimeseriesGroupQueryTypeResponse,
    TimeseriesGroupResponseCodesResponse,
)

Methods:

Top

Types:

from cloudflare.types.radar.as112 import (
    TopDNSSECResponse,
    TopEdnsResponse,
    TopIPVersionResponse,
    TopLocationsResponse,
)

Methods:

Email

Types:

from cloudflare.types.radar import RadarEmailSeries, RadarEmailSummary

Routing

Summary

Types:

from cloudflare.types.radar.email.routing import (
    SummaryARCResponse,
    SummaryDKIMResponse,
    SummaryDMARCResponse,
    SummaryEncryptedResponse,
    SummaryIPVersionResponse,
    SummarySPFResponse,
)

Methods:

TimeseriesGroups

Types:

from cloudflare.types.radar.email.routing import (
    TimeseriesGroupARCResponse,
    TimeseriesGroupDKIMResponse,
    TimeseriesGroupDMARCResponse,
    TimeseriesGroupEncryptedResponse,
    TimeseriesGroupIPVersionResponse,
    TimeseriesGroupSPFResponse,
)

Methods:

Security

Top

Tlds

Types:

from cloudflare.types.radar.email.security.top import TldGetResponse

Methods:

Malicious

Types:

from cloudflare.types.radar.email.security.top.tlds import MaliciousGetResponse

Methods:

Spam

Types:

from cloudflare.types.radar.email.security.top.tlds import SpamGetResponse

Methods:

Spoof

Types:

from cloudflare.types.radar.email.security.top.tlds import SpoofGetResponse

Methods:

Summary

Types:

from cloudflare.types.radar.email.security import (
    SummaryARCResponse,
    SummaryDKIMResponse,
    SummaryDMARCResponse,
    SummaryMaliciousResponse,
    SummarySpamResponse,
    SummarySPFResponse,
    SummarySpoofResponse,
    SummaryThreatCategoryResponse,
    SummaryTLSVersionResponse,
)

Methods:

TimeseriesGroups

Types:

from cloudflare.types.radar.email.security import (
    TimeseriesGroupARCResponse,
    TimeseriesGroupDKIMResponse,
    TimeseriesGroupDMARCResponse,
    TimeseriesGroupMaliciousResponse,
    TimeseriesGroupSpamResponse,
    TimeseriesGroupSPFResponse,
    TimeseriesGroupSpoofResponse,
    TimeseriesGroupThreatCategoryResponse,
    TimeseriesGroupTLSVersionResponse,
)

Methods:

Attacks

Layer3

Types:

from cloudflare.types.radar.attacks import Layer3TimeseriesResponse

Methods:

Summary

Types:

from cloudflare.types.radar.attacks.layer3 import (
    SummaryBitrateResponse,
    SummaryDurationResponse,
    SummaryGetResponse,
    SummaryIPVersionResponse,
    SummaryProtocolResponse,
    SummaryVectorResponse,
)

Methods:

TimeseriesGroups

Types:

from cloudflare.types.radar.attacks.layer3 import (
    TimeseriesGroupBitrateResponse,
    TimeseriesGroupDurationResponse,
    TimeseriesGroupGetResponse,
    TimeseriesGroupIndustryResponse,
    TimeseriesGroupIPVersionResponse,
    TimeseriesGroupProtocolResponse,
    TimeseriesGroupVectorResponse,
    TimeseriesGroupVerticalResponse,
)

Methods:

Top

Types:

from cloudflare.types.radar.attacks.layer3 import (
    TopAttacksResponse,
    TopIndustryResponse,
    TopVerticalResponse,
)

Methods:

Locations

Types:

from cloudflare.types.radar.attacks.layer3.top import LocationOriginResponse, LocationTargetResponse

Methods:

Layer7

Types:

from cloudflare.types.radar.attacks import Layer7TimeseriesResponse

Methods:

Summary

Types:

from cloudflare.types.radar.attacks.layer7 import (
    SummaryGetResponse,
    SummaryHTTPMethodResponse,
    SummaryHTTPVersionResponse,
    SummaryIPVersionResponse,
    SummaryManagedRulesResponse,
    SummaryMitigationProductResponse,
)

Methods:

TimeseriesGroups

Types:

from cloudflare.types.radar.attacks.layer7 import (
    TimeseriesGroupGetResponse,
    TimeseriesGroupHTTPMethodResponse,
    TimeseriesGroupHTTPVersionResponse,
    TimeseriesGroupIndustryResponse,
    TimeseriesGroupIPVersionResponse,
    TimeseriesGroupManagedRulesResponse,
    TimeseriesGroupMitigationProductResponse,
    TimeseriesGroupVerticalResponse,
)

Methods:

Top

Types:

from cloudflare.types.radar.attacks.layer7 import (
    TopAttacksResponse,
    TopIndustryResponse,
    TopVerticalResponse,
)

Methods:

Locations

Types:

from cloudflare.types.radar.attacks.layer7.top import LocationOriginResponse, LocationTargetResponse

Methods:

Ases

Types:

from cloudflare.types.radar.attacks.layer7.top import AseOriginResponse

Methods:

Entities

Types:

from cloudflare.types.radar import EntityGetResponse

Methods:

ASNs

Types:

from cloudflare.types.radar.entities import (
    ASNListResponse,
    ASNGetResponse,
    ASNIPResponse,
    ASNRelResponse,
)

Methods:

Locations

Types:

from cloudflare.types.radar.entities import LocationListResponse, LocationGetResponse

Methods:

HTTP

Types:

from cloudflare.types.radar import HTTPTimeseriesResponse

Methods:

Top

Types:

from cloudflare.types.radar.http import Browser, TopBrowserFamiliesResponse, TopBrowsersResponse

Methods:

Locations

Types:

from cloudflare.types.radar.http import LocationGetResponse

Methods:

BotClass

Types:

from cloudflare.types.radar.http.locations import BotClassGetResponse

Methods:

DeviceType

Types:

from cloudflare.types.radar.http.locations import DeviceTypeGetResponse

Methods:

HTTPProtocol

Types:

from cloudflare.types.radar.http.locations import HTTPProtocolGetResponse

Methods:

HTTPMethod

Types:

from cloudflare.types.radar.http.locations import HTTPMethodGetResponse

Methods:

IPVersion

Types:

from cloudflare.types.radar.http.locations import IPVersionGetResponse

Methods:

OS

Types:

from cloudflare.types.radar.http.locations import OSGetResponse

Methods:

TLSVersion

Types:

from cloudflare.types.radar.http.locations import TLSVersionGetResponse

Methods:

BrowserFamily

Types:

from cloudflare.types.radar.http.locations import BrowserFamilyGetResponse

Methods:

Ases

Types:

from cloudflare.types.radar.http import AseGetResponse

Methods:

BotClass

Types:

from cloudflare.types.radar.http.ases import BotClassGetResponse

Methods:

DeviceType

Types:

from cloudflare.types.radar.http.ases import DeviceTypeGetResponse

Methods:

HTTPProtocol

Types:

from cloudflare.types.radar.http.ases import HTTPProtocolGetResponse

Methods:

HTTPMethod

Types:

from cloudflare.types.radar.http.ases import HTTPMethodGetResponse

Methods:

IPVersion

Types:

from cloudflare.types.radar.http.ases import IPVersionGetResponse

Methods:

OS

Types:

from cloudflare.types.radar.http.ases import OSGetResponse

Methods:

TLSVersion

Types:

from cloudflare.types.radar.http.ases import TLSVersionGetResponse

Methods:

BrowserFamily

Types:

from cloudflare.types.radar.http.ases import BrowserFamilyGetResponse

Methods:

Summary

Types:

from cloudflare.types.radar.http import (
    SummaryBotClassResponse,
    SummaryDeviceTypeResponse,
    SummaryHTTPProtocolResponse,
    SummaryHTTPVersionResponse,
    SummaryIPVersionResponse,
    SummaryOSResponse,
    SummaryPostQuantumResponse,
    SummaryTLSVersionResponse,
)

Methods:

TimeseriesGroups

Types:

from cloudflare.types.radar.http import (
    TimeseriesGroupBotClassResponse,
    TimeseriesGroupBrowserResponse,
    TimeseriesGroupBrowserFamilyResponse,
    TimeseriesGroupDeviceTypeResponse,
    TimeseriesGroupHTTPProtocolResponse,
    TimeseriesGroupHTTPVersionResponse,
    TimeseriesGroupIPVersionResponse,
    TimeseriesGroupOSResponse,
    TimeseriesGroupPostQuantumResponse,
    TimeseriesGroupTLSVersionResponse,
)

Methods:

Quality

IQI

Types:

from cloudflare.types.radar.quality import IQISummaryResponse, IQITimeseriesGroupsResponse

Methods:

Speed

Types:

from cloudflare.types.radar.quality import SpeedHistogramResponse, SpeedSummaryResponse

Methods:

Top

Types:

from cloudflare.types.radar.quality.speed import TopAsesResponse, TopLocationsResponse

Methods:

Ranking

Types:

from cloudflare.types.radar import RankingTimeseriesGroupsResponse, RankingTopResponse

Methods:

Domain

Types:

from cloudflare.types.radar.ranking import DomainGetResponse

Methods:

TrafficAnomalies

Types:

from cloudflare.types.radar import TrafficAnomalyGetResponse

Methods:

Locations

Types:

from cloudflare.types.radar.traffic_anomalies import LocationGetResponse

Methods:

TCPResetsTimeouts

Types:

from cloudflare.types.radar import (
    TCPResetsTimeoutSummaryResponse,
    TCPResetsTimeoutTimeseriesGroupsResponse,
)

Methods:

BotManagement

Types:

from cloudflare.types.bot_management import (
    BotFightModeConfiguration,
    SubscriptionConfiguration,
    SuperBotFightModeDefinitelyConfiguration,
    SuperBotFightModeLikelyConfiguration,
    BotManagementUpdateResponse,
    BotManagementGetResponse,
)

Methods:

OriginPostQuantumEncryption

Types:

from cloudflare.types.origin_post_quantum_encryption import (
    OriginPostQuantumEncryptionUpdateResponse,
    OriginPostQuantumEncryptionGetResponse,
)

Methods:

Speed

Types:

from cloudflare.types.speed import LabeledRegion, LighthouseReport, Trend

Schedule

Types:

from cloudflare.types.speed import Schedule, ScheduleCreateResponse, ScheduleDeleteResponse

Methods:

Availabilities

Types:

from cloudflare.types.speed import Availability

Methods:

Pages

Types:

from cloudflare.types.speed import PageListResponse

Methods:

Tests

Types:

from cloudflare.types.speed.pages import Test, TestListResponse, TestDeleteResponse

Methods:

DCVDelegation

Types:

from cloudflare.types.dcv_delegation import DCVDelegationUUID

Methods:

Hostnames

Settings

TLS

Types:

from cloudflare.types.hostnames.settings import (
    Setting,
    SettingValue,
    TLSDeleteResponse,
    TLSGetResponse,
)

Methods:

  • client.hostnames.settings.tls.update(hostname, *, zone_id, setting_id, **params) -> Optional
  • client.hostnames.settings.tls.delete(hostname, *, zone_id, setting_id) -> Optional
  • client.hostnames.settings.tls.get(setting_id, *, zone_id) -> Optional

Snippets

Types:

from cloudflare.types.snippets import Snippet, SnippetDeleteResponse

Methods:

Content

Methods:

  • client.snippets.content.get(snippet_name, *, zone_id) -> BinaryAPIResponse

Rules

Types:

from cloudflare.types.snippets import RuleUpdateResponse, RuleListResponse

Methods:

Calls

Types:

from cloudflare.types.calls import CallsApp, CallsAppWithSecret, CallListResponse

Methods:

TURN

Keys

Types:

from cloudflare.types.calls.turn import (
    KeyCreateResponse,
    KeyUpdateResponse,
    KeyListResponse,
    KeyDeleteResponse,
    KeyGetResponse,
)

Methods:

CloudforceOne

Requests

Types:

from cloudflare.types.cloudforce_one import (
    Item,
    ListItem,
    Quota,
    RequestConstants,
    RequestTypes,
    RequestDeleteResponse,
)

Methods:

Message

Types:

from cloudflare.types.cloudforce_one.requests import (
    Message,
    MessageDeleteResponse,
    MessageGetResponse,
)

Methods:

  • client.cloudforce_one.requests.message.create(request_identifier, *, account_identifier, **params) -> Optional
  • client.cloudforce_one.requests.message.update(message_identifer, *, account_identifier, request_identifier, **params) -> Optional
  • client.cloudforce_one.requests.message.delete(message_identifer, *, account_identifier, request_identifier) -> MessageDeleteResponse
  • client.cloudforce_one.requests.message.get(request_identifier, *, account_identifier, **params) -> Optional

Priority

Types:

from cloudflare.types.cloudforce_one.requests import (
    Label,
    Priority,
    PriorityEdit,
    PriorityDeleteResponse,
)

Methods:

  • client.cloudforce_one.requests.priority.create(account_identifier, **params) -> Optional
  • client.cloudforce_one.requests.priority.update(priority_identifer, *, account_identifier, **params) -> Optional
  • client.cloudforce_one.requests.priority.delete(priority_identifer, *, account_identifier) -> PriorityDeleteResponse
  • client.cloudforce_one.requests.priority.get(priority_identifer, *, account_identifier) -> Optional
  • client.cloudforce_one.requests.priority.quota(account_identifier) -> Optional

EventNotifications

R2

Configuration

Types:

from cloudflare.types.event_notifications.r2 import ConfigurationGetResponse

Methods:

Queues

Types:

from cloudflare.types.event_notifications.r2.configuration import (
    QueueUpdateResponse,
    QueueDeleteResponse,
)

Methods:

AIGateway

Types:

from cloudflare.types.ai_gateway import (
    AIGatewayCreateResponse,
    AIGatewayUpdateResponse,
    AIGatewayListResponse,
    AIGatewayDeleteResponse,
    AIGatewayGetResponse,
)

Methods:

Logs

Types:

from cloudflare.types.ai_gateway import LogListResponse

Methods:

IAM

PermissionGroups

Types:

from cloudflare.types.iam import PermissionGroupListResponse, PermissionGroupGetResponse

Methods:

ResourceGroups

Types:

from cloudflare.types.iam import (
    ResourceGroupCreateResponse,
    ResourceGroupUpdateResponse,
    ResourceGroupListResponse,
    ResourceGroupDeleteResponse,
    ResourceGroupGetResponse,
)

Methods:

CloudConnector

Rules

Types:

from cloudflare.types.cloud_connector import RuleUpdateResponse, RuleListResponse

Methods: