Jump to Content
Application Security API
APIRelease notesTerraform
Application Security API
API
APIRelease notesTerraform

API

  • Application Security API
  • API summary
  • OpenAPI schema
  • Get Started
    • Set up your API token
  • API concepts
  • API workflows
    • Activate with invalid hostnames
    • Add a new hostname to a configuration
    • Add a new custom rule to a configuration
    • Export a configuration version
    • Diff configuration versions
  • Rate limiting
  • Enumeration values
    • Export condition type values
    • Export match condition type values
    • Export header values
    • Condition values
    • CustomRule condition type values
    • Deny name values
    • Exception selector values
    • Recommendation selector values
    • Logging option values (Beta)
  • Errors
    • 400
    • 401
    • 403
    • 404
    • 409
    • 429

Configuration settings

  • General configuration settings
    • Create a configurationpost
    • List configurationsget
    • Get a security configurationget
    • Rename a security configurationput
    • Remove a configurationdelete
    • Clone a configuration versionpost
    • List configuration versionsget
    • Get configuration version detailsget
    • Remove a configuration versiondelete
    • Get the version notesget
    • Modify version notesput
  • Match targets
    • Get the hostname coverage match targetsget
    • Create a match targetpost
    • List match targetsget
    • Modify match target orderput
    • Get a match targetget
    • Modify a match targetput
    • Remove a match targetdelete
  • Prefetch requests
    • Get prefetch requestsget
    • Modify prefetch requestsput
  • Shared resources: Rate policies
    • Create a rate policypost
    • List rate policiesget
    • Get a rate policyget
    • Modify a rate policyput
    • Remove a rate policydelete
    • Modify a rate policy evaluationput
  • SIEM settings
    • Get SIEM settingsget
    • Modify SIEM settingsput
    • Get SIEM versionsget
  • URL protection policies
    • Create a URL protection policypost
    • List URL protection policiesget
    • Get a URL protection policyget
    • Modify a URL protection policyput
    • Remove a URL protection policydelete
  • Hostnames
    • List hostname overlapsget
    • List selectable hostnamesget
    • List selected hostnamesget
    • Modify selected hostnamesput
  • Shared resources: Malware policies
    • Create a malware policypost
    • List malware policiesget
    • List supported malware policy content typesget
    • Get a malware policyget
    • Modify a malware policyput
    • Remove a malware policydelete
  • Shared resources: Custom rules
    • Create a custom rulepost
    • List custom rulesget
    • Get a custom ruleget
    • Modify a custom ruleput
    • Remove a custom ruledelete
  • PII learning
    • Get PII learning settings for a configurationget
    • Enable PII learning settings for a configurationput
  • Shared resources: Custom deny actions
    • Create a custom deny actionpost
    • List custom deny actionsget
    • Get a custom deny actionget
    • Modify a custom deny actionput
    • Remove a custom deny actiondelete
  • Bypass network lists
    • Get bypass network lists settingsget
    • Modify the bypass network lists settingsput
  • Failover hostnames
    • List failover hostnamesget
  • Shared resources: Reputation profiles
    • Create a reputation profilepost
    • List reputation profilesget
    • Get a reputation profileget
    • Modify a reputation profileput
    • Remove a reputation profiledelete
  • Request body size
    • Get request body size settings for a configurationget
    • Modify request body inspection limit settings for a configurationput
  • Cookie Settings
    • Get cookie settingsget
    • Modify cookie settingsput
  • Evasive path match
    • Get evasive path match settings for a configurationget
    • Modify evasive path match settings for a configurationput
  • HTTP header logs
    • Get the HTTP header log settings for a configurationget
    • Modify HTTP header log settings for a configurationput
  • Attack payload logs
    • Get the attack payload log settings for a configurationget
    • Modify attack payload log settings for a configurationput
  • Pragma settings
    • Get Pragma settings for a configurationget
    • Modify Pragma settings for a configurationput

