Akamai · Example Payload

Akamai Put Cache Settings Example

CDNCloudEdge ComputingNetworksPlatformSecurity

Akamai Put Cache Settings 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": "put-cache-settings",
  "method": "PUT",
  "path": "/endpoints/{apiEndPointId}/versions/{versionNumber}/settings/cache",
  "summary": "Edit cache settings",
  "requestExamples": [
    {
      "contentType": "application/json",
      "example": {
        "enabled": true,
        "option": "CACHE",
        "preRefreshing": null,
        "serveStale": true,
        "cacheKey": {
          "customize": true,
          "exactMatch": true,
          "option": "INCLUDE_ALL_PRESERVE_ORDER",
          "parameters": null
        },
        "downstreamCaching": {
          "headers": "CACHE_CONTROL_AND_EXPIRES",
          "lifetime": "SMALLER_VALUE",
          "markAsPrivate": false,
          "maxAge": null,
          "option": "ALLOW_CACHING"
        },
        "errorCaching": {
          "enabled": true,
          "preserveStale": true,
          "maxAge": {
            "duration": 80,
            "unit": "SECONDS"
          }
        },
        "maxAge": {
          "duration": 100,
          "unit": "SECONDS"
        },
        "resources": {
          "2926712": {
            "inheritsFromEndpoint": true,
            "option": "CACHE",
            "path": "/book/{bookId}",
            "serveStale": true,
            "methods": [
              "POST",
              "GET"
            ],
            "cacheKey": {
              "customize": true,
              "exactMatch": true,
              "option": "INCLUDE_ALL_PRESERVE_ORDER",
              "parameters": null
            },
            "maxAge": {
              "duration": 100,
              "unit": "SECONDS"
            }
          },
          "2935128": {
            "inheritsFromEndpoint": false,
            "option": "CACHE",
            "path": "/user/{userId}",
            "serveStale": false,
            "methods": [
              "POST",
              "GET",
              "PUT"
            ],
            "cacheKey": {
              "customize": false,
              "exactMatch": true,
              "option": "INCLUDE_ALL_PRESERVE_ORDER",
              "parameters": null
            },
            "maxAge": {
              "duration": 120,
              "unit": "SECONDS"
            }
          },
          "2935139": {
            "inheritsFromEndpoint": true,
            "option": "CACHE",
            "path": "/magazine/{magazineId}",
            "serveStale": true,
            "methods": [
              "GET"
            ],
            "cacheKey": {
              "customize": true,
              "exactMatch": true,
              "option": "INCLUDE_ALL_PRESERVE_ORDER",
              "parameters": null
            },
            "maxAge": {
              "duration": 100,
              "unit": "SECONDS"
            }
          }
        }
      }
    }
  ],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "enabled": true,
        "option": "CACHE",
        "preRefreshing": null,
        "serveStale": true,
        "cacheKey": {
          "customize": true,
          "exactMatch": true,
          "option": "INCLUDE_ALL_PRESERVE_ORDER",
          "parameters": null
        },
        "downstreamCaching": {
          "headers": "CACHE_CONTROL_AND_EXPIRES",
          "lifetime": "SMALLER_VALUE",
          "markAsPrivate": false,
          "maxAge": null,
          "option": "ALLOW_CACHING"
        },
        "errorCaching": {
          "enabled": true,
          "preserveStale": true,
          "maxAge": {
            "duration": 80,
            "unit": "SECONDS"
          }
        },
        "maxAge": {
          "duration": 100,
          "unit": "SECONDS"
        },
        "resources": {
          "2926712": {
            "inheritsFromEndpoint": true,
            "option": "CACHE",
            "path": "/book/{bookId}",
            "serveStale": true,
            "methods": [
              "POST",
              "GET"
            ],
            "cacheKey": {
              "customize": true,
              "exactMatch": true,
              "option": "INCLUDE_ALL_PRESERVE_ORDER",
              "parameters": null
            },
            "maxAge": {
              "duration": 100,
              "unit": "SECONDS"
            }
          },
          "2935128": {
            "inheritsFromEndpoint": false,
            "option": "CACHE",
            "path": "/user/{userId}",
            "serveStale": false,
            "methods": [
              "POST",
              "GET",
              "PUT"
            ],
            "cacheKey": {
              "customize": false,
              "exactMatch": true,
              "option": "INCLUDE_ALL_PRESERVE_ORDER",
              "parameters": null
            },
            "maxAge": {
              "duration": 120,
              "unit": "SECONDS"
            }
          },
          "2935139": {
            "inheritsFromEndpoint": true,
            "option": "CACHE",
            "path": "/magazine/{magazineId}",
            "serveStale": true,
            "methods": [
              "GET"
            ],
            "cacheKey": {
              "customize": true,
              "exactMatch": true,
              "option": "INCLUDE_ALL_PRESERVE_ORDER",
              "parameters": null
            },
            "maxAge": {
              "duration": 100,
              "unit": "SECONDS"
            }
          }
        }
      }
    }
  ]
}