Akamai · Example Payload

Akamai Get Match Targets Example

CDNCloudEdge ComputingNetworksPlatformSecurity

Akamai Get Match Targets 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

Raw ↑ 
{
  "operationId": "get-match-targets",
  "method": "GET",
  "path": "/configs/{configId}/versions/{versionNumber}/match-targets",
  "summary": "List match targets",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "matchTargets": {
          "apiTargets": [
            {
              "apis": [
                {
                  "id": 1111,
                  "name": "API Endpoint 1"
                },
                {
                  "id": 2222,
                  "name": "API Endpoint 2"
                }
              ],
              "bypassNetworkLists": [
                {
                  "id": "522825_CCCBYPASSLIST",
                  "name": "Example network list 11"
                },
                {
                  "id": "1622566_XXAABYPASSL",
                  "name": "Example network list 12"
                }
              ],
              "configId": 77653,
              "configVersion": 25,
              "effectiveSecurityControls": {
                "applyApiConstraints": true,
                "applyApplicationLayerControls": true,
                "applyBotmanControls": false,
                "applyNetworkLayerControls": true,
                "applyRateControls": true,
                "applyReputationControls": true,
                "applySlowPostControls": false
              },
              "securityPolicy": {
                "policyId": "ancv_1234"
              },
              "sequence": 3,
              "targetId": 1222208,
              "type": "api"
            }
          ],
          "websiteTargets": [
            {
              "bypassNetworkLists": [
                {
                  "id": "222825_AAABYPASSLIST",
                  "name": "Example network list 21"
                },
                {
                  "id": "2622566_YYAABYPASSL",
                  "name": "Example network list 22"
                }
              ],
              "configId": 77653,
              "configVersion": 25,
              "defaultFile": "NO_MATCH",
              "effectiveSecurityControls": {
                "applyApiConstraints": false,
                "applyApplicationLayerControls": true,
                "applyBotmanControls": true,
                "applyNetworkLayerControls": true,
                "applyRateControls": true,
                "applyReputationControls": true,
                "applySlowPostControls": false
              },
              "fileExtensions": [
                "html"
              ],
              "filePaths": [
                "/*"
              ],
              "hostnames": [],
              "isNegativeFileExtensionMatch": false,
              "isNegativePathMatch": false,
              "securityPolicy": {
                "policyId": "ancv_1234"
              },
              "sequence": 1,
              "targetId": 1221059,
              "type": "website"
            },
            {
              "bypassNetworkLists": [],
              "configId": 77653,
              "configVersion": 25,
              "defaultFile": "NO_MATCH",
              "effectiveSecurityControls": {
                "applyApiConstraints": false,
                "applyApplicationLayerControls": true,
                "applyBotmanControls": true,
                "applyNetworkLayerControls": false,
                "applyRateControls": true,
                "applyReputationControls": true,
                "applySlowPostControls": false
              },
              "fileExtensions": [],
              "filePaths": [
                "/path"
              ],
              "hostnames": [
                "example.com",
                "www.example.net",
                "m.example.com"
              ],
              "isNegativeFileExtensionMatch": false,
              "isNegativePathMatch": false,
              "securityPolicy": {
                "policyId": "ancv_1234"
              },
              "sequence": 2,
              "targetId": 1222207,
              "type": "website"
            }
          ]
        }
      }
    },
    {
      "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"
      }
    }
  ]
}