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