api.md

Rulesets

Types:

• Kind
• Phase
• Ruleset
• RulesetCreateResponse
• RulesetUpdateResponse
• RulesetListResponse
• RulesetGetResponse

Methods:

• client.rulesets.create({ ...params }) -> RulesetCreateResponse
• client.rulesets.update(rulesetId, { ...params }) -> RulesetUpdateResponse
• client.rulesets.list({ ...params }) -> RulesetListResponsesCursorPagination
• client.rulesets.delete(rulesetId, { ...params }) -> void
• client.rulesets.get(rulesetId, { ...params }) -> RulesetGetResponse

Phases

Types:

• PhaseUpdateResponse
• PhaseGetResponse

Methods:

• client.rulesets.phases.update(rulesetPhase, { ...params }) -> PhaseUpdateResponse
• client.rulesets.phases.get(rulesetPhase, { ...params }) -> PhaseGetResponse

Versions

Types:

• VersionListResponse
• VersionGetResponse

Methods:

• client.rulesets.phases.versions.list(rulesetPhase, { ...params }) -> VersionListResponsesSinglePage
• client.rulesets.phases.versions.get(rulesetPhase, rulesetVersion, { ...params }) -> VersionGetResponse

Rules

Types:

• 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(rulesetId, { ...params }) -> RuleCreateResponse
• client.rulesets.rules.delete(rulesetId, ruleId, { ...params }) -> RuleDeleteResponse
• client.rulesets.rules.edit(rulesetId, ruleId, { ...params }) -> RuleEditResponse

Versions

Types:

• VersionListResponse
• VersionGetResponse

Methods:

• client.rulesets.versions.list(rulesetId, { ...params }) -> VersionListResponsesSinglePage
• client.rulesets.versions.delete(rulesetId, rulesetVersion, { ...params }) -> void
• client.rulesets.versions.get(rulesetId, rulesetVersion, { ...params }) -> VersionGetResponse