api.md

Firewall

Lockdowns

Types:

• Configuration
• Lockdown
• LockdownCIDRConfiguration
• LockdownIPConfiguration
• LockdownURL
• LockdownDeleteResponse

Methods:

• client.firewall.lockdowns.create({ ...params }) -> Lockdown
• client.firewall.lockdowns.update(lockDownsId, { ...params }) -> Lockdown
• client.firewall.lockdowns.list({ ...params }) -> LockdownsV4PagePaginationArray
• client.firewall.lockdowns.delete(lockDownsId, { ...params }) -> LockdownDeleteResponse
• client.firewall.lockdowns.get(lockDownsId, { ...params }) -> Lockdown

Rules

Types:

• DeletedFilter
• FirewallRule
• Product

Methods:

• client.firewall.rules.create({ ...params }) -> FirewallRulesSinglePage
• client.firewall.rules.update(ruleId, { ...params }) -> FirewallRule
• client.firewall.rules.list({ ...params }) -> FirewallRulesV4PagePaginationArray
• client.firewall.rules.delete(ruleId, { ...params }) -> FirewallRule
• client.firewall.rules.bulkDelete({ ...params }) -> FirewallRulesSinglePage
• client.firewall.rules.bulkEdit({ ...params }) -> FirewallRulesSinglePage
• client.firewall.rules.bulkUpdate({ ...params }) -> FirewallRulesSinglePage
• client.firewall.rules.edit(ruleId, { ...params }) -> FirewallRulesSinglePage
• client.firewall.rules.get(ruleId, { ...params }) -> FirewallRule

AccessRules

Types:

• AccessRuleCIDRConfiguration
• AccessRuleIPConfiguration
• ASNConfiguration
• CountryConfiguration
• IPV6Configuration
• AccessRuleCreateResponse
• AccessRuleListResponse
• AccessRuleDeleteResponse
• AccessRuleEditResponse
• AccessRuleGetResponse

Methods:

• client.firewall.accessRules.create({ ...params }) -> AccessRuleCreateResponse
• client.firewall.accessRules.list({ ...params }) -> AccessRuleListResponsesV4PagePaginationArray
• client.firewall.accessRules.delete(ruleId, { ...params }) -> AccessRuleDeleteResponse | null
• client.firewall.accessRules.edit(ruleId, { ...params }) -> AccessRuleEditResponse
• client.firewall.accessRules.get(ruleId, { ...params }) -> AccessRuleGetResponse

UARules

Types:

• UARuleCreateResponse
• UARuleUpdateResponse
• UARuleListResponse
• UARuleDeleteResponse
• UARuleGetResponse

Methods:

• client.firewall.uaRules.create({ ...params }) -> UARuleCreateResponse
• client.firewall.uaRules.update(uaRuleId, { ...params }) -> UARuleUpdateResponse
• client.firewall.uaRules.list({ ...params }) -> UARuleListResponsesV4PagePaginationArray
• client.firewall.uaRules.delete(uaRuleId, { ...params }) -> UARuleDeleteResponse
• client.firewall.uaRules.get(uaRuleId, { ...params }) -> UARuleGetResponse

WAF

Overrides

Types:

• Override
• OverrideURL
• RewriteAction
• WAFRule
• OverrideDeleteResponse

Methods:

• client.firewall.waf.overrides.create({ ...params }) -> Override
• client.firewall.waf.overrides.update(overridesId, { ...params }) -> Override
• client.firewall.waf.overrides.list({ ...params }) -> OverridesV4PagePaginationArray
• client.firewall.waf.overrides.delete(overridesId, { ...params }) -> OverrideDeleteResponse
• client.firewall.waf.overrides.get(overridesId, { ...params }) -> Override

Packages

Types:

• PackageListResponse
• PackageGetResponse

Methods:

• client.firewall.waf.packages.list({ ...params }) -> PackageListResponsesV4PagePaginationArray
• client.firewall.waf.packages.get(packageId, { ...params }) -> PackageGetResponse

Groups

Types:

• Group
• GroupEditResponse
• GroupGetResponse

Methods:

• client.firewall.waf.packages.groups.list(packageId, { ...params }) -> GroupsV4PagePaginationArray
• client.firewall.waf.packages.groups.edit(packageId, groupId, { ...params }) -> GroupEditResponse
• client.firewall.waf.packages.groups.get(packageId, groupId, { ...params }) -> GroupGetResponse

Rules

Types:

• AllowedModesAnomaly
• WAFRuleGroup
• RuleListResponse
• RuleEditResponse
• RuleGetResponse

Methods:

• client.firewall.waf.packages.rules.list(packageId, { ...params }) -> RuleListResponsesV4PagePaginationArray
• client.firewall.waf.packages.rules.edit(packageId, ruleId, { ...params }) -> RuleEditResponse
• client.firewall.waf.packages.rules.get(packageId, ruleId, { ...params }) -> RuleGetResponse