api.md

Firewall

Lockdowns

Types:

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

Methods:

• client.firewall.lockdowns.create(*, zone_id, **params) -> Lockdown
• client.firewall.lockdowns.update(lock_downs_id, *, zone_id, **params) -> Lockdown
• client.firewall.lockdowns.list(*, zone_id, **params) -> SyncV4PagePaginationArray[Lockdown]
• client.firewall.lockdowns.delete(lock_downs_id, *, zone_id) -> Optional[LockdownDeleteResponse]
• client.firewall.lockdowns.get(lock_downs_id, *, zone_id) -> Lockdown

Rules

Types:

from cloudflare.types.firewall import DeletedFilter, FirewallRule, Product

Methods:

• client.firewall.rules.create(*, zone_id, **params) -> SyncSinglePage[FirewallRule]
• client.firewall.rules.update(rule_id, *, zone_id, **params) -> FirewallRule
• client.firewall.rules.list(*, zone_id, **params) -> SyncV4PagePaginationArray[FirewallRule]
• client.firewall.rules.delete(rule_id, *, zone_id) -> FirewallRule
• client.firewall.rules.bulk_delete(*, zone_id) -> SyncSinglePage[FirewallRule]
• client.firewall.rules.bulk_edit(*, zone_id, **params) -> SyncSinglePage[FirewallRule]
• client.firewall.rules.bulk_update(*, zone_id, **params) -> SyncSinglePage[FirewallRule]
• client.firewall.rules.edit(rule_id, *, zone_id) -> SyncSinglePage[FirewallRule]
• client.firewall.rules.get(rule_id, *, zone_id) -> FirewallRule

AccessRules

Types:

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

Methods:

• client.firewall.access_rules.create(*, account_id, zone_id, **params) -> AccessRuleCreateResponse
• client.firewall.access_rules.list(*, account_id, zone_id, **params) -> SyncV4PagePaginationArray[AccessRuleListResponse]
• client.firewall.access_rules.delete(rule_id, *, account_id, zone_id) -> Optional[AccessRuleDeleteResponse]
• client.firewall.access_rules.edit(rule_id, *, account_id, zone_id, **params) -> AccessRuleEditResponse
• client.firewall.access_rules.get(rule_id, *, account_id, zone_id) -> AccessRuleGetResponse

UARules

Types:

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

Methods:

• client.firewall.ua_rules.create(*, zone_id, **params) -> UARuleCreateResponse
• client.firewall.ua_rules.update(ua_rule_id, *, zone_id, **params) -> UARuleUpdateResponse
• client.firewall.ua_rules.list(*, zone_id, **params) -> SyncV4PagePaginationArray[UARuleListResponse]
• client.firewall.ua_rules.delete(ua_rule_id, *, zone_id) -> UARuleDeleteResponse
• client.firewall.ua_rules.get(ua_rule_id, *, zone_id) -> UARuleGetResponse

WAF

Overrides

Types:

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

Methods:

• client.firewall.waf.overrides.create(*, zone_id, **params) -> Override
• client.firewall.waf.overrides.update(overrides_id, *, zone_id, **params) -> Override
• client.firewall.waf.overrides.list(*, zone_id, **params) -> SyncV4PagePaginationArray[Override]
• client.firewall.waf.overrides.delete(overrides_id, *, zone_id) -> Optional[OverrideDeleteResponse]
• client.firewall.waf.overrides.get(overrides_id, *, zone_id) -> Override

Packages

Types:

from cloudflare.types.firewall.waf import PackageGetResponse

Methods:

• client.firewall.waf.packages.list(*, zone_id, **params) -> SyncV4PagePaginationArray[object]
• client.firewall.waf.packages.get(package_id, *, zone_id) -> PackageGetResponse

Groups

Types:

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

Methods:

• client.firewall.waf.packages.groups.list(package_id, *, zone_id, **params) -> SyncV4PagePaginationArray[Group]
• client.firewall.waf.packages.groups.edit(group_id, *, zone_id, package_id, **params) -> GroupEditResponse
• client.firewall.waf.packages.groups.get(group_id, *, zone_id, package_id) -> GroupGetResponse

Rules

Types:

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

Methods:

• client.firewall.waf.packages.rules.list(package_id, *, zone_id, **params) -> SyncV4PagePaginationArray[RuleListResponse]
• client.firewall.waf.packages.rules.edit(rule_id, *, zone_id, package_id, **params) -> RuleEditResponse
• client.firewall.waf.packages.rules.get(rule_id, *, zone_id, package_id) -> RuleGetResponse