API summary

See the API's various operations for details on their request parameters and response data:

OperationMethodEndpoint
Web Security configurations
Create a configurationPOST/configs
List configurationsGET/configs
Get a configurationGET/configs/​{configId}
Rename a security configurationPUT/configs/​{configId}
List failover hostnamesGET/configs/​{configId}/​failover-hostnames
List subscribersGET/configs/​{configId}/​notification/​subscription/​{feature}
Subscribe or unsubscribe to recommendation emailsPOST/configs/​{configId}/​notification/​subscription/​{feature}
Web Security configuration versions
Clone a configuration versionPOST/configs/​{configId}/​versions
List configuration versionsGET/configs/​{configId}/​versions
Get configuration version detailsGET/configs/​{configId}/​versions/​{versionNumber}
Remove a configuration versionDELETE/configs/​{configId}/​versions/​{versionNumber}
Get the version notesGET/configs/​{configId}/​versions/​{versionNumber}/​version-notes
Update the version notesPUT/configs/​{configId}/​versions/​{versionNumber}/​version-notes
Web Security configuration version settings
Get the bypass network lists settingsGET/configs/​{configId}/​versions/​{versionNumber}/​bypass-network-lists
Modify the bypass network lists settingsPUT/configs/​{configId}/​versions/​{versionNumber}/​bypass-network-lists
Get a custom deny actionGET/configs/​{configId}/​versions/​{versionNumber}/​custom-deny/​{customDenyId}
Modify a custom deny actionPUT/configs/​{configId}/​versions/​{versionNumber}/​custom-deny/​{customDenyId}
Remove a custom deny actionDELETE/configs/​{configId}/​versions/​{versionNumber}/​custom-deny/​{customDenyId}
Create a custom deny actionPOST/configs/​{configId}/​versions/​{versionNumber}/​custom-deny
List custom deny actionsGET/configs/​{configId}/​versions/​{versionNumber}/​custom-deny
Get the hostname coverage match targetsGET/configs/​{configId}/​versions/​{versionNumber}/​hostname-coverage/​match-targets
List hostname overlapsGET/configs/​{configId}/​versions/​{versionNumber}/​hostname-coverage/​overlapping
Modify match target orderPUT/configs/​{configId}/​versions/​{versionNumber}/​match-targets/​sequence
Get a match targetGET/configs/​{configId}/​versions/​{versionNumber}/​match-targets/​{targetId}
Modify a match targetPUT/configs/​{configId}/​versions/​{versionNumber}/​match-targets/​{targetId}
Remove a match targetDELETE/configs/​{configId}/​versions/​{versionNumber}/​match-targets/​{targetId}
Create a match targetPOST/configs/​{configId}/​versions/​{versionNumber}/​match-targets
List match targetsGET/configs/​{configId}/​versions/​{versionNumber}/​match-targets
Protect evaluation hostnamesPUT/configs/​{configId}/​versions/​{versionNumber}/​protect-eval-hostnames
Get a rate policyGET/configs/​{configId}/​versions/​{versionNumber}/​rate-policies/​{ratePolicyId}
Modify a rate policyPUT/configs/​{configId}/​versions/​{versionNumber}/​rate-policies/​{ratePolicyId}
Remove a rate policyDELETE/configs/​{configId}/​versions/​{versionNumber}/​rate-policies/​{ratePolicyId}
Create a rate policyPOST/configs/​{configId}/​versions/​{versionNumber}/​rate-policies
List rate policiesGET/configs/​{configId}/​versions/​{versionNumber}/​rate-policies
Get a reputation profileGET/configs/​{configId}/​versions/​{versionNumber}/​reputation-profiles/​{reputationProfileId}
Modify a reputation profilePUT/configs/​{configId}/​versions/​{versionNumber}/​reputation-profiles/​{reputationProfileId}
Remove a reputation profileDELETE/configs/​{configId}/​versions/​{versionNumber}/​reputation-profiles/​{reputationProfileId}
Create a reputation profilePOST/configs/​{configId}/​versions/​{versionNumber}/​reputation-profiles
List reputation profilesGET/configs/​{configId}/​versions/​{versionNumber}/​reputation-profiles
List selectable hostnamesGET/configs/​{configId}/​versions/​{versionNumber}/​selectable-hostnames
List evaluation hostnamesGET/configs/​{configId}/​versions/​{versionNumber}/​selected-hostnames/​eval-hostnames
Modify evaluation hostnamesPUT/configs/​{configId}/​versions/​{versionNumber}/​selected-hostnames/​eval-hostnames
List selected hostnamesGET/configs/​{configId}/​versions/​{versionNumber}/​selected-hostnames
Modify selected hostnamesPUT/configs/​{configId}/​versions/​{versionNumber}/​selected-hostnames
Get SIEM settingsGET/configs/​{configId}/​versions/​{versionNumber}/​siem
Modify SIEM settingsPUT/configs/​{configId}/​versions/​{versionNumber}/​siem
Advanced configuration version settings
Get the evasive path match settings for a configurationGET/configs/​{configId}/​versions/​{versionNumber}/​advanced-settings/​evasive-path-match
Modify evasive path match settings for a configurationPUT/configs/​{configId}/​versions/​{versionNumber}/​advanced-settings/​evasive-path-match
Get the HTTP header log settings for a configurationGET/configs/​{configId}/​versions/​{versionNumber}/​advanced-settings/​logging
Modify HTTP header log settings for a configurationPUT/configs/​{configId}/​versions/​{versionNumber}/​advanced-settings/​logging
Get Pragma settings for a configurationGET/configs/​{configId}/​versions/​{versionNumber}/​advanced-settings/​pragma-header
Modify Pragma settings for a configurationPUT/configs/​{configId}/​versions/​{versionNumber}/​advanced-settings/​pragma-header
Get prefetch requestsGET/configs/​{configId}/​versions/​{versionNumber}/​advanced-settings/​prefetch
Modify prefetch requestsPUT/configs/​{configId}/​versions/​{versionNumber}/​advanced-settings/​prefetch
Get Request body size settings for a configurationGET/configs/​{configId}/​versions/​{versionNumber}/​advanced-settings/​request-body
Modify request body inspection limit settings for a configurationPUT/configs/​{configId}/​versions/​{versionNumber}/​advanced-settings/​request-body
Custom rules for a configuration
List custom rules for a configurationGET/configs/{configId}/custom-rules
Create a custom rule for a configurationPOST/configs/{configId}/custom-rules
Remove a custom rule from a configurationDELETE/configs/{configId}/custom-rules/{ruleId}
Get a custom rule for a configurationGET/configs/{configId}/custom-rules/{ruleId}
Update a custom rule for a configurationPUT/configs/{configId}/custom-rules/{ruleId}
Security policies
Clone or create a security policyPOST/configs/​{configId}/​versions/​{versionNumber}/​security-policies
List security policiesGET/configs/​{configId}/​versions/​{versionNumber}/​security-policies
Get a security policyGET/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}
Modify a security policyPUT/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}
Remove a security policyDELETE/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}
Security policy settings
List API endpointsGET/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​api-endpoints
Modify an API request constraint's actionPUT/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​api-request-constraints/​{apiId}
List API request constraints and actionsGET/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​api-request-constraints
Modify the request constraint action for all APIPUT/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​api-request-constraints
Get the exceptions of an attack groupGET/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​attack-groups/​{attackGroupId}/​condition-exception
Modify the exceptions of an attack groupPUT/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​attack-groups/​{attackGroupId}/​condition-exception
Get the action for an attack groupGET/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​attack-groups/​{attackGroupId}
Modify the action for an attack groupPUT/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​attack-groups/​{attackGroupId}
List attack groupsGET/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​attack-groups
Get the bypass network lists settings for a security policyGET/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​bypass-network-lists
Modify the bypass network lists settings for a security policyPUT/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​bypass-network-lists
Modify a custom rule actionPUT/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​custom-rules/​{ruleId}
List custom rule actionsGET/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​custom-rules
List evaluation hostnames for a security policyGET/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​eval-hostnames
Modify evaluation hostnames for a security policyPUT/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​eval-hostnames
Get the conditions and exceptions for an evaluation ruleGET/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​eval-rules/​{ruleId}/​condition-exception
Modify the conditions and exceptions for an evaluation rulePUT/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​eval-rules/​{ruleId}/​condition-exception
Get the action of an evaluation ruleGET/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​eval-rules/​{ruleId}
Modify the action of an evaluation rulePUT/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​eval-rules/​{ruleId}
List evaluation rulesGET/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​eval-rules
Set evaluation modePOST/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​eval
Get the IP/Geo Firewall settingsGET/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​ip-geo-firewall
Update the IP Geo Firewall settingsPUT/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​ip-geo-firewall
Get the current modeGET/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​mode
Modify the modePUT/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​mode
Get the penalty boxGET/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​penalty-box
Modify the penalty boxPUT/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​penalty-box
Protect evaluation hostnames for a security policyPUT/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​protect-eval-hostnames
Get protectionsGET/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​protections
Modify protectionsPUT/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​protections
Modify a rate policy actionPUT/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​rate-policies/​{ratePolicyId}
List rate policy actionsGET/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​rate-policies
List tuning recommendations for an attack groupGET/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​recommendations/​attack-groups/​{attackGroupId}
List tuning recommendations for a ruleGET/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​recommendations/​rules/​{ruleId}
Get tuning recommendations for a policyGET/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​recommendations
Respond to exception recommendationsPOST/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​recommendations
Get the reputation analysis settingsGET/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​reputation-analysis
Update the reputation analysis settingsPUT/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​reputation-analysis
Get the action for a reputation profileGET/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​reputation-profiles/​{reputationProfileId}
Modify the action for a reputation profilePUT/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​reputation-profiles/​{reputationProfileId}
List reputation profile actionsGET/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​reputation-profiles
List selected hostnames for a security policyGET/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​selected-hostnames
Modify selected hostnames for a security policyPUT/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​selected-hostnames
Get slow POST protection settingsGET/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​slow-post
Modify slow POST protection settingsPUT/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​slow-post
Advanced security policy settings
Get evasive path match settingsGET/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​advanced-settings/​evasive-path-match
Modify evasive path match settingPUT/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​advanced-settings/​evasive-path-match
Get HTTP header log settingsGET/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​advanced-settings/​logging
Modify HTTP header log settingsPUT/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​advanced-settings/​logging
Get Pragma settings for a security policyGET/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​advanced-settings/​pragma-header
Modify Pragma settings for a security policyPUT/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​advanced-settings/​pragma-header
Get request body inspection limit settings for a security policyGET/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​advanced-settings/​request-body
Modify request body size settings for a security policyPUT/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​advanced-settings/​request-body
Rules
List rulesGET/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​rules
Upgrade KRS rulesetPUT/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​rules
Get the action for a ruleGET/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​rules/​{ruleId}
Modify the action for a rulePUT/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​rules/​{ruleId}
Get the conditions and exceptions of a ruleGET/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​rules/​{ruleId}/​condition-exception
Modify the conditions and exceptions of a rulePUT/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​rules/​{ruleId}/​condition-exception
Get adaptive intelligence settingGET/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​rules/​threat-intel
Update adaptive intelligence settingPUT/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​rules/​threat-intel
Get upgrade detailsGET/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​rules/​upgrade-details
Export
Export a configuration versionGET/export/​configs/​{configId}/​versions/​{versionNumber}
Activations
Activate a configuration versionPOST/activations
Get activation statusGET/activations/​{activationId}
Get an activation request statusGET/activations/​status/​{statusId}
Contracts and groups
List contracts and groupsGET/contracts-groups
Hostnames
List available hostnames for a new configurationGET/contracts/​{contractId}/​groups/​{groupId}/​selectable-hostnames
Get Hostname CoverageGET/hostname-coverage
SIEM
Get SIEM versionsGET/siem-definitions