Akamai · Example Payload
Akamai Get Recommendations Example

CDNCloudEdge ComputingNetworksPlatformSecurity
Akamai Get Recommendations Example is an example object payload from Akamai, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.
Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples
Example Payload

{
  "operationId": "get-recommendations",
  "method": "GET",
  "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/recommendations",
  "summary": "Get tuning recommendations for a policy",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "attackGroupRecommendations": [
          {
            "group": "CMD",
            "recommendations": [
              {
                "description": "This selector triggered on 3458 unique IPs over a period of 7 hours.",
                "exceptions": [
                  {
                    "selector": {
                      "enhanced": false,
                      "names": [
                        "WWW-Exc_Header",
                        "WWW-Auth"
                      ],
                      "numberOfExceptions": 2,
                      "selector": "REQUEST_HEADERS",
                      "type": "AAG_SPECIFIC",
                      "wildcard": false
                    },
                    "selectorId": 77
                  }
                ],
                "ruleSetType": "ACTIVE"
              }
            ]
          },
          {
            "group": "SQL",
            "recommendations": [
              {
                "description": "Recommendation for SQL",
                "exceptions": [
                  {
                    "selector": {
                      "enhanced": false,
                      "names": [
                        "test"
                      ],
                      "numberOfExceptions": 1,
                      "selector": "ARGS_NAMES",
                      "type": "AAG_SPECIFIC",
                      "wildcard": true
                    },
                    "selectorId": 76
                  }
                ],
                "ruleSetType": "EVALUATION"
              }
            ]
          }
        ],
        "evaluationPeriodEnd": "2021-05-08T03:10:43Z",
        "evaluationPeriodStart": "2021-04-08T03:10:43Z",
        "ruleRecommendations": [
          {
            "declinedRecommendations": [
              {
                "description": "100001 recommendation",
                "exceptions": [
                  {
                    "selector": {
                      "enhanced": false,
                      "names": [
                        "XML-PAIR-02-TEST"
                      ],
                      "selector": "XML_PAIRS",
                      "type": "AAG_SPECIFIC",
                      "wildcard": true
                    },
                    "selectorId": 19557
                  }
                ],
                "ruleSetType": "ACTIVE"
              }
            ],
            "id": 100001,
            "recommendations": [
              {
                "description": "Description for SQL",
                "exceptions": [
                  {
                    "selector": {
                      "enhanced": false,
                      "names": [
                        "JSON_PAIR_001"
                      ],
                      "selector": "JSON_PAIRS",
                      "type": "AAG_SPECIFIC",
                      "wildcard": true
                    },
                    "selectorId": 84220
                  }
                ],
                "ruleSetType": "EVALUATION"
              }
            ]
          }
        ]
      }
    },
    {
      "status": "400",
      "contentType": "application/problem+json",
      "example": {
        "detail": "The request could not be understood by the server due to malformed syntax.",
        "instance": "https://problems.luna.akamaiapis.net/appsec/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749",
        "status": 400,
        "title": "Bad Request",
        "type": "https://problems.luna.akamaiapis.net/appsec/error-types/BAD-REQUEST"
      }
    },
    {
      "status": "403",
      "contentType": "application/problem+json",
      "example": {
        "detail": "You do not have the necessary access to perform this operation or the requested resource cannot be modified",
        "instance": "https://problems.luna.akamaiapis.net/appsec/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749",
        "status": 403,
        "title": "Forbidden",
        "type": "https://problems.luna.akamaiapis.net/appsec-resource/error-types/ACCESS-DENIED"
      }
    },
    {
      "status": "404",
      "contentType": "application/problem+json",
      "example": {
        "detail": "The requested resource is not found",
        "instance": "https://problems.luna.akamaiapis.net/appsec/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749",
        "status": 404,
        "title": "Not Found",
        "type": "https://problems.luna.akamaiapis.net/appsec/error-types/NOT-FOUND"
      }
    }
  ]
}