API summary

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

OperationMethodEndpoint
Configuration settings
List configurationsGET/configs
Create a configurationPOST/configs
Remove a configurationDELETE/configs/​{configId}
Get a security configurationGET/configs/​{configId}
Rename a security configurationPUT/configs/​{configId}
List custom rulesGET/configs/​{configId}/​custom-rules
Create a custom rulePOST/configs/​{configId}/​custom-rules
Remove a custom ruleDELETE/configs/​{configId}/​custom-rules/​{ruleId}
Get a custom ruleGET/configs/​{configId}/​custom-rules/​{ruleId}
Modify a custom rulePUT/configs/​{configId}/​custom-rules/​{ruleId}
List failover hostnamesGET/configs/​{configId}/​failover-hostnames
List configuration versionsGET/configs/​{configId}/​versions
Clone a configuration versionPOST/configs/​{configId}/​versions
Remove a configuration versionDELETE/configs/​{configId}/​versions/​{versionNumber}
Get configuration version detailsGET/configs/​{configId}/​versions/​{versionNumber}
Beta Get cookie settingsGET/configs/​{configId}/​versions/​{versionNumber}/​advanced-settings/​cookie-settings
Beta Modify cookie settingsPUT/configs/​{configId}/​versions/​{versionNumber}/​advanced-settings/​cookie-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 the attack payload log settings for a configurationGET/configs/​{configId}/​versions/​{versionNumber}/​advanced-settings/​logging/​attack-payload
Modify attack payload log settings for a configurationPUT/configs/​{configId}/​versions/​{versionNumber}/​advanced-settings/​logging/​attack-payload
Get PII learning settings for a configurationGET/configs/​{configId}/​versions/​{versionNumber}/​advanced-settings/​pii-learning
Enable PII learning settings for a configurationPUT/configs/​{configId}/​versions/​{versionNumber}/​advanced-settings/​pii-learning
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
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
List custom deny actionsGET/configs/​{configId}/​versions/​{versionNumber}/​custom-deny
Create a custom deny actionPOST/configs/​{configId}/​versions/​{versionNumber}/​custom-deny
Remove a custom deny actionDELETE/configs/​{configId}/​versions/​{versionNumber}/​custom-deny/​{customDenyId}
Get a custom deny actionGET/configs/​{configId}/​versions/​{versionNumber}/​custom-deny/​{customDenyId}
Modify a custom deny actionPUT/configs/​{configId}/​versions/​{versionNumber}/​custom-deny/​{customDenyId}
Get the hostname coverage match targetsGET/configs/​{configId}/​versions/​{versionNumber}/​hostname-coverage/​match-targets
List hostname overlapsGET/configs/​{configId}/​versions/​{versionNumber}/​hostname-coverage/​overlapping
List malware policiesGET/configs/​{configId}/​versions/​{versionNumber}/​malware-policies
Create a malware policyPOST/configs/​{configId}/​versions/​{versionNumber}/​malware-policies
List supported malware policy content typesGET/configs/​{configId}/​versions/​{versionNumber}/​malware-policies/​content-types
Remove a malware policyDELETE/configs/​{configId}/​versions/​{versionNumber}/​malware-policies/​{malwarePolicyId}
Get a malware policyGET/configs/​{configId}/​versions/​{versionNumber}/​malware-policies/​{malwarePolicyId}
Modify a malware policyPUT/configs/​{configId}/​versions/​{versionNumber}/​malware-policies/​{malwarePolicyId}
List match targetsGET/configs/​{configId}/​versions/​{versionNumber}/​match-targets
Create a match targetPOST/configs/​{configId}/​versions/​{versionNumber}/​match-targets
Modify match target orderPUT/configs/​{configId}/​versions/​{versionNumber}/​match-targets/​sequence
Remove a match targetDELETE/configs/​{configId}/​versions/​{versionNumber}/​match-targets/​{targetId}
Get a match targetGET/configs/​{configId}/​versions/​{versionNumber}/​match-targets/​{targetId}
Modify a match targetPUT/configs/​{configId}/​versions/​{versionNumber}/​match-targets/​{targetId}
List rate policiesGET/configs/​{configId}/​versions/​{versionNumber}/​rate-policies
Create a rate policyPOST/configs/​{configId}/​versions/​{versionNumber}/​rate-policies
Remove a rate policyDELETE/configs/​{configId}/​versions/​{versionNumber}/​rate-policies/​{ratePolicyId}
Get a rate policyGET/configs/​{configId}/​versions/​{versionNumber}/​rate-policies/​{ratePolicyId}
Modify a rate policyPUT/configs/​{configId}/​versions/​{versionNumber}/​rate-policies/​{ratePolicyId}
Modify a rate policy evaluationPUT/configs/​{configId}/​versions/​{versionNumber}/​rate-policies/​{ratePolicyId}/​evaluation
List reputation profilesGET/configs/​{configId}/​versions/​{versionNumber}/​reputation-profiles
Create a reputation profilePOST/configs/​{configId}/​versions/​{versionNumber}/​reputation-profiles
Remove a reputation profileDELETE/configs/​{configId}/​versions/​{versionNumber}/​reputation-profiles/​{reputationProfileId}
Get a reputation profileGET/configs/​{configId}/​versions/​{versionNumber}/​reputation-profiles/​{reputationProfileId}
Modify a reputation profilePUT/configs/​{configId}/​versions/​{versionNumber}/​reputation-profiles/​{reputationProfileId}
List selectable hostnamesGET/configs/​{configId}/​versions/​{versionNumber}/​selectable-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
List URL protection policiesGET/configs/​{configId}/​versions/​{versionNumber}/​url-protections
Create a URL protection policyPOST/configs/​{configId}/​versions/​{versionNumber}/​url-protections
Remove a URL protection policyDELETE/configs/​{configId}/​versions/​{versionNumber}/​url-protections/​{urlProtectionPolicyId}
Get a URL protection policyGET/configs/​{configId}/​versions/​{versionNumber}/​url-protections/​{urlProtectionPolicyId}
Modify a URL protection policyPUT/configs/​{configId}/​versions/​{versionNumber}/​url-protections/​{urlProtectionPolicyId}
Get the version notesGET/configs/​{configId}/​versions/​{versionNumber}/​version-notes
Update the version notesPUT/configs/​{configId}/​versions/​{versionNumber}/​version-notes
Get SIEM versionsGET/siem-definitions
Security policies
List security policiesGET/configs/​{configId}/​versions/​{versionNumber}/​security-policies
Clone or create a security policyPOST/configs/​{configId}/​versions/​{versionNumber}/​security-policies
Remove a security policyDELETE/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}
Get a security policyGET/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}
Modify a security policyPUT/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}
Get evasive path match settingGET/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 attack payload logging settings for a policyGET/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​advanced-settings/​logging/​attack-payload
Modify Attack Payload Logging settings for a policyPUT/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​advanced-settings/​logging/​attack-payload
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
List API endpointsGET/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​api-endpoints
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
Modify an API request constraint's actionPUT/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​api-request-constraints/​{apiId}
List attack groupsGET/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​attack-groups
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}
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 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
Get Client-Side Protection & Compliance settingsGET/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​cpc
Modify Client-Side Protections & Compliance settingsPUT/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​cpc
List custom rule actionsGET/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​custom-rules
Modify a custom rule actionPUT/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​custom-rules/​{ruleId}
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
List malware policy actionsGET/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​malware-policies
Modify a malware policy actionPUT/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​malware-policies/​{malwarePolicyId}
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
Get penalty box conditionGET/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​penalty-box/​conditions
Modify the penalty box conditionsPUT/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​penalty-box/​conditions
Get protectionsGET/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​protections
Modify protectionsPUT/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​protections
List rate policy actionsGET/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​rate-policies
Modify a rate policy actionPUT/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​rate-policies/​{ratePolicyId}
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
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 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
List reputation profile actionsGET/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​reputation-profiles
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 rulesGET/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​rules
Upgrade KRS rulesetPUT/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​rules
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
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
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
List URL protection policy actionsGET/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​url-protections
Modify a URL protection policy actionPUT/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​url-protections/​{urlProtectionPolicyId}
Evaluation mode
Protect evaluation hostnamesPUT/configs/​{configId}/​versions/​{versionNumber}/​protect-eval-hostnames
Set evaluation modePOST/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​eval
List evaluation attack groupsGET/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​eval-groups
Get the action for an evaluation attack groupGET/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​eval-groups/​{attackGroupId}
Modify the action for an evaluation attack groupPUT/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​eval-groups/​{attackGroupId}
Get the exceptions of an evaluation attack groupGET/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​eval-groups/​{attackGroupId}/​condition-exception
Modify the exceptions of an evaluation attack groupPUT/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​eval-groups/​{attackGroupId}/​condition-exception
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 penalty box for a policy in evaluation modeGET/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​eval-penalty-box
Modify the evaluation penalty boxPUT/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​eval-penalty-box
Get penalty box conditions in evaluation modeGET/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​eval-penalty-box/​conditions
Modify the penalty box conditions in evaluation modePUT/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​eval-penalty-box/​conditions
List evaluation rulesGET/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​eval-rules
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}
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
Protect evaluation hostnames for a security policyPUT/configs/​{configId}/​versions/​{versionNumber}/​security-policies/​{policyId}/​protect-eval-hostnames
List evaluation hostnamesGET/configs/​{configId}/​versions/​{versionNumber}/​selected-hostnames/​eval-hostnames
Modify evaluation hostnamesPUT/configs/​{configId}/​versions/​{versionNumber}/​selected-hostnames/​eval-hostnames
Activation and export
Activate a configuration versionPOST/activations
Get an activation request statusGET/activations/​status/​{statusId}
Get activation statusGET/activations/​{activationId}
List activation historyGET/configs/​{configId}/​activations
Compare two versionsPOST/configs/​{configId}/​versions/​diff
Export a configuration versionGET/export/​configs/​{configId}/​versions/​{versionNumber}
Utilities and account data
List discovered APIsGET/api-discovery
Get a discovered APIGET/api-discovery/​host/​{hostname}/​basepath/​{basePath}
Modify an API's visibilityPUT/api-discovery/​host/​{hostname}/​basepath/​{basePath}
List discovered API endpointsGET/api-discovery/​host/​{hostname}/​basepath/​{basePath}/​endpoints
Create an endpoint or resourcePOST/api-discovery/​host/​{hostname}/​basepath/​{basePath}/​endpoints
List subscribersGET/configs/​{configId}/​notification/​subscription/​{feature}
Subscribe or unsubscribe to recommendation emailsPOST/configs/​{configId}/​notification/​subscription/​{feature}
List contracts and groupsGET/contracts-groups
List available hostnames for a new configurationGET/contracts/​{contractId}/​groups/​{groupId}/​selectable-hostnames
Get hostname coverageGET/hostname-coverage
Self-service onboardings
Validate hostname CNAME DNS recordsPOST/appsec/​v1/​onboardings/​{onboardingId}/​cname-to-akamai/​validate
Skip origin hostnames DNS record validationPOST/appsec/​v1/​onboardings/​{onboardingId}/​origin-validation/​skip
Validate origin hostnames DNS recordsPOST/appsec/​v1/​onboardings/​{onboardingId}/​origin-validation/​validate
List onboardingsGET/onboardings
Create an onboardingPOST/onboardings
Delete an OnboardingDELETE/onboardings/​{onboardingId}
Get an onboardingGET/onboardings/​{onboardingId}
Activate an onboardingPOST/onboardings/​{onboardingId}/​activations
Onboarding activation statusGET/onboardings/​{onboardingId}/​activations/​{activationId}
Get onboarding certificate challengesGET/onboardings/​{onboardingId}/​certificate-validation
Validate onboarding certificatePOST/onboardings/​{onboardingId}/​certificate-validation/​validate
Get hostname CNAME DNS recordsGET/onboardings/​{onboardingId}/​cname-to-akamai
Get origin hostnames DNS recordsGET/onboardings/​{onboardingId}/​origin-validation
List onboarding settingsGET/onboardings/​{onboardingId}/​settings
Update Onboarding SettingsPUT/onboardings/​{onboardingId}/​settings