API
Start typing to search…

Edit cache settings

put
https://{hostname}/api-definitions/v2/endpoints//versions//settings/cache

Updates the caching settings configured for an endpoint version and its assigned resources.

Path Params
integer
required

The unique identifier for the endpoint version.

integer
required

The unique identifier for the endpoint.

Query Params
string

For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Body Params
cacheKey
object
required

The cache key settings configured for an endpoint or resource.

boolean
required

Whether you want to customize caching behavior for the endpoint. This applies only to the main caching settings. You can set customize fields for errorCaching, cacheKey and downstreamCaching independently.

downstreamCaching
object
required

Downstream caching settings. Downstream caching refers to the caching instructions assigned to objects sent with responses toward clients, for example browsers, mobile devices, or client proxies.

boolean
deprecated

Deprecated Delivery caching settings for the endpoint can be overridden by using four independent customize fields.

errorCaching
object
required

Error caching settings.

maxAge
object | null

The maximum duration to keep content in a cache.

string
enum
Defaults to CACHE

The options for how to pass cached content, either CACHE to enable caching in Akamai platform servers according to the instructions you specify, BYPASS_CACHE to disallow caching in Akamai platform servers and keep the existing cache entries, NO_STORE to disallow caching in Akamai platform servers and remove the existing cache entries, HONOR_ORIGIN_CACHE_CONTROL to apply caching instructions specified in your origin's Cache-Control header, HONOR_ORIGIN_EXPIRES to apply caching instructions specified in your origin's Expires header, or HONOR_ORIGIN_CACHE_CONTROL_AND_EXPIRES to apply caching instructions specified in your origin's Cache-Control and Expires headers.

Allowed:
preRefreshing
object | null

Cache prefreshing settings. When enabled, edge servers asynchronously refresh cached objects after a specified percentage of the object's TTL elapses.

resources
object

Caching settings for each resource assigned to an endpoint version. This object is a map where the keys are resource IDs and values are cache settings applied to them.

boolean

Whether to serve stale responses when the origin is unreachable and content revalidation isn't possible.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated about 1 month ago

Language
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json
Updated about 1 month ago