See the API's various operations for details on their request parameters and response data:
Operation | Method | Endpoint |
---|---|---|
Web Security configurations | ||
Create a configuration | POST | /configs |
List configurations | GET | /configs |
Get a configuration | GET | /configs/{configId} |
Rename a security configuration | PUT | /configs/{configId} |
List failover hostnames | GET | /configs/{configId}/failover-hostnames |
List subscribers | GET | /configs/{configId}/notification/subscription/{feature} |
Subscribe or unsubscribe to recommendation emails | POST | /configs/{configId}/notification/subscription/{feature} |
Web Security configuration versions | ||
Clone a configuration version | POST | /configs/{configId}/versions |
List configuration versions | GET | /configs/{configId}/versions |
Get configuration version details | GET | /configs/{configId}/versions/{versionNumber} |
Remove a configuration version | DELETE | /configs/{configId}/versions/{versionNumber} |
Get the version notes | GET | /configs/{configId}/versions/{versionNumber}/version-notes |
Update the version notes | PUT | /configs/{configId}/versions/{versionNumber}/version-notes |
Web Security configuration version settings | ||
Get the bypass network lists settings | GET | /configs/{configId}/versions/{versionNumber}/bypass-network-lists |
Modify the bypass network lists settings | PUT | /configs/{configId}/versions/{versionNumber}/bypass-network-lists |
Get a custom deny action | GET | /configs/{configId}/versions/{versionNumber}/custom-deny/{customDenyId} |
Modify a custom deny action | PUT | /configs/{configId}/versions/{versionNumber}/custom-deny/{customDenyId} |
Remove a custom deny action | DELETE | /configs/{configId}/versions/{versionNumber}/custom-deny/{customDenyId} |
Create a custom deny action | POST | /configs/{configId}/versions/{versionNumber}/custom-deny |
List custom deny actions | GET | /configs/{configId}/versions/{versionNumber}/custom-deny |
Get the hostname coverage match targets | GET | /configs/{configId}/versions/{versionNumber}/hostname-coverage/match-targets |
List hostname overlaps | GET | /configs/{configId}/versions/{versionNumber}/hostname-coverage/overlapping |
Modify match target order | PUT | /configs/{configId}/versions/{versionNumber}/match-targets/sequence |
Get a match target | GET | /configs/{configId}/versions/{versionNumber}/match-targets/{targetId} |
Modify a match target | PUT | /configs/{configId}/versions/{versionNumber}/match-targets/{targetId} |
Remove a match target | DELETE | /configs/{configId}/versions/{versionNumber}/match-targets/{targetId} |
Create a match target | POST | /configs/{configId}/versions/{versionNumber}/match-targets |
List match targets | GET | /configs/{configId}/versions/{versionNumber}/match-targets |
Protect evaluation hostnames | PUT | /configs/{configId}/versions/{versionNumber}/protect-eval-hostnames |
Get a rate policy | GET | /configs/{configId}/versions/{versionNumber}/rate-policies/{ratePolicyId} |
Modify a rate policy | PUT | /configs/{configId}/versions/{versionNumber}/rate-policies/{ratePolicyId} |
Remove a rate policy | DELETE | /configs/{configId}/versions/{versionNumber}/rate-policies/{ratePolicyId} |
Create a rate policy | POST | /configs/{configId}/versions/{versionNumber}/rate-policies |
List rate policies | GET | /configs/{configId}/versions/{versionNumber}/rate-policies |
Get a reputation profile | GET | /configs/{configId}/versions/{versionNumber}/reputation-profiles/{reputationProfileId} |
Modify a reputation profile | PUT | /configs/{configId}/versions/{versionNumber}/reputation-profiles/{reputationProfileId} |
Remove a reputation profile | DELETE | /configs/{configId}/versions/{versionNumber}/reputation-profiles/{reputationProfileId} |
Create a reputation profile | POST | /configs/{configId}/versions/{versionNumber}/reputation-profiles |
List reputation profiles | GET | /configs/{configId}/versions/{versionNumber}/reputation-profiles |
List selectable hostnames | GET | /configs/{configId}/versions/{versionNumber}/selectable-hostnames |
List evaluation hostnames | GET | /configs/{configId}/versions/{versionNumber}/selected-hostnames/eval-hostnames |
Modify evaluation hostnames | PUT | /configs/{configId}/versions/{versionNumber}/selected-hostnames/eval-hostnames |
List selected hostnames | GET | /configs/{configId}/versions/{versionNumber}/selected-hostnames |
Modify selected hostnames | PUT | /configs/{configId}/versions/{versionNumber}/selected-hostnames |
Get SIEM settings | GET | /configs/{configId}/versions/{versionNumber}/siem |
Modify SIEM settings | PUT | /configs/{configId}/versions/{versionNumber}/siem |
Advanced configuration version settings | ||
Get the evasive path match settings for a configuration | GET | /configs/{configId}/versions/{versionNumber}/advanced-settings/evasive-path-match |
Modify evasive path match settings for a configuration | PUT | /configs/{configId}/versions/{versionNumber}/advanced-settings/evasive-path-match |
Get the HTTP header log settings for a configuration | GET | /configs/{configId}/versions/{versionNumber}/advanced-settings/logging |
Modify HTTP header log settings for a configuration | PUT | /configs/{configId}/versions/{versionNumber}/advanced-settings/logging |
Get Pragma settings for a configuration | GET | /configs/{configId}/versions/{versionNumber}/advanced-settings/pragma-header |
Modify Pragma settings for a configuration | PUT | /configs/{configId}/versions/{versionNumber}/advanced-settings/pragma-header |
Get prefetch requests | GET | /configs/{configId}/versions/{versionNumber}/advanced-settings/prefetch |
Modify prefetch requests | PUT | /configs/{configId}/versions/{versionNumber}/advanced-settings/prefetch |
Get Request body size settings for a configuration | GET | /configs/{configId}/versions/{versionNumber}/advanced-settings/request-body |
Modify request body inspection limit settings for a configuration | PUT | /configs/{configId}/versions/{versionNumber}/advanced-settings/request-body |
Custom rules for a configuration | ||
List custom rules for a configuration | GET | /configs/{configId}/custom-rules |
Create a custom rule for a configuration | POST | /configs/{configId}/custom-rules |
Remove a custom rule from a configuration | DELETE | /configs/{configId}/custom-rules/{ruleId} |
Get a custom rule for a configuration | GET | /configs/{configId}/custom-rules/{ruleId} |
Update a custom rule for a configuration | PUT | /configs/{configId}/custom-rules/{ruleId} |
Security policies | ||
Clone or create a security policy | POST | /configs/{configId}/versions/{versionNumber}/security-policies |
List security policies | GET | /configs/{configId}/versions/{versionNumber}/security-policies |
Get a security policy | GET | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId} |
Modify a security policy | PUT | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId} |
Remove a security policy | DELETE | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId} |
Security policy settings | ||
List API endpoints | GET | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/api-endpoints |
Modify an API request constraint's action | PUT | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/api-request-constraints/{apiId} |
List API request constraints and actions | GET | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/api-request-constraints |
Modify the request constraint action for all API | PUT | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/api-request-constraints |
Get the exceptions of an attack group | GET | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/attack-groups/{attackGroupId}/condition-exception |
Modify the exceptions of an attack group | PUT | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/attack-groups/{attackGroupId}/condition-exception |
Get the action for an attack group | GET | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/attack-groups/{attackGroupId} |
Modify the action for an attack group | PUT | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/attack-groups/{attackGroupId} |
List attack groups | GET | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/attack-groups |
Get the bypass network lists settings for a security policy | GET | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/bypass-network-lists |
Modify the bypass network lists settings for a security policy | PUT | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/bypass-network-lists |
Modify a custom rule action | PUT | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/custom-rules/{ruleId} |
List custom rule actions | GET | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/custom-rules |
List evaluation hostnames for a security policy | GET | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/eval-hostnames |
Modify evaluation hostnames for a security policy | PUT | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/eval-hostnames |
Get the conditions and exceptions for an evaluation rule | GET | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/eval-rules/{ruleId}/condition-exception |
Modify the conditions and exceptions for an evaluation rule | PUT | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/eval-rules/{ruleId}/condition-exception |
Get the action of an evaluation rule | GET | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/eval-rules/{ruleId} |
Modify the action of an evaluation rule | PUT | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/eval-rules/{ruleId} |
List evaluation rules | GET | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/eval-rules |
Set evaluation mode | POST | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/eval |
Get the IP/Geo Firewall settings | GET | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/ip-geo-firewall |
Update the IP Geo Firewall settings | PUT | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/ip-geo-firewall |
Get the current mode | GET | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/mode |
Modify the mode | PUT | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/mode |
Get the penalty box | GET | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/penalty-box |
Modify the penalty box | PUT | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/penalty-box |
Protect evaluation hostnames for a security policy | PUT | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/protect-eval-hostnames |
Get protections | GET | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/protections |
Modify protections | PUT | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/protections |
Modify a rate policy action | PUT | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/rate-policies/{ratePolicyId} |
List rate policy actions | GET | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/rate-policies |
List tuning recommendations for an attack group | GET | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/recommendations/attack-groups/{attackGroupId} |
List tuning recommendations for a rule | GET | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/recommendations/rules/{ruleId} |
Get tuning recommendations for a policy | GET | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/recommendations |
Respond to exception recommendations | POST | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/recommendations |
Get the reputation analysis settings | GET | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/reputation-analysis |
Update the reputation analysis settings | PUT | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/reputation-analysis |
Get the action for a reputation profile | GET | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/reputation-profiles/{reputationProfileId} |
Modify the action for a reputation profile | PUT | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/reputation-profiles/{reputationProfileId} |
List reputation profile actions | GET | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/reputation-profiles |
List selected hostnames for a security policy | GET | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/selected-hostnames |
Modify selected hostnames for a security policy | PUT | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/selected-hostnames |
Get slow POST protection settings | GET | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/slow-post |
Modify slow POST protection settings | PUT | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/slow-post |
Advanced security policy settings | ||
Get evasive path match settings | GET | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/advanced-settings/evasive-path-match |
Modify evasive path match setting | PUT | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/advanced-settings/evasive-path-match |
Get HTTP header log settings | GET | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/advanced-settings/logging |
Modify HTTP header log settings | PUT | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/advanced-settings/logging |
Get Pragma settings for a security policy | GET | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/advanced-settings/pragma-header |
Modify Pragma settings for a security policy | PUT | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/advanced-settings/pragma-header |
Get request body inspection limit settings for a security policy | GET | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/advanced-settings/request-body |
Modify request body size settings for a security policy | PUT | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/advanced-settings/request-body |
Rules | ||
List rules | GET | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/rules |
Upgrade KRS ruleset | PUT | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/rules |
Get the action for a rule | GET | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/rules/{ruleId} |
Modify the action for a rule | PUT | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/rules/{ruleId} |
Get the conditions and exceptions of a rule | GET | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/rules/{ruleId}/condition-exception |
Modify the conditions and exceptions of a rule | PUT | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/rules/{ruleId}/condition-exception |
Get adaptive intelligence setting | GET | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/rules/threat-intel |
Update adaptive intelligence setting | PUT | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/rules/threat-intel |
Get upgrade details | GET | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/rules/upgrade-details |
Export | ||
Export a configuration version | GET | /export/configs/{configId}/versions/{versionNumber} |
Activations | ||
Activate a configuration version | POST | /activations |
Get activation status | GET | /activations/{activationId} |
Get an activation request status | GET | /activations/status/{statusId} |
Contracts and groups | ||
List contracts and groups | GET | /contracts-groups |
Hostnames | ||
List available hostnames for a new configuration | GET | /contracts/{contractId}/groups/{groupId}/selectable-hostnames |
Get Hostname Coverage | GET | /hostname-coverage |
SIEM | ||
Get SIEM versions | GET | /siem-definitions |