Lumen help
Configuration groups provide rules that apply to the associated resource group filters. Currently, this allows the following categories:
- Access control—specify geoblocking and token authentication.
- Cache control—set CCHOMode.
- Content manipulation—specify query string handling mode.
Most operations are specific to the types above and are detailed in subsequent sections, with the exceptions of one common GET operation to retrieve all configuration groups for a resource group and a DELETE, which applies to the specified category.
Description
Retrieves the array of configuration groups for a given resource group of a service component or property.
Method
GET
Base URI
https://ws.lumen.com
URI syntax
/serviceConfiguration/(version)/(scope)/ResourceGroups/(rgid)/ConfGroups
| 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
https://ws.lumen.com/serviceConfiguration/v1.0/1234/BBBN5678/ResourceGroups/videos/ConfGroups
{
"ContentManipulation": {
"qshmode": {
"action": "ignore",
"type": "string"
}
},
"CacheControl": {
"cchomode": {
"ext": "no-store",
"force": "yes",
"int": "1234"
}
},
"AccessControl": {
"geoblocking": {
"geoid": [ "NorthAmerica",
"type": "allow"
}
}
}
Possible status and error messages returned to client
200: Request Successful.
Description
Removes a resource group for service component or property by rgid.
Method
DELETE
Base URI
https://ws.lumen.com
URI syntax
/serviceConfiguration/(version)/(scope)/ResourceGroups/(rgid)/ConfGroups/(group)
| version [CDATA[ ]] | Values: "v1.0" (required) |
| scope [CDATA[ ]] | (AG)/(SCID)[/(ALIAS)] AG = Access Group SCID = Service Component Identifier ALIAS = Optional Alias identifies Property |
| group [CDATA[ ]] | CacheControl AccessControl ContentManipulation |
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/AccessControl
[Empty]
Possible status and error messages returned to client
200: Request Successful.
Explore Media portal
API articles
- Access group hierarchy
- Caching configuration management 1.0 (deprecated)
- Caching configuration management 2.0 (deprecated)
- Content invalidation
- Key
- Origin Storage (deprecated)
- Real time monitoring (RTM) (Caching)
- Services hierarchy (partially deprecated)
- Usage reporting
- Vyvx reservations
- Error responses
- Sample API code
- Topics covered on this page:
