Lumen help
Resource groups are filters defining the scope for a group of configuration rules (via an associated configuration group). A given service component or property can have multiple resource groups defined, each identified by a unique ID (rgid).
The order of resource groups is important, as it is used to determine precedence for overlapping matches. Individually added resource groups are kept in the order in which they were added, each one given a sequence number starting from 0.
For any HTTP request, the matching resource group with the lowest sequence number governs the behavior for that request.
In addition to the standard Add, Update, and Delete operations, resource groups support rearranging the order via a PUT operation.
A resource group consists of the following elements:
A request path is considered a match for the resource group if any of the expressions in rgdef match the request. Supported wildcards for rgdef include:
'*' matches 0 or more characters
'+' matches 1 or more non-/ (slash, or 'directory separator') characters
Creates a new resource group. Requires a resource group ID, a type, and a definition in the form of a string array. The response echoes the supplied resource group definition on success.
POST
https://ws.lumen.com
{
"rgid": "<string with characters [A-Za-z0-9_]>", # required
"rgtype": "path" # required
"rgdef": [ "<identifier>", … ], # required
}
/serviceConfiguration/(version)/(scope)/ResourceGroups
version [CDATA[ ]] | Values: "v1.0" (required) |
scope [CDATA[ ]] | (AG)/(SCID)[/(ALIAS)] AG = Access Group SCID = Service Component Identifier ALIAS = Optional Alias identifies Property |
https://ws.lumen.com/serviceConfiguration/v1.0/1234/BBBN5678/test1.caching.cdn.lumen.net/ResourceGroups
https://ws.lumen.com/serviceConfiguration/v1.0/1234/BBBN5678/ResourceGroups
{
"rgdef": [ "*.flv", "*.mp4", "*.f4p" ],
"rgtype": "path",
"rgid": "videos"
}
{
"rgdef": [ "*.flv", "*.mp4", "*.f4p" ],
"rgtype": "path",
"rgid": "videos"
}
201: Created.
Retrieves a resource group for service component or property by rgid.
GET
https://ws.lumen.com
/serviceConfiguration/(version)/(scope)/ResourceGroups/(rgid)
version [CDATA[ ]] | Values: "v1.0" (required) |
scope [CDATA[ ]] | (AG)/(SCID)[/(ALIAS)] AG = Access Group SCID = Service Component Identifier ALIAS = Optional Alias identifies Property |
https://ws.lumen.com/serviceConfiguration/v1.0/1234/BBBN5678/test1.caching.cdn.lumen.net/ResourceGroups/videos
https://ws.lumen.com/serviceConfiguration/v1.0/1234/BBBN5678/ResourceGroups/videos
{
"rgdef": [ "*.flv", "*.mp4", "*.f4p" ],
"order": 0,
"rgtype": "path",
"rgid": "videos"
}
200: Request Successful.
404: Not Found.
Retrieves the array of resource groups for service component or property.
GET
https://ws.lumen.com
/serviceConfiguration/(version)/(scope)/ResourceGroups
version [CDATA[ ]] |
Values: "v1.0" (required) |
scope [CDATA[ ]] |
(AG)/(SCID)[/(ALIAS)] AG = Access Group SCID = Service Component Identifier ALIAS = Optional Alias identifies Property |
https://ws.lumen.com/serviceConfiguration/v1.0/1234/BBBN5678/test1.caching.cdn.lumen.net/ResourceGroups
https://ws.lumen.com/serviceConfiguration/v1.0/1234/BBBN5678/ResourceGroups
[
{
"rgdef": [ "*.flv", "*.mp4", "*.f4p" ],
"order": 0,
"rgtype": "path",
"rgid": "videos"
},
{
"rgdef": [ "*.jpg", "*.png" ],
"order": 1,
"rgtype": "path",
"rgid": "images"
}
]
200: Request Successful.
Updates a resource group. (Only the rgdef attribute can be updated.)
PUT
https://ws.lumen.com
"rgid": "<string with characters [A-Za-z0-9_]>", # required
"rgtype": "path" # optional
"rgdef": [ "<identifier>", … ], # required
}
/serviceConfiguration/(version)/(scope)/ResourceGroups/(rgid)
version [CDATA[ ]] |
Values: "v1.0" (required) |
scope [CDATA[ ]] | (AG)/(SCID)[/(ALIAS)] AG = Access Group SCID = Service Component Identifier ALIAS = Optional Alias identifies Property |
https://ws.lumen.com/serviceConfiguration/v1.0/1234/BBBN5678/test1.caching.cdn.lumen.net/ResourceGroups
https://ws.lumen.com/serviceConfiguration/v1.0/1234/BBBN5678/ResourceGroups
{
"rgdef": [ "*.mp4 ],
"rgtype": "path",
"rgid": "videos"
}
[Empty]
204: Success no Content.
Changes the order of resource groups. The order for a given resource group is specified via the order attribute. The numbering is consecutive and starts with 0. Values outside of the range for order will be mapped to such consecutive numbering (for example, if 3 groups are present and the order for one is specified as 8, it is converted to 2 (highest consecutive number starting from 0). The request does not require that all resource groups are included.
PUT
https://ws.lumen.com
[
{
"rgid": "<string with characters [A-Za-z0-9_]>", # required
"order": <integer> # required
}, …
]
/serviceConfiguration/(version)/(scope)/ResourceGroups/Order
version [CDATA[ ]] | Values: "v1.0" (required) |
Values: "v1.0" (required) | (AG)/(SCID)[/(ALIAS)] AG = Access Group SCID = Service Component Identifier ALIAS = Optional Alias identifies Property |
https://ws.lumen.com/serviceConfiguration/v1.0/1234/BBBN5678/test1.caching.cdn.lumen.net/ResourceGroups/Order
https://ws.lumen.com/serviceConfiguration/v1.0/1234/BBBN5678/ResourceGroups/Order
[
{ "rgid": "videos", "order": 0 },
{ "rgid": "images", "order": 1 }
}
]
[Empty]
204: Success no Content.
Removes a resource group for service component or property by rgid.
DELETE
https://ws.lumen.com
/serviceConfiguration/(version)/(scope)/ResourceGroups/(rgid)
version [CDATA[ ]] | Values: "v1.0" (required) |
scope [CDATA[ ]] | (AG)/(SCID)[/(ALIAS)] AG = Access Group SCID = Service Component Identifier ALIAS = Optional Alias identifies Property |
https://ws.lumen.com/serviceConfiguration/v1.0/1234/BBBN5678/test1.caching.cdn.lumen.net/ResourceGroups
https://ws.lumen.com/serviceConfiguration/v1.0/1234/BBBN5678/ResourceGroups
{ "rgdef": [ "*.mp4 ], "rgtype": "path", "rgid": "videos"}
[Empty]
204: Success no Content.
Explore Media portal
API articles