Akamai

Akamai: Application Security API

Manage your configurations for Kona Site Defender, Web Application Protector, and Client Reputation.

Developer tools#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Manage your configurations for Kona Site Defender,
Web Application Protector, and Client Reputation.

Endpoints 236

General configuration settings

  • GETList configurations/configs?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Lists available security configurations.
  • POSTCreate a configuration/configs?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Create a new WAP or KSD security configuration. KSD security configurations start out empty, and WAP configurations are created with preset…
  • GETGet a security configuration/configs/:configId?includeHostnames=false&accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Retrieves the configuration details.
  • PUTRename a security configuration/configs/:configId?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Update the name of your security configuration.
  • DELETEDelete a configuration/configs/:configId?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Deletes the specified security configuration.
  • GETList configuration versions/configs/:configId/versions?page=2&pageSize=10&detail=true&accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Lists available versions for the specified security configuration, with results optionally paginated.
  • POSTClone a configuration version/configs/:configId/versions?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Creates a new version of the specified security configuration.
  • GETGet configuration version details/configs/:configId/versions/:versionNumber?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Returns basic details about a configuration version. To get a more extensive object with detailed information about a version's security…
  • DELETEDelete a configuration version/configs/:configId/versions/:versionNumber?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Delete the specified configuration version. You can't delete a version that's actively in use.
  • GETGet the version notes/configs/:configId/versions/:versionNumber/version-notes?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Get the most recent version notes for a configuration.
  • PUTModify version notes/configs/:configId/versions/:versionNumber/version-notes?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Update the most recent version notes for a configuration.

Match targets

  • GETGet the hostname coverage match targets/configs/:configId/versions/:versionNumber/hostname-coverage/match-targets?hostname=www.example.com&accountSwitchKey=1-5C0YLB:1-8BYUX__Kona Site Defender__, __App & API Protector with the Advanced Security module__ List the API and website match targets that protect a hostname.
  • GETList match targets/configs/:configId/versions/:versionNumber/match-targets?policyId=abc_123456&includeChildObjectName=false&accountSwitchKey=1-5C0YLB:1-8BYUX__Kona Site Defender__, __App & API Protector with the Advanced Security module__ Returns match targets defined in the specified security configuration version.
  • POSTCreate a match target/configs/:configId/versions/:versionNumber/match-targets?accountSwitchKey=1-5C0YLB:1-8BYUX__Kona Site Defender__, __App & API Protector with the Advanced Security module__ Creates a new Match Target in the specified Configuration Version.
  • PUTModify match target order/configs/:configId/versions/:versionNumber/match-targets/sequence?accountSwitchKey=1-5C0YLB:1-8BYUX__Kona Site Defender__, __App & API Protector with the Advanced Security module__ Updates the sequence of Match Targets in a configuration version. The…
  • GETGet a match target/configs/:configId/versions/:versionNumber/match-targets/:targetId?includeChildObjectName=false&accountSwitchKey=1-5C0YLB:1-8BYUX__Kona Site Defender__, __App & API Protector with the Advanced Security module__ Returns the specified match target.
  • PUTModify a match target/configs/:configId/versions/:versionNumber/match-targets/:targetId?accountSwitchKey=1-5C0YLB:1-8BYUX__Kona Site Defender__, __App & API Protector with the Advanced Security module__ Updates details about the specified match target.
  • DELETERemove a match target/configs/:configId/versions/:versionNumber/match-targets/:targetId?accountSwitchKey=1-5C0YLB:1-8BYUX__Kona Site Defender__, __App & API Protector with the Advanced Security module__ Deletes the specified match target.

