Menu

Lumen help

Cache control

This section explains how to set up the Cache Control Header Override (CCHO).
 

A Cache Control Header Override setting consists of the following:
 

  • An internal Cache Control policy specified as TTL defaulting to seconds or optionally followed by one of the following letters to indicate units:

    • s—seconds
    • m—minutes
    • h—hours
    • d—days
    • w—weeks
    • y—years
       

Alternately, the internal policy can be set to "as-is", "no-cache", or "no-store".
 

  • An external Cache Control policy, following the same rules as the internal policy.

  • A force attribute with possible values "yes" and "no". (This is an optional value for the external Cache Control policy only.)

Description

Creates a new Cache Control Group. Supports a CCHOMode object, which includes an internal and external policy identifier and an optional force attribute. (For details, see Cache Control category summary section.)

Method

POST

Base URI

https://ws.lumen.com

Body syntax

{ "CacheControl": { "cchomode": { "int": "", # required "ext": "", # optional "force": ("yes" | "no" ) # optional, only applicable for ext } } } # TTL String: Integer with optional time unit (s/m/h/d/w/y). Default is seconds. # Minimum TTL is 30 seconds.

URI syntax

/serviceConfiguration/(version)/(scope)/ResourceGroups/(rgid)/ConfGroups/CacheControl

version [CDATA[ ]] Values: "v1.0" (required)
scope [CDATA[ ]] (AG)/(SCID)[/(ALIAS)]

AG = Access Group

SCID = Service Component Identifier

ALIAS = Optional Alias identifies Property

Example

{
"CacheControl": {
"cchomode": {
"int": "<TTL String>", # required
"ext": "<TTL String>", # optional
"force": ("yes" | "no" ) # optional, only applicable for ext
}
}
}
# TTL String: Integer with optional time unit (s/m/h/d/w/y). Default is seconds.
# Minimum TTL is 30 seconds.

{
"CacheControl": {
"cchomode": {
"ext": "no-store",
"force": "yes",
"int": "120m"
}
}
}

Possible status and error messages returned to client

201: Created

Description

Retrieves the cache control configuration group of a given resource group for a service component or property.

Method

GET

Base URI

https://ws.lumen.com

URI syntax

/serviceConfiguration/(version)/(scope)/ResourceGroups/(rgid)/ConfGroups/CacheControl

version [CDATA[ ]] Values: "v1.0" (required)
scope [CDATA[ ]] (AG)/(SCID)[/(ALIAS)]

AG = Access Group

SCID = Service Component Identifier

ALIAS = Optional Alias identifies Property

Example

https://ws.lumen.com/serviceConfiguration/v1.0/1234/BBBN5678/test1.caching.cdn.lumen.net/ResourceGroups/videos/ConfGroups/CacheControl

https://ws.lumen.com/serviceConfiguration/v1.0/1234/BBBN5678/ResourceGroups/videos/ConfGroups/CacheControl

{
"CacheControl": {
"cchomode": {
"ext": "no-store",
"force": "yes",
"int": "1234"
}
}
}

Possible status and error messages returned to client

200: Request Successful.

Description

Updates a cache control group. Note that all required attribution needs to be provided in the update body.

Method

PUT

Base URI

https://ws.lumen.com

Body syntax

{
"CacheControl": {
"cchomode": {
"int": ("as-is" | "no-cache" | "no-store" | "<TTL String>" ) , # required
"ext": ("as-is" | "no-cache" | "no-store" | "<TTL String>" ) , # optional
"force": ("yes" | "no" ) # optional, only applicable for ext
}
}
}
# TTL String: Integer with optional time unit (s/m/h/d/w/y)

URI syntax

/serviceConfiguration/(version)/(scope)/ResourceGroups/(rgid)/ConfGroups/CacheControl

version [CDATA[ ]] Values: "v1.0" (required)
scope [CDATA[ ]] (AG)/(SCID)[/(ALIAS)]

AG = Access Group

SCID = Service Component Identifier

ALIAS = Optional Alias identifies Property

Example

https://ws.lumen.com/serviceConfiguration/v1.0/1234/BBBN5678/test1.caching.cdn.lumen.net/ResourceGroups/videos/ConfGroups/CacheControl

https://ws.lumen.com/serviceConfiguration/v1.0/1234/BBBN5678/ResourceGroups/videos/ConfGroups/CacheControl

{
"CacheControl": {
"cchomode": {
"ext": "no-cache",
"force": "yes",
"int": "120m"
}
}
}

{
"CacheControl": {
"cchomode": {
"ext": "no-store",
"force": "yes",
"int": "120m"
}
}
}

Possible status and error messages returned to client

204: Success no Content.