{
  "opencollection": "1.0.0",
  "info": {
    "name": "Akamai: API Endpoint Definition Access tokens WAF rules: Tuning recommendations API",
    "version": "2"
  },
  "items": [
    {
      "info": {
        "name": "WAF rules: Tuning recommendations",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get tuning recommendations for a policy",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{hostname}/api-definitions/v2/configs/:configId/versions/:versionNumber/security-policies/:policyId/recommendations",
            "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": "type",
                "value": "",
                "type": "query",
                "description": "__Enum__ If `ACTIVE`, includes only active recommendations, the default. If `EVALUATION`, includes only evaluation recommendations. If `ALL`, includes both active and evaluation recommendations."
              },
              {
                "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": "__Adaptive Security Engine__ Lists available tuning recommendations for a policy. Our system can identify patterns of false positives, and suggests exceptions for you to include in your policy."
        },
        {
          "info": {
            "name": "Respond to exception recommendations",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{hostname}/api-definitions/v2/configs/:configId/versions/:versionNumber/security-policies/:policyId/recommendations",
            "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": "type",
                "value": "",
                "type": "query",
                "description": "__Enum__ If `ACTIVE`, includes only active recommendations, the default. If `EVALUATION`, includes only evaluation recommendations. If `ALL`, includes both active and evaluation recommendations."
              },
              {
                "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": "__Adaptive Security Engine__ Accept, decline, or reset the recommended exception. Accepting a tuning recommendation creates or updates the exception for the attack group. Use `reset` to restore a declined recommendation to a neutral state so you can accept it or decline it again later."
        },
        {
          "info": {
            "name": "List tuning recommendations for an attack group",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{hostname}/api-definitions/v2/configs/:configId/versions/:versionNumber/security-policies/:policyId/recommendations/attack-groups/:attackGroupId",
            "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": "attackGroupId",
                "value": "",
                "type": "path",
                "description": "A unique identifier for each attack group."
              },
              {
                "name": "type",
                "value": "",
                "type": "query",
                "description": "__Enum__ If `ACTIVE`, includes only active recommendations, the default. If `EVALUATION`, includes only evaluation recommendations. If `ALL`, includes both active and evaluation recommendations."
              },
              {
                "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": "__Adaptive Security Engine__ Returns available tuning recommendations for an attack group. Our system can identify patterns of false positives, and suggests exceptions for you to include in your attack group."
        },
        {
          "info": {
            "name": "List tuning recommendations for a rule",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{hostname}/api-definitions/v2/configs/:configId/versions/:versionNumber/security-policies/:policyId/recommendations/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": "type",
                "value": "",
                "type": "query",
                "description": "__Enum__ If `ACTIVE`, includes only active recommendations, the default. If `EVALUATION`, includes only evaluation recommendations. If `ALL`, includes both active and evaluation recommendations."
              },
              {
                "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": "__Adaptive Security Engine__ Returns available tuning recommendations for a rule. Our system can identify patterns of false positives, and suggests exceptions for you to include in your rule. In cases where your rules are already optimum, the response payload returns empty."
        }
      ]
    }
  ],
  "bundled": true
}