Prefetch requests

  • GETGet prefetch requests/configs/:configId/versions/:versionNumber/advanced-settings/prefetch?accountSwitchKey=1-5C0YLB:1-8BYUX__Kona Site Defender__ Get Prefetch Request settings.
  • PUTModify prefetch requests/configs/:configId/versions/:versionNumber/advanced-settings/prefetch?accountSwitchKey=1-5C0YLB:1-8BYUX__Kona Site Defender__ Enabling this protection causes your application firewall rules to inspect internal requests (those between your origin and Akamai's…

Shared resources: Rate policies

  • GETList rate policies/configs/:configId/versions/:versionNumber/rate-policies?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Returns rate policies for a specific security configuration version.
  • POSTCreate a rate policy/configs/:configId/versions/:versionNumber/rate-policies?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Create a new rate policy for a specific configuration version. Now you can match on defined or undefined resources. If you're setting a match…
  • GETGet a rate policy/configs/:configId/versions/:versionNumber/rate-policies/:ratePolicyId?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Returns the specified rate policy.
  • PUTModify a rate policy/configs/:configId/versions/:versionNumber/rate-policies/:ratePolicyId?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Update details for a specific rate policy. Now you can match on defined or undefined resources. If you're setting a match for either resource…
  • DELETERemove a rate policy/configs/:configId/versions/:versionNumber/rate-policies/:ratePolicyId?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Delete the specified rate policy. You can't delete a rate policy that is actively in use. To delete the rate policy, first activate an older…
  • PUTModify a rate policy evaluation/configs/:configId/versions/:versionNumber/rate-policies/:ratePolicyId/evaluation?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Apply or discard a rate policy evaluation.

SIEM settings

  • GETGet SIEM settings/configs/:configId/versions/:versionNumber/siem?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Return SIEM settings for a specific configuration.
  • PUTModify SIEM settings/configs/:configId/versions/:versionNumber/siem?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Update SIEM settings for a specific configuration.
  • GETGet SIEM versions/siem-definitions?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Get available SIEM versions.

URL protection policies

  • GETList URL protection policies/configs/:configId/versions/:versionNumber/url-protections?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Returns all URL protection policies for a specific security configuration version.
  • POSTCreate a URL protection policy/configs/:configId/versions/:versionNumber/url-protections?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Creates a new URL protection policy for a specific configuration version.
  • GETGet a URL protection policy/configs/:configId/versions/:versionNumber/url-protections/:urlProtectionPolicyId?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Returns the specified URL protection policy.
  • PUTModify a URL protection policy/configs/:configId/versions/:versionNumber/url-protections/:urlProtectionPolicyId?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Updates the specified URL protection policy.
  • DELETERemove a URL protection policy/configs/:configId/versions/:versionNumber/url-protections/:urlProtectionPolicyId?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Deletes the specified URL protection policy. You can't delete a URL protection policy that's actively in use. To delete an active URL…

Hostnames

  • GETList hostname overlaps/configs/:configId/versions/:versionNumber/hostname-coverage/overlapping?hostname=www.example.com&accountSwitchKey=1-5C0YLB:1-8BYUX__Kona Site Defender__, __App & API Protector with the Advanced Security module__ List the configuration versions that contain a hostname also included in the…
  • GETList selected hostnames for a security policy/configs/:configId/versions/:versionNumber/security-policies/:policyId/selected-hostnames?accountSwitchKey=1-5C0YLB:1-8BYUX__Web Application Protector__, __App & API Protector__ List the hostnames that the configuration version selects as candidates of protected hostnames, which…
  • PUTModify selected hostnames for a security policy/configs/:configId/versions/:versionNumber/security-policies/:policyId/selected-hostnames?accountSwitchKey=1-5C0YLB:1-8BYUX__Web Application Protector__, __App & API Protector__ Update the list of selected hostnames for a configuration. You can add an individual hostname to your…
  • GETList selectable hostnames/configs/:configId/versions/:versionNumber/selectable-hostnames?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ List the hostnames that a given configuration version has the ability to protect. Hostnames may show as error hosts when they aren't…
  • GETList selected hostnames/configs/:configId/versions/:versionNumber/selected-hostnames?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ List the hostnames that the configuration version selects as candidates of protected hostnames, which you can use in match targets.
  • PUTModify selected hostnames/configs/:configId/versions/:versionNumber/selected-hostnames?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Update the list of selected hostnames for a configuration version. Now you can add an individual hostname to your selected hostnames list…

Shared resources: Malware policies

  • GETList malware policies/configs/:configId/versions/:versionNumber/malware-policies?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Return malware policies for a security configuration version.
  • POSTCreate a malware policy/configs/:configId/versions/:versionNumber/malware-policies?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Create a new malware policy for a security configuration version.
  • GETList supported malware policy content types/configs/:configId/versions/:versionNumber/malware-policies/content-types?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Returns all the supported malware policy content types for a security configuration version.
  • GETGet a malware policy/configs/:configId/versions/:versionNumber/malware-policies/:malwarePolicyId?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Return a malware policy.
  • PUTModify a malware policy/configs/:configId/versions/:versionNumber/malware-policies/:malwarePolicyId?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Update details for a malware policy.
  • DELETERemove a malware policy/configs/:configId/versions/:versionNumber/malware-policies/:malwarePolicyId?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Delete a specific malware policy that's not actively in use. To delete an active malware policy, first activate an older configuration…

Shared resources: Custom rules

  • GETList custom rules/configs/:configId/custom-rules?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Lists custom rules defined in a security configuration.
  • POSTCreate a custom rule/configs/:configId/custom-rules?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Creates a new custom rule.
  • GETGet a custom rule/configs/:configId/custom-rules/:ruleId?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Returns the details of a custom rule.
  • PUTModify a custom rule/configs/:configId/custom-rules/:ruleId?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Updates an existing custom rule.
  • DELETERemove a custom rule/configs/:configId/custom-rules/:ruleId?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Deletes a custom rule as long as it isn't activated.
  • POSTList custom rules usage by security policies/configs/:configId/versions/:versionNumber/custom-rules/usage?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Returns a list of security policies using each requested custom rule with a set action (Allow or Deny), if any apply. Skips custom rule IDs…

PII learning

  • GETGet PII learning settings for a configuration/configs/:configId/versions/:versionNumber/advanced-settings/pii-learning?accountSwitchKey=1-5C0YLB:1-8BYUX__Kona Site Defender__, __App & API Protector with the Advanced Security module__ Shows whether PII learning is enabled. This operation applies at the…
  • PUTEnable PII learning settings for a configuration/configs/:configId/versions/:versionNumber/advanced-settings/pii-learning?accountSwitchKey=1-5C0YLB:1-8BYUX__Kona Site Defender__, __App & API Protector with the Advanced Security module__ Turn on PII learning for your API definition. To enable PII learning, submit…

Shared resources: Custom deny actions

  • GETList custom deny actions/configs/:configId/versions/:versionNumber/custom-deny?search=SQL Injection&accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Returns custom deny actions for a specific security configuration version.
  • POSTCreate a custom deny action/configs/:configId/versions/:versionNumber/custom-deny?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Create a new custom deny action for a specific configuration version.
  • GETGet a custom deny action/configs/:configId/versions/:versionNumber/custom-deny/:customDenyId?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Returns the specified custom deny action.
  • PUTModify a custom deny action/configs/:configId/versions/:versionNumber/custom-deny/:customDenyId?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Update details for a specific custom deny action.
  • DELETERemove a custom deny action/configs/:configId/versions/:versionNumber/custom-deny/:customDenyId?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Delete a custom deny action. You can't delete a custom deny action that is actively in use. To delete the custom deny action, first activate…

Bypass network lists

  • GETGet bypass network lists settings/configs/:configId/versions/:versionNumber/bypass-network-lists?accountSwitchKey=1-5C0YLB:1-8BYUX__Web Application Protector__ Lists which network lists are used in the bypass network lists settings. If you want to add or remove IP addresses from the…
  • PUTModify the bypass network lists settings/configs/:configId/versions/:versionNumber/bypass-network-lists?accountSwitchKey=1-5C0YLB:1-8BYUX__Web Application Protector__ Update which network lists to use in the bypass network lists settings. If you want to add or remove IP addresses from the…
  • GETGet the bypass network lists settings for a security policy/configs/:configId/versions/:versionNumber/security-policies/:policyId/bypass-network-lists?accountSwitchKey=1-5C0YLB:1-8BYUX__Web Application Protector__, __App & API Protector__ Lists which network lists are used in the bypass network lists settings. If you want to add or remove…
  • PUTModify the bypass network lists settings for a security policy/configs/:configId/versions/:versionNumber/security-policies/:policyId/bypass-network-lists?accountSwitchKey=1-5C0YLB:1-8BYUX__Web Application Protector__, __App & API Protector__ Update which network lists to use in the bypass network lists settings. If you want to add or remove IP…

Failover hostnames

  • GETList failover hostnames/configs/:configId/failover-hostnames?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Get a list of the failover hostnames in a configuration.

Shared resources: Reputation profiles

  • GETList reputation profiles/configs/:configId/versions/:versionNumber/reputation-profiles?accountSwitchKey=1-5C0YLB:1-8BYUX__Kona Site Defender__, __App & API Protector with the Advanced Security module__ Returns reputation profiles for a specific security configuration version.…
  • POSTCreate a reputation profile/configs/:configId/versions/:versionNumber/reputation-profiles?accountSwitchKey=1-5C0YLB:1-8BYUX__Kona Site Defender__, __App & API Protector with the Advanced Security module__ Create a new reputation profile for a specific configuration version.
  • GETGet a reputation profile/configs/:configId/versions/:versionNumber/reputation-profiles/:reputationProfileId?accountSwitchKey=1-5C0YLB:1-8BYUX__Kona Site Defender__, __App & API Protector with the Advanced Security module__ Returns the details for a specific reputation profile.
  • PUTModify a reputation profile/configs/:configId/versions/:versionNumber/reputation-profiles/:reputationProfileId?accountSwitchKey=1-5C0YLB:1-8BYUX__Kona Site Defender__, __App & API Protector with the Advanced Security module__ Update details for a specific reputation profile.
  • DELETERemove a reputation profile/configs/:configId/versions/:versionNumber/reputation-profiles/:reputationProfileId?accountSwitchKey=1-5C0YLB:1-8BYUX__Kona Site Defender__, __App & API Protector with the Advanced Security module__ Delete a reputation profile. You can't delete a reputation profile that is…

Request body size

  • GETGet request body size settings for a configuration/configs/:configId/versions/:versionNumber/advanced-settings/request-body?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Return request body inspection limit settings for a configuration. Contact your account team if you'd like to run this operation.
  • PUTModify request body inspection limit settings for a configuration/configs/:configId/versions/:versionNumber/advanced-settings/request-body?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Modify request body inspection limit settings for a configuration. Inspect request bodies up to a certain size. In exceptional cases, you can…

General policy settings

  • GETList security policies/configs/:configId/versions/:versionNumber/security-policies?notMatched=true&detail=true&accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Returns a list of security policies available for the specified security configuration.
  • POSTClone or create a security policy/configs/:configId/versions/:versionNumber/security-policies?accountSwitchKey=1-5C0YLB:1-8BYUX__Kona Site Defender__, __App & API Protector with the Advanced Security module__ Creates a new copy of an existing security policy or creates a new security…
  • GETGet a security policy/configs/:configId/versions/:versionNumber/security-policies/:policyId?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Returns the specified security policy.
  • PUTModify a security policy/configs/:configId/versions/:versionNumber/security-policies/:policyId?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Update the name of a specific security policy. Currently, you can only edit a security policy's name with this operation, although other…
  • DELETERemove a security policy/configs/:configId/versions/:versionNumber/security-policies/:policyId?accountSwitchKey=1-5C0YLB:1-8BYUX__Kona Site Defender__, __App & API Protector with the Advanced Security module__ Delete the specified security policy. You can't delete a security policy…

Rate policy actions

  • GETList rate policy actions/configs/:configId/versions/:versionNumber/security-policies/:policyId/rate-policies?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Returns a list of all rate policies currently in use with the actions each policy takes when conditions are met.
  • PUTModify a rate policy action/configs/:configId/versions/:versionNumber/security-policies/:policyId/rate-policies/:ratePolicyId?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Updates the actions in a rate policy.

IP/Geo Firewall settings

  • GETGet IP/Geo Firewall settings/configs/:configId/versions/:versionNumber/security-policies/:policyId/ip-geo-firewall?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Lists which network lists are used in the IP/Geo Firewall settings. In Control Center this method is called mode. In this API the method is…
  • PUTModify IP/Geo Firewall settings/configs/:configId/versions/:versionNumber/security-policies/:policyId/ip-geo-firewall?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Update the method and which network lists to use for IP/Geo firewall blocking. In Control Center this method is called mode. In this API the…

Attack payload logs

  • GETGet the attack payload log settings for a configuration/configs/:configId/versions/:versionNumber/advanced-settings/logging/attack-payload?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Lists attack payload log settings for a configuration. When set to NONE, the request body and response body show as redacted in the log. For…
  • PUTModify attack payload log settings for a configuration/configs/:configId/versions/:versionNumber/advanced-settings/logging/attack-payload?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Enable, disable, or update attack payload log settings for a configuration. When set to NONE, the request body and response body show as…
  • GETGet attack payload logging settings for a policy/configs/:configId/versions/:versionNumber/security-policies/:policyId/advanced-settings/logging/attack-payload?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ List a security policy's settings for attack payload logging. Attack payload logging is on by default, and in most cases you should leave it…
  • PUTModify attack payload logging settings for a policy/configs/:configId/versions/:versionNumber/security-policies/:policyId/advanced-settings/logging/attack-payload?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Update attack payload logging settings for a specific policy. This operation applies at the security policy level, and overrides the attack…

HTTP header logs

  • GETGet the HTTP header log settings for a configuration/configs/:configId/versions/:versionNumber/advanced-settings/logging?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Lists HTTP header logging controls for a configuration. HTTP header logging is on by default, and in most cases you should leave it enabled.…
  • PUTModify HTTP header log settings for a configuration/configs/:configId/versions/:versionNumber/advanced-settings/logging?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Enable, disable, or update HTTP header Logging settings for a configuration. This operation applies at the configuration level, and therefore…
  • GETGet HTTP header log settings/configs/:configId/versions/:versionNumber/security-policies/:policyId/advanced-settings/logging?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ List a security policy's settings for HTTP header logging. HTTP header logging is on by default, and in most cases you should leave it…
  • PUTModify HTTP header log settings/configs/:configId/versions/:versionNumber/security-policies/:policyId/advanced-settings/logging?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Enable, disable, or update HTTP header logging settings for a specific policy. This operation applies at the security policy level, and…

Client reputation

  • GETList reputation profile actions/configs/:configId/versions/:versionNumber/security-policies/:policyId/reputation-profiles?accountSwitchKey=1-5C0YLB:1-8BYUX__Kona Site Defender__, __App & API Protector with the Advanced Security module__ Return a list of reputation profiles with their associated actions.
  • GETGet the action for a reputation profile/configs/:configId/versions/:versionNumber/security-policies/:policyId/reputation-profiles/:reputationProfileId?accountSwitchKey=1-5C0YLB:1-8BYUX__Kona Site Defender__, __App & API Protector with the Advanced Security module__ Return the action a reputation profile takes when triggered.
  • PUTModify the action for a reputation profile/configs/:configId/versions/:versionNumber/security-policies/:policyId/reputation-profiles/:reputationProfileId?accountSwitchKey=1-5C0YLB:1-8BYUX__Kona Site Defender__, __App & API Protector with the Advanced Security module__ Update what action to take when reputation profile's rule triggers. Use…

Custom rule actions

  • GETList custom rule actions/configs/:configId/versions/:versionNumber/security-policies/:policyId/custom-rules?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Returns a list of all configured custom rules for the specified configuration. It includes information for rules that are associated with…
  • PUTModify a custom rule action/configs/:configId/versions/:versionNumber/security-policies/:policyId/custom-rules/:ruleId?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Updates the action of a custom rule.

Reputation analysis

  • GETGet reputation analysis settings/configs/:configId/versions/:versionNumber/security-policies/:policyId/reputation-analysis?accountSwitchKey=1-5C0YLB:1-8BYUX__Kona Site Defender__ Return the current reputation analysis settings.
  • PUTModify reputation analysis settings/configs/:configId/versions/:versionNumber/security-policies/:policyId/reputation-analysis?accountSwitchKey=1-5C0YLB:1-8BYUX__Kona Site Defender__ Toggle the forwardToHTTPHeader and forwardSharedIPToHTTPHeaderAndSIEM options. The forwardToHTTPHeader option adds client reputation…

URL protection policy actions

  • GETList URL protection policy actions/configs/:configId/versions/:versionNumber/security-policies/:policyId/url-protections?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Returns a list of all URL protection policies currently in use, along with the actions each policy takes when conditions are met.
  • PUTModify a URL protection policy action/configs/:configId/versions/:versionNumber/security-policies/:policyId/url-protections/:urlProtectionPolicyId?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Updates the actions in a URL protection policy.

Pragma settings

  • GETGet Pragma settings for a configuration/configs/:configId/versions/:versionNumber/advanced-settings/pragma-header?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Return the Pragma header excluded conditions. By default, the Pragma header is stripped from an operation's response except in cases where…
  • PUTModify Pragma settings for a configuration/configs/:configId/versions/:versionNumber/advanced-settings/pragma-header?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Update the Pragma header excluded conditions. By default, the Pragma header is stripped from an operation's response except in cases where…
  • GETGet Pragma settings for a security policy/configs/:configId/versions/:versionNumber/security-policies/:policyId/advanced-settings/pragma-header?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Return the Pragma header's excluded conditions. By default, the Pragma header debugging information is stripped from an operation's response…
  • PUTModify Pragma settings for a security policy/configs/:configId/versions/:versionNumber/security-policies/:policyId/advanced-settings/pragma-header?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Update the pragma header excluded conditions. By default, the Pragma header debugging information is stripped from an operation's response…

API request constraints

  • GETList API request constraints and actions/configs/:configId/versions/:versionNumber/security-policies/:policyId/api-request-constraints?accountSwitchKey=1-5C0YLB:1-8BYUX__Kona Site Defender__, __App & API Protector with the Advanced Security module__ Return a list of APIs with their constraints and associated actions.
  • PUTModify the request constraint action for all APIs/configs/:configId/versions/:versionNumber/security-policies/:policyId/api-request-constraints?accountSwitchKey=1-5C0YLB:1-8BYUX__Kona Site Defender__, __App & API Protector with the Advanced Security module__ Update what action to take when any API request constraint triggers. Use…
  • PUTModify an API request constraint's action/configs/:configId/versions/:versionNumber/security-policies/:policyId/api-request-constraints/:apiId?accountSwitchKey=1-5C0YLB:1-8BYUX__Kona Site Defender__, __App & API Protector with the Advanced Security module__ Update what action to take when the API request constraint triggers. This…

Evasive path match

  • GETGet evasive path match settings for a configuration/configs/:configId/versions/:versionNumber/advanced-settings/evasive-path-match?accountSwitchKey=1-5C0YLB:1-8BYUX__Web Application Protector__, __Kona Site Defender__ Lists the evasive path match setting for a configuration. Evasive path match is off by default. This…
  • PUTModify evasive path match settings for a configuration/configs/:configId/versions/:versionNumber/advanced-settings/evasive-path-match?accountSwitchKey=1-5C0YLB:1-8BYUX__Web Application Protector__, __Kona Site Defender__ Enable, disable, or update evasive path match settings for a configuration. This operation applies at…
  • GETGet evasive path match settings/configs/:configId/versions/:versionNumber/security-policies/:policyId/advanced-settings/evasive-path-match?accountSwitchKey=1-5C0YLB:1-8BYUX__Web Application Protector__, __Kona Site Defender__ Lists the evasive path match setting for a security policy. Evasive path match is off by default. This…
  • PUTModify evasive path match settings/configs/:configId/versions/:versionNumber/security-policies/:policyId/advanced-settings/evasive-path-match?accountSwitchKey=1-5C0YLB:1-8BYUX__Web Application Protector__, __Kona Site Defender__ Enable, disable, or update evasive path match setting for a security policy. This operation applies at…

Malware policy actions

  • GETList malware policy actions/configs/:configId/versions/:versionNumber/security-policies/:policyId/malware-policies?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Return a list of all malware policies currently in use with the actions each policy takes when conditions are met.
  • PUTModify a malware policy action/configs/:configId/versions/:versionNumber/security-policies/:policyId/malware-policies/:malwarePolicyId?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Update the actions in a malware policy.

Request body inspection limits

  • GETGet request body inspection limit settings for a security policy/configs/:configId/versions/:versionNumber/security-policies/:policyId/advanced-settings/request-body?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Return request body inspection limit settings for a security policy. Contact your account team if you'd like to run this operation.
  • PUTModify request body size settings for a security policy/configs/:configId/versions/:versionNumber/security-policies/:policyId/advanced-settings/request-body?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Update inspection settings for a security policy. Inspect request bodies up to a certain size. In exceptional cases, you can change the…

API endpoints

  • GETList API endpoints/configs/:configId/versions/:versionNumber/security-policies/:policyId/api-endpoints?accountSwitchKey=1-5C0YLB:1-8BYUX__Kona Site Defender__, __App & API Protector with the Advanced Security module__ List the API endpoints associated with a security policy. This operation…

Slow POST protections

  • GETGet slow POST protection settings/configs/:configId/versions/:versionNumber/security-policies/:policyId/slow-post?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Get slow POST protection settings for a specific policy.
  • PUTModify slow POST protection settings/configs/:configId/versions/:versionNumber/security-policies/:policyId/slow-post?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Update slow POST protection settings for a specific policy.

WAF rules: General settings

  • GETList rules/configs/:configId/versions/:versionNumber/security-policies/:policyId/rules?accountSwitchKey=1-5C0YLB:1-8BYUX__Kona Site Defender__, __App & API Protector with the Advanced Security module__ Returns the action taken for each rule in a policy. The action occurs when…
  • PUTUpgrade KRS ruleset/configs/:configId/versions/:versionNumber/security-policies/:policyId/rules?accountSwitchKey=1-5C0YLB:1-8BYUX__Kona Site Defender__, __App & API Protector with the Advanced Security module__, __Adaptive Security Engine__ Upgrade to the most recent version of the KRS…
  • GETGet upgrade details/configs/:configId/versions/:versionNumber/security-policies/:policyId/rules/upgrade-details?accountSwitchKey=1-5C0YLB:1-8BYUX__Kona Site Defender__, __App & API Protector with the Advanced Security module__ Only applies to Kona rule sets. The KRS rule sets are maintained by Akamai's…
  • GETGet the action for a rule/configs/:configId/versions/:versionNumber/security-policies/:policyId/rules/:ruleId?accountSwitchKey=1-5C0YLB:1-8BYUX__Kona Site Defender__, __App & API Protector with the Advanced Security module__ Return the action a rule takes when triggered. This applies to both ASE auto…
  • PUTModify the action for a rule/configs/:configId/versions/:versionNumber/security-policies/:policyId/rules/:ruleId?accountSwitchKey=1-5C0YLB:1-8BYUX__Kona Site Defender__, __App & API Protector with the Advanced Security module__ Update what action a rule takes when it's triggered. This applies to both…
  • GETGet the conditions and exceptions of a rule/configs/:configId/versions/:versionNumber/security-policies/:policyId/rules/:ruleId/condition-exception?accountSwitchKey=1-5C0YLB:1-8BYUX__Kona Site Defender__, __App & API Protector with the Advanced Security module__ List a KRS rule's conditions and exceptions.
  • PUTModify the conditions and exceptions of a rule/configs/:configId/versions/:versionNumber/security-policies/:policyId/rules/:ruleId/condition-exception?accountSwitchKey=1-5C0YLB:1-8BYUX__Kona Site Defender__, __App & API Protector with the Advanced Security module__ Update a rule's conditions and exceptions. When the conditions are met, the…
  • GETGet adaptive intelligence settings/configs/:configId/versions/:versionNumber/security-policies/:policyId/threat-intel?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Returns whether adaptive intelligence is enabled. Adaptive intelligence allows our network to better tune rules for better accuracy. Contact…
  • PUTModify adaptive intelligence settings/configs/:configId/versions/:versionNumber/security-policies/:policyId/threat-intel?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Only applies to Adaptive Security Engine (ASE) manual rule sets. Enable or disable adaptive intelligence. Contact your account team if you'd…
  • GETGet a security policy's rule set/configs/:configId/versions/:versionNumber/security-policies/:policyId/web-application-firewall/ruleset?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Returns the security policy rule set, which includes the version, threat intelligence settings, rules, and attack group details.
  • PATCHModify a security policy's rule set/configs/:configId/versions/:versionNumber/security-policies/:policyId/web-application-firewall/ruleset?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Modify the security policy's rule set including its rule and attack group details.

Protections

  • GETGet protections/configs/:configId/versions/:versionNumber/security-policies/:policyId/protections?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Get the protections and whether they are enabled or disabled in a security policy.
  • PUTModify protections/configs/:configId/versions/:versionNumber/security-policies/:policyId/protections?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Update the security policy protections. This applies a set of protections that you can enable individually.

WAF rules: Penalty box

  • GETGet the penalty box/configs/:configId/versions/:versionNumber/security-policies/:policyId/penalty-box?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Returns the penalty box settings for the security policy you specify.
  • PUTModify the penalty box/configs/:configId/versions/:versionNumber/security-policies/:policyId/penalty-box?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Modifies the penalty box settings for a security policy. When the penalty box is enabled for a policy, clients that trigger a WAF Deny action…

WAF rules: Penalty box conditions

  • GETGet penalty box condition/configs/:configId/versions/:versionNumber/security-policies/:policyId/penalty-box/conditions?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Returns the penalty box condition settings for a security policy.
  • PUTModify the penalty box conditions/configs/:configId/versions/:versionNumber/security-policies/:policyId/penalty-box/conditions?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Modifies the penalty box conditions settings for a security policy.

WAF rules: Tuning recommendations

  • GETGet tuning recommendations for a policy/configs/:configId/versions/:versionNumber/security-policies/:policyId/recommendations?type=ACTIVE&accountSwitchKey=1-5C0YLB:1-8BYUX__Adaptive Security Engine__ Lists available tuning recommendations for a policy. Our system can identify patterns of false positives, and suggests exceptions…
  • POSTRespond to exception recommendations/configs/:configId/versions/:versionNumber/security-policies/:policyId/recommendations?type=ACTIVE&accountSwitchKey=1-5C0YLB:1-8BYUX__Adaptive Security Engine__ Accept, decline, or reset the recommended exception. Accepting a tuning recommendation creates or updates the exception for the…
  • GETList tuning recommendations for an attack group/configs/:configId/versions/:versionNumber/security-policies/:policyId/recommendations/attack-groups/:attackGroupId?type=ACTIVE&accountSwitchKey=1-5C0YLB:1-8BYUX__Adaptive Security Engine__ Returns available tuning recommendations for an attack group. Our system can identify patterns of false positives, and suggests…
  • GETList tuning recommendations for a rule/configs/:configId/versions/:versionNumber/security-policies/:policyId/recommendations/rules/:ruleId?type=ACTIVE&accountSwitchKey=1-5C0YLB:1-8BYUX__Adaptive Security Engine__ Returns available tuning recommendations for a rule. Our system can identify patterns of false positives, and suggests exceptions…

WAF rules: Attack groups

  • GETList attack groups/configs/:configId/versions/:versionNumber/security-policies/:policyId/attack-groups?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Return a list of attack groups with their associated actions.
  • GETGet the action for an attack group/configs/:configId/versions/:versionNumber/security-policies/:policyId/attack-groups/:attackGroupId?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Currently the only field in the response object is action, which displays the action for the attack group.
  • PUTModify the action for an attack group/configs/:configId/versions/:versionNumber/security-policies/:policyId/attack-groups/:attackGroupId?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Update what action to take when an attack group's rule triggers. Use alert to record the trigger of the event, deny to block the request, or…
  • GETGet the exceptions of an attack group/configs/:configId/versions/:versionNumber/security-policies/:policyId/attack-groups/:attackGroupId/condition-exception?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ List an attack group's exceptions.
  • PUTModify the exceptions of an attack group/configs/:configId/versions/:versionNumber/security-policies/:policyId/attack-groups/:attackGroupId/condition-exception?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Update an attack group exceptions.

WAF rules: Update mode

  • GETGet the current mode/configs/:configId/versions/:versionNumber/security-policies/:policyId/mode?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ When using Web Application Firewall in your security policy, this mode conveys how you're planning to keep the rules up to date, either KRS…
  • PUTModify the mode/configs/:configId/versions/:versionNumber/security-policies/:policyId/mode?accountSwitchKey=1-5C0YLB:1-8BYUX__Kona Site Defender__, __App & API Protector with the Advanced Security module__, __Adaptive Security Engine__ The mode you set determines how your rule sets…

WAF rules: Rapid rules

  • GETList rapid rules/configs/:configId/versions/:versionNumber/security-policies/:policyId/rapid-rules?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Returns rapid rules. Rapid rules are WAF rules we are actively testing and refining. You can start using them while we revise them. Once we…
  • GETGet rapid rules' default action/configs/:configId/versions/:versionNumber/security-policies/:policyId/rapid-rules/action?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Returns the default action set for all rapid rules. To override this setting for an individual rule, run Update a rapid rule's action.
  • PUTUpdate rapid rules' default action/configs/:configId/versions/:versionNumber/security-policies/:policyId/rapid-rules/action?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Set rapid rules default action. This applies to _all_ rapid rules by default unless you specifically override this setting for an individual…
  • GETGet rapid rules' status/configs/:configId/versions/:versionNumber/security-policies/:policyId/rapid-rules/status?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Returns whether rapid rules are enabled or disabled.
  • PUTUpdate rapid rules' status/configs/:configId/versions/:versionNumber/security-policies/:policyId/rapid-rules/status?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Enable or disable all rapid rules.
  • GETList a rapid rule's conditions and exceptions/configs/:configId/versions/:versionNumber/security-policies/:policyId/rapid-rules/:ruleId/condition-exception?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Returns the conditions and exceptions set for the rapid rule.
  • PUTUpdate a rapid rule's conditions and exceptions/configs/:configId/versions/:versionNumber/security-policies/:policyId/rapid-rules/:ruleId/condition-exception?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Set the rapid rule's conditions and exceptions.
  • GETGet a rapid rule's lock status/configs/:configId/versions/:versionNumber/security-policies/:policyId/rapid-rules/:ruleId/lock?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Returns the rapid rule lock status. When locked, the action set for the rapid rule applies to all new versions of that rule.
  • PUTUpdate a rapid rule's lock status/configs/:configId/versions/:versionNumber/security-policies/:policyId/rapid-rules/:ruleId/lock?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Set the rapid rule lock status. When enabled, the action set for the rapid rule applies to all new versions of that rule.
  • GETGet a rapid rule's action/configs/:configId/versions/:versionNumber/security-policies/:policyId/rapid-rules/:ruleId/versions/:ruleVersion/action?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Returns the action for a single rapid rule. Run Update a rapid rule's action if you want to set different actions for each rule, or override…
  • PUTUpdate a rapid rule's action/configs/:configId/versions/:versionNumber/security-policies/:policyId/rapid-rules/:ruleId/versions/:ruleVersion/action?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Set the rapid rule's action. Run this operation if you want to set different actions for each rule, or override the default action for a…

Security policy: Conditions and exceptions

  • GETGet the exceptions of an evaluation attack group/configs/:configId/versions/:versionNumber/security-policies/:policyId/eval-groups/:attackGroupId/condition-exception?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ List an attack group's exceptions.
  • PUTModify the exceptions of an evaluation attack group/configs/:configId/versions/:versionNumber/security-policies/:policyId/eval-groups/:attackGroupId/condition-exception?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Update an evaluation attack group exceptions.
  • GETGet the conditions and exceptions for an evaluation rule/configs/:configId/versions/:versionNumber/security-policies/:policyId/eval-rules/:ruleId/condition-exception?accountSwitchKey=1-5C0YLB:1-8BYUX__Kona Site Defender__, __App & API Protector with the Advanced Security module__ List the conditions and exceptions for a rule you want to evaluate. This…
  • PUTModify the conditions and exceptions for an evaluation rule/configs/:configId/versions/:versionNumber/security-policies/:policyId/eval-rules/:ruleId/condition-exception?accountSwitchKey=1-5C0YLB:1-8BYUX__Kona Site Defender__, __App & API Protector with the Advanced Security module__ Update an evaluation rule's conditions and exceptions. When the conditions…

Security policy: Evaluation hostnames

  • GETList evaluation hostnames for a security policy/configs/:configId/versions/:versionNumber/security-policies/:policyId/eval-hostnames?accountSwitchKey=1-5C0YLB:1-8BYUX__Web Application Protector__, __App & API Protector__ List the evaluation hostnames for a configuration version. Evaluation mode for hostnames is only…
  • PUTModify evaluation hostnames for a security policy/configs/:configId/versions/:versionNumber/security-policies/:policyId/eval-hostnames?accountSwitchKey=1-5C0YLB:1-8BYUX__Web Application Protector__, __App & API Protector__ Update the list of hostnames you want to evaluate for a configuration version.
  • PUTProtect evaluation hostnames for a security policy/configs/:configId/versions/:versionNumber/security-policies/:policyId/protect-eval-hostnames?accountSwitchKey=1-5C0YLB:1-8BYUX__Web Application Protector__, __App & API Protector__ Move hostnames you're evaluating to active protection. When you move a hostname from the evaluation…

Security policy: Evaluation mode

  • POSTSet evaluation mode/configs/:configId/versions/:versionNumber/security-policies/:policyId/eval?accountSwitchKey=1-5C0YLB:1-8BYUX__Kona Site Defender__, __App & API Protector with the Advanced Security module__ Evaluation mode runs concurrently with your existing Web Application…

Security policy: Evaluation penalty box

  • GETGet the penalty box for a policy in evaluation mode/configs/:configId/versions/:versionNumber/security-policies/:policyId/eval-penalty-box?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Returns the penalty box settings for a security policy in evaluation mode. When the penalty box is enabled for a policy, clients that trigger…
  • PUTModify the evaluation penalty box/configs/:configId/versions/:versionNumber/security-policies/:policyId/eval-penalty-box?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Update the penalty box settings for a security policy in evaluation mode. If set to true, you can choose to deny requests coming from a…

Security policy: Evaluation rules

  • GETList evaluation rules/configs/:configId/versions/:versionNumber/security-policies/:policyId/eval-rules?accountSwitchKey=1-5C0YLB:1-8BYUX__Kona Site Defender__, __App & API Protector with the Advanced Security module__ Return the rules available for evaluation and their actions.
  • GETGet the action of an evaluation rule/configs/:configId/versions/:versionNumber/security-policies/:policyId/eval-rules/:ruleId?accountSwitchKey=1-5C0YLB:1-8BYUX__Kona Site Defender__, __App & API Protector with the Advanced Security module__ Return the action for a specific rule you want to evaluate. This applies to…
  • PUTModify the action of an evaluation rule/configs/:configId/versions/:versionNumber/security-policies/:policyId/eval-rules/:ruleId?accountSwitchKey=1-5C0YLB:1-8BYUX__Kona Site Defender__, __App & API Protector with the Advanced Security module__ Update the action for a specific rule you want to evaluate. Like your…

Security policy: Evaluation attack groups

  • GETList evaluation attack groups/configs/:configId/versions/:versionNumber/security-policies/:policyId/eval-groups?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Return a list of evaluation attack groups with their associated actions.
  • GETGet the action for an evaluation attack group/configs/:configId/versions/:versionNumber/security-policies/:policyId/eval-groups/:attackGroupId?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Currently the only field in the response object is action, which displays the action for the evaluation attack group.
  • PUTModify the action for an evaluation attack group/configs/:configId/versions/:versionNumber/security-policies/:policyId/eval-groups/:attackGroupId?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Update what action to take when an evaluation attack group's rule triggers. Use alert to record the trigger of the event, deny to block the…

WAF rules: Evaluation Penalty box conditions

  • GETGet penalty box conditions in evaluation mode/configs/:configId/versions/:versionNumber/security-policies/:policyId/eval-penalty-box/conditions?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Returns the penalty box condition settings for a security policy in evaluation mode.
  • PUTModify the penalty box conditions in evaluation mode/configs/:configId/versions/:versionNumber/security-policies/:policyId/eval-penalty-box/conditions?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Modifies the penalty box condition settings for a security policy in evaluation mode.

Configuration: Evaluation hostnames

  • PUTProtect evaluation hostnames/configs/:configId/versions/:versionNumber/protect-eval-hostnames?accountSwitchKey=1-5C0YLB:1-8BYUX__Web Application Protector__, __App & API Protector__ Move hostnames you're evaluating to active protection. When you move a hostname from the evaluation…
  • GETList evaluation hostnames/configs/:configId/versions/:versionNumber/selected-hostnames/eval-hostnames?accountSwitchKey=1-5C0YLB:1-8BYUX__Web Application Protector__, __App & API Protector__ List the evaluation hostnames for a configuration version. Evaluation mode for hostnames is only…
  • PUTModify evaluation hostnames/configs/:configId/versions/:versionNumber/selected-hostnames/eval-hostnames?accountSwitchKey=1-5C0YLB:1-8BYUX__Web Application Protector__, __App & API Protector__ Update the list of hostnames you want to evaluate for a configuration version.

Activations

  • POSTActivate a configuration version/activations?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Activates one or more configurations globally. Note that you need to explicitly list any invalid hosts in the…

Configuration version export

  • POSTAsynchronously export a configuration version/configs/:configId/versions/:versionNumber/export?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Start an asynchronous export of a security configuration version. The response contains an exportId you can use to monitor progress and get…
  • GETGet asynchronous export results/configs/:configId/versions/:versionNumber/export/:exportId/result?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Get a security configuration version's export data from a previously completed asynchronous task. This is only available when the task status…
  • GETGet asynchronous export status/configs/:configId/versions/:versionNumber/export/:exportId/status?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Get a security configuration version's export status. When PENDING, the task is still running. When COMPLETED, the task finished successfully…
  • GETExport a configuration version/export/configs/:configId/versions/:versionNumber?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Returns comprehensive details about a security configuration version. This operation returns more data than Get configuration version…

Activation history

  • GETList activation history/configs/:configId/activations?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Lists the activation history for a configuration. The history is an array in descending order of submitDate. The most recent submitted…

Activation status

  • GETGet an activation request status/activations/status/:statusId?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Returns the status of a long-running activation request. Any errors that occur when generating the activation cause this API to respond with…
  • GETGet activation status/activations/:activationId?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Returns the status of an activation.

Discovered APIs

  • GETList discovered APIs/api-discovery?includeHidden=true&search=www.example.com&accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ List APIs discovered in your traffic that are new or not yet protected under API protections. An API is considered new if it isn't…
  • GETGet a discovered API/api-discovery/host/:hostname/basepath/:basePath?includeHidden=true&search=SQL Injection&accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Returns details about an API discovered in account traffic. It is identified based on hostname and basepath.

Subscriptions

  • GETList subscribers/configs/:configId/notification/subscription/:feature?accountSwitchKey=1-5C0YLB:1-8BYUX__Kona Site Defender__ List all subscribers to a security configuration's feature. The response array is empty if there are no subscribers. Currently…
  • POSTSubscribe or unsubscribe to recommendation emails/configs/:configId/notification/subscription/:feature?accountSwitchKey=1-5C0YLB:1-8BYUX__Kona Site Defender__ Set the request object's action to subscribe to add user emails to the subscription object. Use unsubscribe to remove them from the…

Endpoints

  • PUTModify an API's visibility/api-discovery/host/:hostname/basepath/:basePath?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Hide or show an API. You can choose to include or exclude APIs from the Get discovered APIs response. This operation is per-user. If you hide…
  • GETList discovered API endpoints/api-discovery/host/:hostname/basepath/:basePath/endpoints?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Returns API endpoints for the specified hostname and base path. Unlike Get discovered APIs, this operation returns APIs already in your API…
  • POSTCreate an endpoint or resource/api-discovery/host/:hostname/basepath/:basePath/endpoints?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Create a new API endpoint or add a resource to an existing endpoint. When you run this operation to add a new resource to an existing API,…

Contracts and groups

  • GETList contracts and groups/contracts-groups?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ List the contracts and groups for your account. Each object contains the contract, groups associated with the contract, and whether Kona Site…

Available hostnames

  • GETList available hostnames for a new configuration/contracts/:contractId/groups/:groupId/selectable-hostnames?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Lists the hostnames for a given contract and group. Use this operation for a new configuration, and use List selectable hostnames to see a…

Hostname coverage

  • GETGet hostname coverage/hostname-coverage?accountSwitchKey=1-5C0YLB:1-8BYUX__Kona Site Defender__, __App & API Protector with the Advanced Security module__ Get the list of hostnames in the account with their current protections,…

CVE Protections lookup

  • GETList CVEs/cves?modifiedAfter=2023-10-22T14:30:45Z&accountSwitchKey=1-5C0YLB:1-8BYUXList CVEs currently in Akamai's CVE catalog. The catalog contains only CVEs the Akamai Threat Research team is aware of. App & API Protector can identify and…
  • POSTSubscribe to CVEs/cves/subscribe?accountSwitchKey=1-5C0YLB:1-8BYUXSubscribe to notifications for specific CVEs.
  • GETList subscribed CVEs/cves/subscribed?accountSwitchKey=1-5C0YLB:1-8BYUXList the CVEs you are subscribed to. To add or remove CVEs, run Subscribe to CVEs or Unsubscribe from CVEs accordingly.
  • POSTUnsubscribe from CVEs/cves/unsubscribe?all=true&accountSwitchKey=1-5C0YLB:1-8BYUXUnsubscribe from notifications about all CVEs, or specific CVEs.
  • GETGet a CVE/cves/:cveId?accountSwitchKey=1-5C0YLB:1-8BYUXGet details for a specific CVE.
  • GETGet CVE coverage/cves/:cveId/security-coverage?accountSwitchKey=1-5C0YLB:1-8BYUXThe coverages provided by your configurations, attack groups, and rules.

Onboarding: Creation and settings

  • GETList onboardings/onboardings?onboardingStatuses=VALIDATION_PENDING,COMPLETE&hostnames=test.hostname1.com,test.hostname2.com&accountSwitchKey=1-5C0YLB:1-8BYUX__App & API Protector__, __App & API Protector with the Advanced Security module__ Lists onboardings. You can filter results by hostname or onboarding status.
  • POSTCreate an onboarding/onboardings?createNewResourcesOnly=true&accountSwitchKey=1-5C0YLB:1-8BYUX__App & API Protector__, __App & API Protector with the Advanced Security module__ Create a new onboarding. To start, you'll need a valid set of hostnames…
  • GETGet an onboarding/onboardings/:onboardingId?accountSwitchKey=1-5C0YLB:1-8BYUX__App & API Protector__, __App & API Protector with the Advanced Security module__ Get an onboarding's details. Once you've completed all steps in the…
  • DELETEDelete an onboarding/onboardings/:onboardingId?accountSwitchKey=1-5C0YLB:1-8BYUX__App & API Protector__, __App & API Protector with the Advanced Security module__ Delete a specific onboarding. You can't delete an onboarding that has an…
  • GETGet onboarding settings/onboardings/:onboardingId/settings?accountSwitchKey=1-5C0YLB:1-8BYUX__App & API Protector__, __App & API Protector with the Advanced Security module__ Gets the settings for a specific onboarding.
  • PUTModify onboarding settings/onboardings/:onboardingId/settings?accountSwitchKey=1-5C0YLB:1-8BYUX__App & API Protector__, __App & API Protector with the Advanced Security module__ Update the settings in an onboarding. You can't update settings for an…

Onboarding: Activations and status

  • POSTActivate an onboarding/onboardings/:onboardingId/activations?accountSwitchKey=1-5C0YLB:1-8BYUX__App & API Protector__, __App & API Protector with the Advanced Security module__ Activate an onboarding on the staging or production networks. You need to…
  • GETGet an onboarding activation/onboardings/:onboardingId/activations/:activationId?accountSwitchKey=1-5C0YLB:1-8BYUX__App & API Protector__, __App & API Protector with the Advanced Security module__ Returns the status of an activation. Activations can take about 20 minutes.…

Onboarding: Post-activation validation

  • GETList onboarding certificate challenges/onboardings/:onboardingId/certificate-validation?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Returns the information you need to validate your certificate. Add the TXT DNS record listed in the response to your DNS record. Adding the…
  • POSTValidate onboarding certificate/onboardings/:onboardingId/certificate-validation/validate?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Validates the certificate's TXT DNS record. Once validation completes, it takes about five minutes to deploy the certificates across Akamai's…
  • GETList hostname CNAME DNS records/onboardings/:onboardingId/cname-to-akamai?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Returns the DNS records you need to CNAME to Akamai. Once you update your CNAME record with the information in this call's response, your end…
  • POSTValidate hostname CNAME DNS records/onboardings/:onboardingId/cname-to-akamai/validate?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Validates your site is ready to serve traffic. Call this operation after you've replaced the DNS entry that directs traffic to your site with…
  • GETList onboarding domain challenges/onboardings/:onboardingId/domain-validation?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Returns the information you need to validate your domains. Add the TXT or CNAME value listed in the response to your DNS record. Adding the…
  • POSTValidate onboarding domains/onboardings/:onboardingId/domain-validation/validate?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Verifies the domain validation challenges. You can validate with HTTP token, DNS records, or URL redirect.
  • GETList origin hostname DNS records/onboardings/:onboardingId/origin-validation?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Lists the DNS records for your origin. Once you make this call, visit your DNS provider account and create a new DNS type A record with the…
  • POSTSkip origin hostnames DNS record validation/onboardings/:onboardingId/origin-validation/skip?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Skips the validation of A DNS record. In the rare case that you changed your origin values outside this onboarding, you can choose not to…
  • POSTValidate origin hostnames DNS records/onboardings/:onboardingId/origin-validation/validate?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Validates the A DNS record you entered into your DNS record. In the rare case that you changed your origin values outside this setup, you can…

Configuration version diff

  • POSTCompare two versions/configs/:configId/versions/diff?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ This operation shows you differences between configuration versions. The to version is relative to the from version, and the versions you…

Cookie Settings

  • GETGet cookie settings/configs/:configId/versions/:versionNumber/advanced-settings/cookie-settings?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Returns cookie settings for a configuration. Contact your account team if you'd like to run this operation.
  • PUTModify cookie settings/configs/:configId/versions/:versionNumber/advanced-settings/cookie-settings?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Modify cookie settings for a configuration. Contact your account team if you'd like to run this operation.

JA4 Client TLS Fingerprint

  • GETGet JA4 client TLS fingerprint settings/configs/:configId/versions/:versionNumber/advanced-settings/ja4-fingerprint?accountSwitchKey=1-5C0YLB:1-8BYUX__Beta__, __Web Application Protector__, __Kona Site Defender__ Return JA4 client TLS fingerprint settings for a configuration. JA4 is a client-focused…
  • PUTModify JA4 client TLS fingerprint settings/configs/:configId/versions/:versionNumber/advanced-settings/ja4-fingerprint?accountSwitchKey=1-5C0YLB:1-8BYUX__Beta__, __Web Application Protector__, __Kona Site Defender__ Update JA4 client TLS fingerprint settings for a configuration.

Behavioral DDoS profiles

  • GETList Behavioral DDoS profiles/configs/:configId/versions/:versionNumber/behavioral-ddos?accountSwitchKey=1-5C0YLB:1-8BYUXReturns all Behavioral DDoS profiles for a specific security configuration version. _Products:_ All.
  • POSTCreate a Behavioral DDoS profile/configs/:configId/versions/:versionNumber/behavioral-ddos?accountSwitchKey=1-5C0YLB:1-8BYUXCreates a new Behavioral DDoS profile for a specific configuration version. _Products:_ All.
  • DELETERemove a Behavioral DDoS profile/configs/:configId/versions/:versionNumber/behavioral-ddos/:profileId?accountSwitchKey=1-5C0YLB:1-8BYUXDeletes the specified Behavioral DDoS profile. You can't delete a Behavioral DDoS profile that's actively in use. To delete an active Behavioral DDoS profile,…

Behavioral DDoS protection profiles

  • GETGet a Behavioral DDoS profile/configs/:configId/versions/:versionNumber/behavioral-ddos/:profileId?accountSwitchKey=1-5C0YLB:1-8BYUXReturns the specified Behavioral DDoS profile. _Products:_ All.
  • PUTModify a Behavioral DDoS profile/configs/:configId/versions/:versionNumber/behavioral-ddos/:profileId?accountSwitchKey=1-5C0YLB:1-8BYUXUpdates the specified Behavioral DDoS profile. _Products:_ All.

Challenge actions

  • GETList challenge actions/configs/:configId/versions/:versionNumber/response-actions/challenge-actions?accountSwitchKey=1-5C0YLB:1-8BYUXList all of your challenge actions along with their names, challenge types, and other summary information.
  • POSTCreate a challenge action/configs/:configId/versions/:versionNumber/response-actions/challenge-actions?accountSwitchKey=1-5C0YLB:1-8BYUXCreate a new challenge action. Use this action type to insert a challenge, like a CAPTCHA, into the user workflow. You can also apply your own branding to the…
  • GETGet a challenge action/configs/:configId/versions/:versionNumber/response-actions/challenge-actions/:actionId?accountSwitchKey=1-5C0YLB:1-8BYUXView details about the specified challenge action.
  • PUTUpdate a challenge action/configs/:configId/versions/:versionNumber/response-actions/challenge-actions/:actionId?accountSwitchKey=1-5C0YLB:1-8BYUXEdit the specified challenge action, such as the name, type of challenge, or branding.
  • DELETEDelete a challenge action/configs/:configId/versions/:versionNumber/response-actions/challenge-actions/:actionId?accountSwitchKey=1-5C0YLB:1-8BYUXRemove the specified challenge action.
  • PUTUpdate Google reCAPTCHA secret key/configs/:configId/versions/:versionNumber/response-actions/challenge-actions/:actionId/google-recaptcha-secret-key?accountSwitchKey=1-5C0YLB:1-8BYUXSpecify a different Google reCAPTCHA secret key for a challenge action. The secret key authorizes communication between your site and the reCAPTCHA server.

Behavioral DDoS profile actions

  • GETList Behavioral DDoS profile actions/configs/:configId/versions/:versionNumber/security-policies/:policyId/behavioral-ddos?accountSwitchKey=1-5C0YLB:1-8BYUXReturns a list of all Behavioral DDoS profiles currently in use, along with the actions each profile takes when conditions are met. _Products:_ All.
  • PUTModify a Behavioral DDoS profile action/configs/:configId/versions/:versionNumber/security-policies/:policyId/behavioral-ddos/:profileId?accountSwitchKey=1-5C0YLB:1-8BYUXUpdates the actions in a Behavioral DDoS profile. _Products:_ All.

Client-Side Protections & Compliance

  • GETGet Client-Side Protection & Compliance settings/configs/:configId/versions/:versionNumber/security-policies/:policyId/cpc?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Get Client-Side Protection & Compliance settings for a specific policy. For more information, see Client-side Protection & Compliance
  • PUTModify Client-Side Protections & Compliance settings/configs/:configId/versions/:versionNumber/security-policies/:policyId/cpc?accountSwitchKey=1-5C0YLB:1-8BYUX__All products__ Update Client-Side Protection & Compliance settings for a specific policy.

API details

Base URL
https://{hostname}/appsec/v1
Authentication
None declared in the description
Operations
236 operations on 144 pathsGET 120PUT 73POST 29DELETE 13PATCH 1
Main resources
General configuration settings 11WAF rules: General settings 11WAF rules: Rapid rules 11Onboarding: Post-activation validation 9Match targets 7CVE Protections lookup 6Challenge actions 6Hostnames 6Onboarding: Creation and settings 6Shared resources: Custom rules 6
Response formats
application/problem+json application/json
Description format
OpenAPI 3.0.0, API version v1

How to test the Akamai: Application Security API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Akamai: Application Security API collection, without the publisher's secrets.
  3. Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
  4. Send a requestPick an endpoint, for example “List configurations” (GET /configs?accountSwitchKey=1-5C0YLB:1-8BYUX), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Akamai: Application Security API?

Manage your configurations for Kona Site Defender, Web Application Protector, and Client Reputation. It is listed under Developer tools and has 236 endpoints.

Who publishes the Akamai: Application Security API?

It is listed from Akamai's public API description (an OpenAPI document), not published by Akamai on Swastik Codes. Anyone who controls akamai.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Akamai: Application Security API?

Requests go to https://{hostname}/appsec/v1. Endpoint paths are added to this base URL.

How do I authenticate with the Akamai: Application Security API?

Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.

How many endpoints does the Akamai: Application Security API have?

236 operations on 144 paths (120 GET, 73 PUT, 29 POST, 13 DELETE, 1 PATCH). The largest groups are General configuration settings, WAF rules: General settings, WAF rules: Rapid rules, Onboarding: Post-activation validation.

Is forking the Akamai: Application Security API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.