api.md

Rulesets

Types:

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

Methods:

• client.rulesets.create(*, account_id, zone_id, **params) -> RulesetCreateResponse
• client.rulesets.update(ruleset_id, *, account_id, zone_id, **params) -> RulesetUpdateResponse
• client.rulesets.list(*, account_id, zone_id, **params) -> SyncCursorPagination[RulesetListResponse]
• client.rulesets.delete(ruleset_id, *, account_id, zone_id) -> None
• client.rulesets.get(ruleset_id, *, account_id, zone_id) -> RulesetGetResponse

Phases

Types:

from cloudflare.types.rulesets import PhaseUpdateResponse, PhaseGetResponse

Methods:

• client.rulesets.phases.update(ruleset_phase, *, account_id, zone_id, **params) -> PhaseUpdateResponse
• client.rulesets.phases.get(ruleset_phase, *, account_id, zone_id) -> PhaseGetResponse

Versions

Types:

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

Methods:

• client.rulesets.phases.versions.list(ruleset_phase, *, account_id, zone_id) -> SyncSinglePage[VersionListResponse]
• client.rulesets.phases.versions.get(ruleset_version, *, ruleset_phase, account_id, zone_id) -> VersionGetResponse

Rules

Types:

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

Methods:

• client.rulesets.rules.create(ruleset_id, *, account_id, zone_id, **params) -> RuleCreateResponse
• client.rulesets.rules.delete(rule_id, *, ruleset_id, account_id, zone_id) -> RuleDeleteResponse
• client.rulesets.rules.edit(rule_id, *, ruleset_id, account_id, zone_id, **params) -> RuleEditResponse

Versions

Types:

from cloudflare.types.rulesets import VersionListResponse, VersionGetResponse

Methods:

• client.rulesets.versions.list(ruleset_id, *, account_id, zone_id) -> SyncSinglePage[VersionListResponse]
• client.rulesets.versions.delete(ruleset_version, *, ruleset_id, account_id, zone_id) -> None
• client.rulesets.versions.get(ruleset_version, *, ruleset_id, account_id, zone_id) -> VersionGetResponse