LogoCloudflare API

Rulesets

Rulesets

Methods

list(, ):
CursorPagination
<
RulesetListResponse
>
get/{accounts_or_zones}/{account_or_zone_id}/rulesets

Fetches all rulesets.

get(, , ):
RulesetGetResponse
get/{accounts_or_zones}/{account_or_zone_id}/rulesets/{ruleset_id}

Fetches the latest version of an account or zone ruleset.

create(, ):
RulesetCreateResponse
post/{accounts_or_zones}/{account_or_zone_id}/rulesets

Creates a ruleset.

update(, , ):
RulesetUpdateResponse
put/{accounts_or_zones}/{account_or_zone_id}/rulesets/{ruleset_id}

Updates an account or zone ruleset, creating a new version.

delete(, , ): void
delete/{accounts_or_zones}/{account_or_zone_id}/rulesets/{ruleset_id}

Deletes all versions of an existing account or zone ruleset.

Domain types

Kind = "managed" | "custom" | "root" | 1 more...

The kind of the ruleset.

Phase = "ddos_l4" | "ddos_l7" | "http_config_settings" | 20 more...

The phase of the ruleset.

Ruleset{…}

A ruleset object.

Rulesets

Phases

Rulesets.Phases

Methods

get(, , ):
PhaseGetResponse
get/{accounts_or_zones}/{account_or_zone_id}/rulesets/phases/{ruleset_phase}/entrypoint

Fetches the latest version of the account or zone entry point ruleset for a given phase.

update(, , ):
PhaseUpdateResponse
put/{accounts_or_zones}/{account_or_zone_id}/rulesets/phases/{ruleset_phase}/entrypoint

Updates an account or zone entry point ruleset, creating a new version.

RulesetsPhases

Versions

Rulesets.Phases.Versions

Methods

list(, , ):
SinglePage
<
VersionListResponse
>
get/{accounts_or_zones}/{account_or_zone_id}/rulesets/phases/{ruleset_phase}/entrypoint/versions

Fetches the versions of an account or zone entry point ruleset.

get(, , , ):
VersionGetResponse
get/{accounts_or_zones}/{account_or_zone_id}/rulesets/phases/{ruleset_phase}/entrypoint/versions/{ruleset_version}

Fetches a specific version of an account or zone entry point ruleset.

Rulesets

Rules

Rulesets.Rules

Methods

create(, , ):
RuleCreateResponse
post/{accounts_or_zones}/{account_or_zone_id}/rulesets/{ruleset_id}/rules

Adds a new rule to an account or zone ruleset. The rule will be added to the end of the existing list of rules in the ruleset by default.

edit(, , , ):
RuleEditResponse
patch/{accounts_or_zones}/{account_or_zone_id}/rulesets/{ruleset_id}/rules/{rule_id}

Updates an existing rule in an account or zone ruleset.

delete(, , , ):
RuleDeleteResponse
delete/{accounts_or_zones}/{account_or_zone_id}/rulesets/{ruleset_id}/rules/{rule_id}

Deletes an existing rule from an account or zone ruleset.

Domain types

BlockRule{…}
CompressResponseRule{…}
DDoSDynamicRule{…}
ExecuteRule{…}
ForceConnectionCloseRule{…}
LogCustomFieldRule{…}
LogRule{…}
Logging{…}

An object configuring the rule's logging behavior.

ManagedChallengeRule{…}
RedirectRule{…}
RewriteRule{…}
RouteRule{…}
RulesetRule{…}
ScoreRule{…}
ServeErrorRule{…}
SetCacheSettingsRule{…}
SetConfigRule{…}
SkipRule{…}
Rulesets

Versions

Rulesets.Versions

Methods

list(, , ):
SinglePage
<
VersionListResponse
>
get/{accounts_or_zones}/{account_or_zone_id}/rulesets/{ruleset_id}/versions

Fetches the versions of an account or zone ruleset.

get(, , , ):
VersionGetResponse
get/{accounts_or_zones}/{account_or_zone_id}/rulesets/{ruleset_id}/versions/{ruleset_version}

Fetches a specific version of an account or zone ruleset.

delete(, , , ): void
delete/{accounts_or_zones}/{account_or_zone_id}/rulesets/{ruleset_id}/versions/{ruleset_version}

Deletes an existing version of an account or zone ruleset.