Firewall
FirewallLockdowns
List Zone Lockdown rules
Get a Zone Lockdown rule
Create a Zone Lockdown rule
Update a Zone Lockdown rule
Delete a Zone Lockdown rule
ModelsExpand Collapse
Configuration = array of LockdownIPConfiguration { target, value } or LockdownCIDRConfiguration { target, value } A list of IP addresses or CIDR ranges that will be allowed to access the URLs specified in the Zone Lockdown rule. You can include any number of ip or ip_range configurations.
A list of IP addresses or CIDR ranges that will be allowed to access the URLs specified in the Zone Lockdown rule. You can include any number of ip or ip_range configurations.
Lockdown = object { id, configurations, created_on, 4 more }
A list of IP addresses or CIDR ranges that will be allowed to access the URLs specified in the Zone Lockdown rule. You can include any number of ip or ip_range configurations.
FirewallRules
ModelsExpand Collapse
FirewallRule = object { id, action, description, 5 more }
filter: optional FirewallFilter { id, description, expression, 2 more } or DeletedFilter { id, deleted }
FirewallFilter = object { id, description, expression, 2 more }
The filter expression. For more information, refer to Expressions.
The priority of the rule. Optional value used to define the processing order. A lower number indicates a higher priority. If not provided, rules with a defined priority will be processed before rules without a priority.
FirewallAccess Rules
List IP Access rules
Get an IP Access rule
Create an IP Access rule
Update an IP Access rule
Delete an IP Access rule
ModelsExpand Collapse
CountryConfiguration = object { target, value }
The configuration target. You must set the target to country when specifying a country code in the rule.
The two-letter ISO-3166-1 alpha-2 code to match. For more information, refer to IP Access rules: Parameters.
AccessRuleListResponse = object { id, allowed_modes, configuration, 5 more }
allowed_modes: array of "block" or "challenge" or "whitelist" or 2 moreThe available actions that a rule can apply to a matched request.
The available actions that a rule can apply to a matched request.
configuration: AccessRuleIPConfiguration { target, value } or IPV6Configuration { target, value } or AccessRuleCIDRConfiguration { target, value } or 2 moreThe rule configuration.
The rule configuration.
AccessRuleCIDRConfiguration = object { target, value }
CountryConfiguration = object { target, value }
The configuration target. You must set the target to country when specifying a country code in the rule.
The two-letter ISO-3166-1 alpha-2 code to match. For more information, refer to IP Access rules: Parameters.
An informative summary of the rule, typically used as a reminder or explanation.
AccessRuleGetResponse = object { id, allowed_modes, configuration, 5 more }
allowed_modes: array of "block" or "challenge" or "whitelist" or 2 moreThe available actions that a rule can apply to a matched request.
The available actions that a rule can apply to a matched request.
configuration: AccessRuleIPConfiguration { target, value } or IPV6Configuration { target, value } or AccessRuleCIDRConfiguration { target, value } or 2 moreThe rule configuration.
The rule configuration.
AccessRuleCIDRConfiguration = object { target, value }
CountryConfiguration = object { target, value }
The configuration target. You must set the target to country when specifying a country code in the rule.
The two-letter ISO-3166-1 alpha-2 code to match. For more information, refer to IP Access rules: Parameters.
An informative summary of the rule, typically used as a reminder or explanation.
AccessRuleCreateResponse = object { id, allowed_modes, configuration, 5 more }
allowed_modes: array of "block" or "challenge" or "whitelist" or 2 moreThe available actions that a rule can apply to a matched request.
The available actions that a rule can apply to a matched request.
configuration: AccessRuleIPConfiguration { target, value } or IPV6Configuration { target, value } or AccessRuleCIDRConfiguration { target, value } or 2 moreThe rule configuration.
The rule configuration.
AccessRuleCIDRConfiguration = object { target, value }
CountryConfiguration = object { target, value }
The configuration target. You must set the target to country when specifying a country code in the rule.
The two-letter ISO-3166-1 alpha-2 code to match. For more information, refer to IP Access rules: Parameters.
An informative summary of the rule, typically used as a reminder or explanation.
AccessRuleEditResponse = object { id, allowed_modes, configuration, 5 more }
allowed_modes: array of "block" or "challenge" or "whitelist" or 2 moreThe available actions that a rule can apply to a matched request.
The available actions that a rule can apply to a matched request.
configuration: AccessRuleIPConfiguration { target, value } or IPV6Configuration { target, value } or AccessRuleCIDRConfiguration { target, value } or 2 moreThe rule configuration.
The rule configuration.
AccessRuleCIDRConfiguration = object { target, value }
CountryConfiguration = object { target, value }
The configuration target. You must set the target to country when specifying a country code in the rule.
The two-letter ISO-3166-1 alpha-2 code to match. For more information, refer to IP Access rules: Parameters.
An informative summary of the rule, typically used as a reminder or explanation.
FirewallUA Rules
List User Agent Blocking rules
Get a User Agent Blocking rule
Create a User Agent Blocking rule
Update a User Agent Blocking rule
Delete a User Agent Blocking rule
ModelsExpand Collapse
UARuleCreateResponse = object { id, configuration, description, 2 more }
UARuleUpdateResponse = object { id, configuration, description, 2 more }
UARuleDeleteResponse = object { id, configuration, description, 2 more }
FirewallWAF
FirewallWAFOverrides
ModelsExpand Collapse
Override = object { id, description, groups, 5 more }
An informative summary of the current URI-based WAF override.
An object that allows you to enable or disable WAF rule groups for the current WAF override. Each key of this object must be the ID of a WAF rule group, and each value must be a valid WAF action (usually default or disable). When creating a new URI-based WAF override, you must provide a groups object or a rules object.
The relative priority of the current URI-based WAF override when multiple overrides match a single URL. A lower number indicates higher priority. Higher priority overrides may overwrite values set by lower priority overrides.
Specifies that, when a WAF rule matches, its configured action will be replaced by the action configured in this object.
An object that allows you to override the action of specific WAF rules. Each key of this object must be the ID of a WAF rule, and each value must be a valid WAF action. Unless you are disabling a rule, ensure that you also enable the rule group that this WAF rule belongs to. When creating a new URI-based WAF override, you must provide a groups object or a rules object.
RewriteAction = object { block, challenge, default, 2 more } Specifies that, when a WAF rule matches, its configured action will be replaced by the action configured in this object.
Specifies that, when a WAF rule matches, its configured action will be replaced by the action configured in this object.
WAFRule = map["challenge" or "block" or "simulate" or 2 more]An object that allows you to override the action of specific WAF rules. Each key of this object must be the ID of a WAF rule, and each value must be a valid WAF action. Unless you are disabling a rule, ensure that you also enable the rule group that this WAF rule belongs to. When creating a new URI-based WAF override, you must provide a groups object or a rules object.
An object that allows you to override the action of specific WAF rules. Each key of this object must be the ID of a WAF rule, and each value must be a valid WAF action. Unless you are disabling a rule, ensure that you also enable the rule group that this WAF rule belongs to. When creating a new URI-based WAF override, you must provide a groups object or a rules object.
FirewallWAFPackagesGroups
Get a WAF rule group
Update a WAF rule group
ModelsExpand Collapse
Group = object { id, description, mode, 5 more }
mode: "on" or "off"Defines the state of the rules contained in the rule group. When on, the rules in the group are configurable/usable.
Defines the state of the rules contained in the rule group. When on, the rules in the group are configurable/usable.
FirewallWAFPackagesRules
ModelsExpand Collapse
RuleListResponse = object { id, allowed_modes, description, 4 more } or object { id, allowed_modes, default_mode, 5 more } or object { id, allowed_modes, description, 4 more } When triggered, anomaly detection WAF rules contribute to an overall threat score that will determine if a request is considered malicious. You can configure the total scoring threshold through the 'sensitivity' property of the WAF package.
When triggered, anomaly detection WAF rules contribute to an overall threat score that will determine if a request is considered malicious. You can configure the total scoring threshold through the 'sensitivity' property of the WAF package.
WAFManagedRulesAnomalyRule = object { id, allowed_modes, description, 4 more } When triggered, anomaly detection WAF rules contribute to an overall threat score that will determine if a request is considered malicious. You can configure the total scoring threshold through the 'sensitivity' property of the WAF package.
When triggered, anomaly detection WAF rules contribute to an overall threat score that will determine if a request is considered malicious. You can configure the total scoring threshold through the 'sensitivity' property of the WAF package.
WAFManagedRulesTraditionalDenyRule = object { id, allowed_modes, default_mode, 5 more } When triggered, traditional WAF rules cause the firewall to immediately act upon the request based on the configuration of the rule. A 'deny' rule will immediately respond to the request based on the configured rule action/mode (for example, 'block') and no other rules will be processed.
When triggered, traditional WAF rules cause the firewall to immediately act upon the request based on the configuration of the rule. A 'deny' rule will immediately respond to the request based on the configured rule action/mode (for example, 'block') and no other rules will be processed.
allowed_modes: array of "default" or "disable" or "simulate" or 2 moreDefines the list of possible actions of the WAF rule when it is triggered.
Defines the list of possible actions of the WAF rule when it is triggered.
default_mode: "disable" or "simulate" or "block" or "challenge"Defines the default action/mode of a rule.
Defines the default action/mode of a rule.
WAFManagedRulesTraditionalAllowRule = object { id, allowed_modes, description, 4 more } When triggered, traditional WAF rules cause the firewall to immediately act on the request based on the rule configuration. An 'allow' rule will immediately allow the request and no other rules will be processed.
When triggered, traditional WAF rules cause the firewall to immediately act on the request based on the rule configuration. An 'allow' rule will immediately allow the request and no other rules will be processed.
RuleEditResponse = object { id, allowed_modes, description, 4 more } or object { id, allowed_modes, default_mode, 5 more } or object { id, allowed_modes, description, 4 more } When triggered, anomaly detection WAF rules contribute to an overall threat score that will determine if a request is considered malicious. You can configure the total scoring threshold through the 'sensitivity' property of the WAF package.
When triggered, anomaly detection WAF rules contribute to an overall threat score that will determine if a request is considered malicious. You can configure the total scoring threshold through the 'sensitivity' property of the WAF package.
WAFManagedRulesAnomalyRule = object { id, allowed_modes, description, 4 more } When triggered, anomaly detection WAF rules contribute to an overall threat score that will determine if a request is considered malicious. You can configure the total scoring threshold through the 'sensitivity' property of the WAF package.
When triggered, anomaly detection WAF rules contribute to an overall threat score that will determine if a request is considered malicious. You can configure the total scoring threshold through the 'sensitivity' property of the WAF package.
WAFManagedRulesTraditionalDenyRule = object { id, allowed_modes, default_mode, 5 more } When triggered, traditional WAF rules cause the firewall to immediately act upon the request based on the configuration of the rule. A 'deny' rule will immediately respond to the request based on the configured rule action/mode (for example, 'block') and no other rules will be processed.
When triggered, traditional WAF rules cause the firewall to immediately act upon the request based on the configuration of the rule. A 'deny' rule will immediately respond to the request based on the configured rule action/mode (for example, 'block') and no other rules will be processed.
allowed_modes: array of "default" or "disable" or "simulate" or 2 moreDefines the list of possible actions of the WAF rule when it is triggered.
Defines the list of possible actions of the WAF rule when it is triggered.
default_mode: "disable" or "simulate" or "block" or "challenge"Defines the default action/mode of a rule.
Defines the default action/mode of a rule.
WAFManagedRulesTraditionalAllowRule = object { id, allowed_modes, description, 4 more } When triggered, traditional WAF rules cause the firewall to immediately act on the request based on the rule configuration. An 'allow' rule will immediately allow the request and no other rules will be processed.
When triggered, traditional WAF rules cause the firewall to immediately act on the request based on the rule configuration. An 'allow' rule will immediately allow the request and no other rules will be processed.