Security policies

  • General policy settings
    • Clone or create a security policypost
    • List security policiesget
    • Get a security policyget
    • Modify a security policyput
    • Remove a security policydelete
  • Rate policy actions
    • List rate policy actionsget
    • Modify a rate policy actionput
  • IP/Geo Firewall settings
    • Get IP/Geo Firewall settingsget
    • Modify IP/Geo Firewall settingsput
  • Attack payload logs
    • Get attack payload logging settings for a policyget
    • Modify attack payload logging settings for a policyput
  • HTTP header logs
    • Get HTTP header log settingsget
    • Modify HTTP header log settingsput
  • Client reputation
    • List reputation profile actionsget
    • Get the action for a reputation profileget
    • Modify the action for a reputation profileput
  • Custom rule actions
    • List custom rule actionsget
    • Modify a custom rule actionput
  • Reputation analysis
    • Get reputation analysis settingsget
    • Modify reputation analysis settingsput
  • URL protection policy actions
    • List URL protection policy actionsget
    • Modify a URL protection policy actionput
  • Pragma settings
    • Get Pragma settings for a security policyget
    • Modify Pragma settings for a security policyput
  • API request constraints
    • List API request constraints and actionsget
    • Modify the request constraint action for all APIsput
    • Modify an API request constraint's actionput
  • Evasive path match
    • Get evasive path match settingsget
    • Modify evasive path match settingsput
  • Malware policy actions
    • List malware policy actionsget
    • Modify a malware policy actionput
  • Request body inspection limits
    • Get request body inspection limit settings for a security policyget
    • Modify request body size settings for a security policyput
  • API endpoints
    • List API endpointsget
  • Slow POST protections
    • Get slow POST protection settingsget
    • Modify slow POST protection settingsput
  • WAF rules: General settings
    • List rulesget
    • Upgrade KRS rulesetput
    • Get adaptive intelligence settingsget
    • Modify adaptive intelligence settingsput
    • Get upgrade detailsget
    • Get the action for a ruleget
    • Modify the action for a ruleput
    • Get the conditions and exceptions of a ruleget
    • Modify the conditions and exceptions of a ruleput
  • Protections
    • Get protectionsget
    • Modify protectionsput
  • WAF rules: Penalty box
    • Get the penalty boxget
    • Modify the penalty boxput
  • WAF rules: Penalty box conditions
    • Get penalty box conditionget
    • Modify the penalty box conditionsput
  • WAF rules: Tuning recommendations
    • Respond to exception recommendationspost
    • Get tuning recommendations for a policyget
    • List tuning recommendations for an attack groupget
    • List tuning recommendations for a ruleget
  • WAF rules: Attack groups
    • List attack groupsget
    • Get the action for an attack groupget
    • Modify the action for an attack groupput
    • Get the exceptions of an attack groupget
    • Modify the exceptions of an attack groupput
  • WAF rules: Update mode
    • Get the current modeget
    • Modify the modeput
  • WAF rules: Rapid rules
    • List rapid rulesget
    • Get rapid rules' default actionget
    • Update rapid rules' default actionput
    • Get rapid rules' statusget
    • Update rapid rules' statusput
    • List a rapid rule's conditions and exceptionsget
    • Update a rapid rule's conditions and exceptionsput
    • Get a rapid rule's lock statusget
    • Update a rapid rule's lock statusput
    • Get a rapid rule's actionget
    • Update a rapid rule's actionput
  • Challenge actions
    • Create a challenge actionpost
    • List challenge actionsget
    • Get a challenge actionget
    • Update a challenge actionput
    • Delete a challenge actiondelete
    • Update Google reCAPTCHA secret keyput
  • Bypass network lists
    • Get the bypass network lists settings for a security policyget
    • Modify the bypass network lists settings for a security policyput
  • Client-Side Protections & Compliance
    • Get Client-Side Protection & Compliance settingsget
    • Modify Client-Side Protections & Compliance settingsput
  • Hostnames
    • List selected hostnames for a security policyget
    • Modify selected hostnames for a security policyput

Activation and export

  • Activations
    • Activate a configuration versionpost
  • Configuration version export
    • Export a configuration versionget
  • Activation history
    • List activation historyget
  • Activation status
    • Get an activation request statusget
    • Get activation statusget
  • Configuration version diff
    • Compare two versionspost

Evaluation mode

  • Security policy: Conditions and exceptions
    • Get the exceptions of an evaluation attack groupget
    • Modify the exceptions of an evaluation attack groupput
    • Get the conditions and exceptions for an evaluation ruleget
    • Modify the conditions and exceptions for an evaluation ruleput
  • Security policy: Evaluation hostnames
    • List evaluation hostnames for a security policyget
    • Modify evaluation hostnames for a security policyput
    • Protect evaluation hostnames for a security policyput
  • Security policy: Evaluation mode
    • Set evaluation modepost
  • Security policy: Evaluation penalty box
    • Get the penalty box for a policy in evaluation modeget
    • Modify the evaluation penalty boxput
  • Security policy: Evaluation rules
    • List evaluation rulesget
    • Get the action of an evaluation ruleget
    • Modify the action of an evaluation ruleput
  • Security policy: Evaluation attack groups
    • List evaluation attack groupsget
    • Get the action for an evaluation attack groupget
    • Modify the action for an evaluation attack groupput
  • WAF rules: Evaluation Penalty box conditions
    • Get penalty box conditions in evaluation modeget
    • Modify the penalty box conditions in evaluation modeput
  • Configuration: Evaluation hostnames
    • Protect evaluation hostnamesput
    • List evaluation hostnamesget
    • Modify evaluation hostnamesput

Utilities and account data

  • Discovered APIs
    • List discovered APIsget
    • Get a discovered APIget
  • Subscriptions
    • Subscribe or unsubscribe to recommendation emailspost
    • List subscribersget
  • Endpoints
    • Modify an API's visibilityput
    • Create an endpoint or resourcepost
    • List discovered API endpointsget
  • Contracts and groups
    • List contracts and groupsget
  • Available hostnames
    • List available hostnames for a new configurationget
  • Hostname coverage
    • Get hostname coverageget
  • CVE Protections lookup
    • List CVEsget
    • Subscribe to CVEspost
    • List subscribed CVEsget
    • Unsubscribe from CVEspost
    • Get a CVEget
    • Get CVE coverageget

Self-service onboardings

  • Onboarding: Creation and settings
    • Create an onboardingpost
    • List onboardingsget
    • Get an onboardingget
    • Delete an onboardingdelete
    • Get onboarding settingsget
    • Modify onboarding settingsput
  • Onboarding: Activations and status
    • Activate an onboardingpost
    • Get an onboarding activationget
  • Onboarding: Post-activation validation
    • List onboarding certificate challengesget
    • Validate onboarding certificatepost
    • List hostname CNAME DNS recordsget
    • Validate hostname CNAME DNS recordspost
    • List origin hostname DNS recordsget
    • Skip origin hostnames DNS record validationpost
    • Validate origin hostnames DNS recordspost

Export a configuration version

  1. Run List configurations and select a configId.

  2. Run List configuration versions and select a versionNumber.

  3. Make a GET request to /appsec/v1/export/configs/{configId}/versions/{versionNumber}.

Akamai TechDocs
Akamai.com
Linode.com
Contact us
Akamai support Linode support Share feedback
Try Akamai
Log in
Log out
Try Akamai

Akamai.com

Linode.com

Contact us Akamai support Linode support Share feedback

Log in
Log out