See the API's various operations for details on their request parameters and response data.
Operation | Method | Endpoint |
---|---|---|
Configuration settings | ||
List configurations | GET | /configs |
Create a configuration | POST | /configs |
Remove a configuration | DELETE | /configs/{configId} |
Get a security configuration | GET | /configs/{configId} |
Rename a security configuration | PUT | /configs/{configId} |
List custom rules | GET | /configs/{configId}/custom-rules |
Create a custom rule | POST | /configs/{configId}/custom-rules |
Remove a custom rule | DELETE | /configs/{configId}/custom-rules/{ruleId} |
Get a custom rule | GET | /configs/{configId}/custom-rules/{ruleId} |
Modify a custom rule | PUT | /configs/{configId}/custom-rules/{ruleId} |
List failover hostnames | GET | /configs/{configId}/failover-hostnames |
List configuration versions | GET | /configs/{configId}/versions |
Clone a configuration version | POST | /configs/{configId}/versions |
Remove a configuration version | DELETE | /configs/{configId}/versions/{versionNumber} |
Get configuration version details | GET | /configs/{configId}/versions/{versionNumber} |
Beta Get cookie settings | GET | /configs/{configId}/versions/{versionNumber}/advanced-settings/cookie-settings |
Beta Modify cookie settings | PUT | /configs/{configId}/versions/{versionNumber}/advanced-settings/cookie-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 the attack payload log settings for a configuration | GET | /configs/{configId}/versions/{versionNumber}/advanced-settings/logging/attack-payload |
Modify attack payload log settings for a configuration | PUT | /configs/{configId}/versions/{versionNumber}/advanced-settings/logging/attack-payload |
Get PII learning settings for a configuration | GET | /configs/{configId}/versions/{versionNumber}/advanced-settings/pii-learning |
Enable PII learning settings for a configuration | PUT | /configs/{configId}/versions/{versionNumber}/advanced-settings/pii-learning |
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 |
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 |
List custom deny actions | GET | /configs/{configId}/versions/{versionNumber}/custom-deny |
Create a custom deny action | POST | /configs/{configId}/versions/{versionNumber}/custom-deny |
Remove a custom deny action | DELETE | /configs/{configId}/versions/{versionNumber}/custom-deny/{customDenyId} |
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} |
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 |
List malware policies | GET | /configs/{configId}/versions/{versionNumber}/malware-policies |
Create a malware policy | POST | /configs/{configId}/versions/{versionNumber}/malware-policies |
List supported malware policy content types | GET | /configs/{configId}/versions/{versionNumber}/malware-policies/content-types |
Remove a malware policy | DELETE | /configs/{configId}/versions/{versionNumber}/malware-policies/{malwarePolicyId} |
Get a malware policy | GET | /configs/{configId}/versions/{versionNumber}/malware-policies/{malwarePolicyId} |
Modify a malware policy | PUT | /configs/{configId}/versions/{versionNumber}/malware-policies/{malwarePolicyId} |
List match targets | GET | /configs/{configId}/versions/{versionNumber}/match-targets |
Create a match target | POST | /configs/{configId}/versions/{versionNumber}/match-targets |
Modify match target order | PUT | /configs/{configId}/versions/{versionNumber}/match-targets/sequence |
Remove a match target | DELETE | /configs/{configId}/versions/{versionNumber}/match-targets/{targetId} |
Get a match target | GET | /configs/{configId}/versions/{versionNumber}/match-targets/{targetId} |
Modify a match target | PUT | /configs/{configId}/versions/{versionNumber}/match-targets/{targetId} |
List rate policies | GET | /configs/{configId}/versions/{versionNumber}/rate-policies |
Create a rate policy | POST | /configs/{configId}/versions/{versionNumber}/rate-policies |
Remove a rate policy | DELETE | /configs/{configId}/versions/{versionNumber}/rate-policies/{ratePolicyId} |
Get a rate policy | GET | /configs/{configId}/versions/{versionNumber}/rate-policies/{ratePolicyId} |
Modify a rate policy | PUT | /configs/{configId}/versions/{versionNumber}/rate-policies/{ratePolicyId} |
Modify a rate policy evaluation | PUT | /configs/{configId}/versions/{versionNumber}/rate-policies/{ratePolicyId}/evaluation |
List reputation profiles | GET | /configs/{configId}/versions/{versionNumber}/reputation-profiles |
Create a reputation profile | POST | /configs/{configId}/versions/{versionNumber}/reputation-profiles |
Remove a reputation profile | DELETE | /configs/{configId}/versions/{versionNumber}/reputation-profiles/{reputationProfileId} |
Get a reputation profile | GET | /configs/{configId}/versions/{versionNumber}/reputation-profiles/{reputationProfileId} |
Modify a reputation profile | PUT | /configs/{configId}/versions/{versionNumber}/reputation-profiles/{reputationProfileId} |
List selectable hostnames | GET | /configs/{configId}/versions/{versionNumber}/selectable-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 |
List URL protection policies | GET | /configs/{configId}/versions/{versionNumber}/url-protections |
Create a URL protection policy | POST | /configs/{configId}/versions/{versionNumber}/url-protections |
Remove a URL protection policy | DELETE | /configs/{configId}/versions/{versionNumber}/url-protections/{urlProtectionPolicyId} |
Get a URL protection policy | GET | /configs/{configId}/versions/{versionNumber}/url-protections/{urlProtectionPolicyId} |
Modify a URL protection policy | PUT | /configs/{configId}/versions/{versionNumber}/url-protections/{urlProtectionPolicyId} |
Get the version notes | GET | /configs/{configId}/versions/{versionNumber}/version-notes |
Update the version notes | PUT | /configs/{configId}/versions/{versionNumber}/version-notes |
Get SIEM versions | GET | /siem-definitions |
Security policies | ||
List security policies | GET | /configs/{configId}/versions/{versionNumber}/security-policies |
Clone or create a security policy | POST | /configs/{configId}/versions/{versionNumber}/security-policies |
Remove a security policy | DELETE | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId} |
Get a security policy | GET | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId} |
Modify a security policy | PUT | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId} |
Get evasive path match setting | 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 attack payload logging settings for a policy | GET | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/advanced-settings/logging/attack-payload |
Modify Attack Payload Logging settings for a policy | PUT | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/advanced-settings/logging/attack-payload |
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 |
List API endpoints | GET | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/api-endpoints |
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 |
Modify an API request constraint's action | PUT | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/api-request-constraints/{apiId} |
List attack groups | GET | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/attack-groups |
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} |
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 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 |
Get Client-Side Protection & Compliance settings | GET | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/cpc |
Modify Client-Side Protections & Compliance settings | PUT | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/cpc |
List custom rule actions | GET | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/custom-rules |
Modify a custom rule action | PUT | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/custom-rules/{ruleId} |
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 |
List malware policy actions | GET | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/malware-policies |
Modify a malware policy action | PUT | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/malware-policies/{malwarePolicyId} |
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 |
Get penalty box condition | GET | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/penalty-box/conditions |
Modify the penalty box conditions | PUT | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/penalty-box/conditions |
Get protections | GET | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/protections |
Modify protections | PUT | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/protections |
List rate policy actions | GET | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/rate-policies |
Modify a rate policy action | PUT | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/rate-policies/{ratePolicyId} |
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 |
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 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 |
List reputation profile actions | GET | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/reputation-profiles |
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 rules | GET | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/rules |
Upgrade KRS ruleset | PUT | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/rules |
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 |
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 |
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 |
List URL protection policy actions | GET | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/url-protections |
Modify a URL protection policy action | PUT | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/url-protections/{urlProtectionPolicyId} |
Evaluation mode | ||
Protect evaluation hostnames | PUT | /configs/{configId}/versions/{versionNumber}/protect-eval-hostnames |
Set evaluation mode | POST | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/eval |
List evaluation attack groups | GET | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/eval-groups |
Get the action for an evaluation attack group | GET | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/eval-groups/{attackGroupId} |
Modify the action for an evaluation attack group | PUT | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/eval-groups/{attackGroupId} |
Get the exceptions of an evaluation attack group | GET | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/eval-groups/{attackGroupId}/condition-exception |
Modify the exceptions of an evaluation attack group | PUT | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/eval-groups/{attackGroupId}/condition-exception |
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 penalty box for a policy in evaluation mode | GET | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/eval-penalty-box |
Modify the evaluation penalty box | PUT | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/eval-penalty-box |
Get penalty box conditions in evaluation mode | GET | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/eval-penalty-box/conditions |
Modify the penalty box conditions in evaluation mode | PUT | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/eval-penalty-box/conditions |
List evaluation rules | GET | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/eval-rules |
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} |
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 |
Protect evaluation hostnames for a security policy | PUT | /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/protect-eval-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 |
Activation and export | ||
Activate a configuration version | POST | /activations |
Get an activation request status | GET | /activations/status/{statusId} |
Get activation status | GET | /activations/{activationId} |
List activation history | GET | /configs/{configId}/activations |
Compare two versions | POST | /configs/{configId}/versions/diff |
Export a configuration version | GET | /export/configs/{configId}/versions/{versionNumber} |
Utilities and account data | ||
List discovered APIs | GET | /api-discovery |
Get a discovered API | GET | /api-discovery/host/{hostname}/basepath/{basePath} |
Modify an API's visibility | PUT | /api-discovery/host/{hostname}/basepath/{basePath} |
List discovered API endpoints | GET | /api-discovery/host/{hostname}/basepath/{basePath}/endpoints |
Create an endpoint or resource | POST | /api-discovery/host/{hostname}/basepath/{basePath}/endpoints |
List subscribers | GET | /configs/{configId}/notification/subscription/{feature} |
Subscribe or unsubscribe to recommendation emails | POST | /configs/{configId}/notification/subscription/{feature} |
List contracts and groups | GET | /contracts-groups |
List available hostnames for a new configuration | GET | /contracts/{contractId}/groups/{groupId}/selectable-hostnames |
Get hostname coverage | GET | /hostname-coverage |
Self-service onboardings | ||
Validate hostname CNAME DNS records | POST | /appsec/v1/onboardings/{onboardingId}/cname-to-akamai/validate |
Skip origin hostnames DNS record validation | POST | /appsec/v1/onboardings/{onboardingId}/origin-validation/skip |
Validate origin hostnames DNS records | POST | /appsec/v1/onboardings/{onboardingId}/origin-validation/validate |
List onboardings | GET | /onboardings |
Create an onboarding | POST | /onboardings |
Delete an Onboarding | DELETE | /onboardings/{onboardingId} |
Get an onboarding | GET | /onboardings/{onboardingId} |
Activate an onboarding | POST | /onboardings/{onboardingId}/activations |
Onboarding activation status | GET | /onboardings/{onboardingId}/activations/{activationId} |
Get onboarding certificate challenges | GET | /onboardings/{onboardingId}/certificate-validation |
Validate onboarding certificate | POST | /onboardings/{onboardingId}/certificate-validation/validate |
Get hostname CNAME DNS records | GET | /onboardings/{onboardingId}/cname-to-akamai |
Get origin hostnames DNS records | GET | /onboardings/{onboardingId}/origin-validation |
List onboarding settings | GET | /onboardings/{onboardingId}/settings |
Update Onboarding Settings | PUT | /onboardings/{onboardingId}/settings |