{
  "opencollection": "1.0.0",
  "info": {
    "name": "Akamai: API Endpoint Definition Access tokens WAF rules: General settings API",
    "version": "2"
  },
  "items": [
    {
      "info": {
        "name": "WAF rules: General settings",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List rules",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{hostname}/api-definitions/v2/configs/:configId/versions/:versionNumber/security-policies/:policyId/rules",
            "params": [
              {
                "name": "configId",
                "value": "",
                "type": "path",
                "description": "A unique identifier for each configuration."
              },
              {
                "name": "versionNumber",
                "value": "",
                "type": "path",
                "description": "A unique identifier for each version of a configuration."
              },
              {
                "name": "policyId",
                "value": "",
                "type": "path",
                "description": "A unique identifier for a security policy."
              },
              {
                "name": "accountSwitchKey",
                "value": "",
                "type": "query",
                "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)."
              }
            ]
          },
          "docs": "__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 the rules are triggered by a request. These are not the same rules as Custom Rules that you configure yourself. These rules are maintained by Akamai."
        },
        {
          "info": {
            "name": "Upgrade KRS ruleset",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{hostname}/api-definitions/v2/configs/:configId/versions/:versionNumber/security-policies/:policyId/rules",
            "params": [
              {
                "name": "configId",
                "value": "",
                "type": "path",
                "description": "A unique identifier for each configuration."
              },
              {
                "name": "versionNumber",
                "value": "",
                "type": "path",
                "description": "A unique identifier for each version of a configuration."
              },
              {
                "name": "policyId",
                "value": "",
                "type": "path",
                "description": "A unique identifier for a security policy."
              },
              {
                "name": "accountSwitchKey",
                "value": "",
                "type": "query",
                "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "__Kona Site Defender__, __App & API Protector with the Advanced Security module__, __Adaptive Security Engine__ Upgrade to the most recent version of the KRS rule set. Akamai periodically updates these rules to keep protections current. However, the rules you use in your security policies do not automatically upgrade to the latest version when setting `mode` to `KRS`. These rules do update automatically when you have `mode` set to `AAG`. Before you upgrade, run [Get upgrade details](https://tech"
        },
        {
          "info": {
            "name": "Get upgrade details",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{hostname}/api-definitions/v2/configs/:configId/versions/:versionNumber/security-policies/:policyId/rules/upgrade-details",
            "params": [
              {
                "name": "configId",
                "value": "",
                "type": "path",
                "description": "A unique identifier for each configuration."
              },
              {
                "name": "versionNumber",
                "value": "",
                "type": "path",
                "description": "A unique identifier for each version of a configuration."
              },
              {
                "name": "policyId",
                "value": "",
                "type": "path",
                "description": "A unique identifier for a security policy."
              },
              {
                "name": "accountSwitchKey",
                "value": "",
                "type": "query",
                "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)."
              }
            ]
          },
          "docs": "__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 security research team. Run this operation before you upgrade to verify changes in the rule sets. If you want to test how the updates affect your site, you can run the updated rules in evaluation mode."
        },
        {
          "info": {
            "name": "Get the action for a rule",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{hostname}/api-definitions/v2/configs/:configId/versions/:versionNumber/security-policies/:policyId/rules/:ruleId",
            "params": [
              {
                "name": "configId",
                "value": "",
                "type": "path",
                "description": "A unique identifier for each configuration."
              },
              {
                "name": "versionNumber",
                "value": "",
                "type": "path",
                "description": "A unique identifier for each version of a configuration."
              },
              {
                "name": "policyId",
                "value": "",
                "type": "path",
                "description": "A unique identifier for a security policy."
              },
              {
                "name": "ruleId",
                "value": "",
                "type": "path",
                "description": "A unique identifier for rule."
              },
              {
                "name": "accountSwitchKey",
                "value": "",
                "type": "query",
                "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)."
              }
            ]
          },
          "docs": "__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 and ASE manual upgrade modes. Rule actions for `ASE_AUTO` are currently in beta. Contact your account team to access this option."
        },
        {
          "info": {
            "name": "Modify the action for a rule",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{hostname}/api-definitions/v2/configs/:configId/versions/:versionNumber/security-policies/:policyId/rules/:ruleId",
            "params": [
              {
                "name": "configId",
                "value": "",
                "type": "path",
                "description": "A unique identifier for each configuration."
              },
              {
                "name": "versionNumber",
                "value": "",
                "type": "path",
                "description": "A unique identifier for each version of a configuration."
              },
              {
                "name": "policyId",
                "value": "",
                "type": "path",
                "description": "A unique identifier for a security policy."
              },
              {
                "name": "ruleId",
                "value": "",
                "type": "path",
                "description": "A unique identifier for rule."
              },
              {
                "name": "accountSwitchKey",
                "value": "",
                "type": "query",
                "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "__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 ASE auto and ASE manual upgrade modes. Rule actions for `ASE_AUTO` are currently in beta. Contact your account team to access this option. Use `alert` to record the trigger of the event, `deny` to block the request, or `none` to take no action."
        },
        {
          "info": {
            "name": "Get the conditions and exceptions of a rule",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{hostname}/api-definitions/v2/configs/:configId/versions/:versionNumber/security-policies/:policyId/rules/:ruleId/condition-exception",
            "params": [
              {
                "name": "configId",
                "value": "",
                "type": "path",
                "description": "A unique identifier for each configuration."
              },
              {
                "name": "versionNumber",
                "value": "",
                "type": "path",
                "description": "A unique identifier for each version of a configuration."
              },
              {
                "name": "policyId",
                "value": "",
                "type": "path",
                "description": "A unique identifier for a security policy."
              },
              {
                "name": "ruleId",
                "value": "",
                "type": "path",
                "description": "A unique identifier for rule."
              },
              {
                "name": "accountSwitchKey",
                "value": "",
                "type": "query",
                "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)."
              }
            ]
          },
          "docs": "__Kona Site Defender__, __App & API Protector with the Advanced Security module__ List a KRS rule's conditions and exceptions."
        },
        {
          "info": {
            "name": "Modify the conditions and exceptions of a rule",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{hostname}/api-definitions/v2/configs/:configId/versions/:versionNumber/security-policies/:policyId/rules/:ruleId/condition-exception",
            "params": [
              {
                "name": "configId",
                "value": "",
                "type": "path",
                "description": "A unique identifier for each configuration."
              },
              {
                "name": "versionNumber",
                "value": "",
                "type": "path",
                "description": "A unique identifier for each version of a configuration."
              },
              {
                "name": "policyId",
                "value": "",
                "type": "path",
                "description": "A unique identifier for a security policy."
              },
              {
                "name": "ruleId",
                "value": "",
                "type": "path",
                "description": "A unique identifier for rule."
              },
              {
                "name": "accountSwitchKey",
                "value": "",
                "type": "query",
                "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "__Kona Site Defender__, __App & API Protector with the Advanced Security module__ Update a rule's conditions and exceptions. When the conditions are met, the rule's actions are ignored and _not_ applied to that specific traffic."
        },
        {
          "info": {
            "name": "Get adaptive intelligence settings",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{hostname}/api-definitions/v2/configs/:configId/versions/:versionNumber/security-policies/:policyId/threat-intel",
            "params": [
              {
                "name": "configId",
                "value": "",
                "type": "path",
                "description": "A unique identifier for each configuration."
              },
              {
                "name": "versionNumber",
                "value": "",
                "type": "path",
                "description": "A unique identifier for each version of a configuration."
              },
              {
                "name": "policyId",
                "value": "",
                "type": "path",
                "description": "A unique identifier for a security policy."
              },
              {
                "name": "accountSwitchKey",
                "value": "",
                "type": "query",
                "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)."
              }
            ]
          },
          "docs": "__All products__ Returns whether adaptive intelligence is enabled. Adaptive intelligence allows our network to better tune rules for better accuracy. Contact your account team if you'd like to run this operation."
        },
        {
          "info": {
            "name": "Modify adaptive intelligence settings",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{hostname}/api-definitions/v2/configs/:configId/versions/:versionNumber/security-policies/:policyId/threat-intel",
            "params": [
              {
                "name": "configId",
                "value": "",
                "type": "path",
                "description": "A unique identifier for each configuration."
              },
              {
                "name": "versionNumber",
                "value": "",
                "type": "path",
                "description": "A unique identifier for each version of a configuration."
              },
              {
                "name": "policyId",
                "value": "",
                "type": "path",
                "description": "A unique identifier for a security policy."
              },
              {
                "name": "accountSwitchKey",
                "value": "",
                "type": "query",
                "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "__All products__ Only applies to Adaptive Security Engine (ASE) manual rule sets. Enable or disable adaptive intelligence. Contact your account team if you'd like to run this operation."
        },
        {
          "info": {
            "name": "Get a security policy's rule set",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{hostname}/api-definitions/v2/configs/:configId/versions/:versionNumber/security-policies/:policyId/web-application-firewall/ruleset",
            "params": [
              {
                "name": "configId",
                "value": "",
                "type": "path",
                "description": "A unique identifier for each configuration."
              },
              {
                "name": "versionNumber",
                "value": "",
                "type": "path",
                "description": "A unique identifier for each version of a configuration."
              },
              {
                "name": "policyId",
                "value": "",
                "type": "path",
                "description": "A unique identifier for a security policy."
              },
              {
                "name": "accountSwitchKey",
                "value": "",
                "type": "query",
                "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)."
              }
            ]
          },
          "docs": "__All products__ Returns the security policy rule set, which includes the version, threat intelligence settings, rules, and attack group details."
        },
        {
          "info": {
            "name": "Modify a security policy's rule set",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://{hostname}/api-definitions/v2/configs/:configId/versions/:versionNumber/security-policies/:policyId/web-application-firewall/ruleset",
            "params": [
              {
                "name": "configId",
                "value": "",
                "type": "path",
                "description": "A unique identifier for each configuration."
              },
              {
                "name": "versionNumber",
                "value": "",
                "type": "path",
                "description": "A unique identifier for each version of a configuration."
              },
              {
                "name": "policyId",
                "value": "",
                "type": "path",
                "description": "A unique identifier for a security policy."
              },
              {
                "name": "accountSwitchKey",
                "value": "",
                "type": "query",
                "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "__All products__ Modify the security policy's rule set including its rule and attack group details."
        }
      ]
    }
  ],
  "bundled": true
}