Akamai · Example Payload

Akamai Get Url Protection Policy Example

CDNCloudEdge ComputingNetworksPlatformSecurity

Akamai Get Url Protection Policy 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-url-protection-policy",
  "method": "GET",
  "path": "/configs/{configId}/versions/{versionNumber}/url-protections/{urlProtectionPolicyId}",
  "summary": "Get a URL protection policy",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "bypassCondition": {
          "atomicConditions": [
            {
              "checkIps": "connecting",
              "className": "NetworkListCondition",
              "positiveMatch": true,
              "value": [
                "12345_10CLIENTLIST",
                "54321_123"
              ]
            },
            {
              "className": "RequestHeaderCondition",
              "name": [
                "my-custom-header"
              ],
              "nameWildcard": false,
              "positiveMatch": true,
              "value": [
                "my-custom-value"
              ],
              "valueCase": false,
              "valueWildcard": false
            }
          ]
        },
        "categories": [
          {
            "type": "BOTS"
          },
          {
            "listIds": [
              "12345_10CLIENTLIST",
              "54321_123"
            ],
            "positiveMatch": true,
            "type": "CLIENT_LIST"
          },
          {
            "listIds": [
              "16656_CPISERVERS"
            ],
            "positiveMatch": true,
            "type": "CLIENT_LIST"
          },
          {
            "type": "CLOUD_PROVIDERS"
          },
          {
            "type": "PROXIES"
          },
          {
            "type": "TOR_EXIT_NODES"
          },
          {
            "type": "PLATFORM_DDOS_INTELLIGENCE"
          }
        ],
        "configId": 43007,
        "configVersion": 40,
        "createDate": "2023-04-14T18:58:53Z",
        "createdBy": "jsmith",
        "description": "URL Protection",
        "hostnamePaths": [
          {
            "hostname": "custom.com",
            "paths": [
              "/asd",
              "/my-test-path"
            ]
          }
        ],
        "intelligentLoadShedding": true,
        "name": "URL Protection",
        "policyId": 681,
        "protectionType": "MULTIPLE",
        "rateThreshold": 195,
        "sheddingThresholdHitsPerSec": 150,
        "updateDate": "2023-04-26T02:42:28Z",
        "updatedBy": "jperez",
        "used": true
      }
    },
    {
      "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"
      }
    }
  ]
}