Lumen help
Creates a new caching property under the given SCID and returns the newly created property object. The new property information will be returned in the success response.
At least one alias must be specified for each new property. That alias will be designated the primary alias. To reference the property in the service configuration API or any other media API, use the primary alias to specify scope. This is also the name that will be displayed in the Media portal for usage reporting, invalidation, and trouble ticketing. This primary alias cannot be deleted or changed.
There is a delay of approximately 15 minutes after a new property is created until the property is available for further configuration. The property is created immediately. However, no additional property configuration may be retrieved or set during that initial 15 minutes. After this time, all other operations will take effect immediately.
POST
https://ws.lumen.com
{
"originserver":{
"host": "<FQDN of the origin server>", # required
"port": "<port number of origin server>", # required
"protocol": ("http"|"https"), # required
"webroot": "<root path>" # optional, default: "/"
},
"aliases":[
"<Footprint alias>", # list of aliases, minimum 1
...
]
}
/serviceConfiguration/(version)/(scope)
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
{
"originserver":{
"host":" test.origin.com",
"port": "8001",
"protocol": "http"
},
"aliases":[
"test1.caching.cdn.lumen.net",
"test2.caching.cdn.lumen.net"
]
}
{
"originserver":{
"host": test.origin.com",
"port": "8001",
"protocol": "http"
},
"cosid":: "111111", # Internal code, can be ignored
"aliases":[
"test1.caching.cdn.lumen.net",
"test2.caching.cdn.lumen.net"
]
}
201: Created.
Returns the property definition (origin and aliases) for the property. This includes the status ("active" or "inactive").
GET
https://ws.lumen.com
/serviceConfiguration/(version)/(scope)
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
{
"originserver":{
"host": "test.origin.com",
"port": "8001",
"protocol": "http"
},
"aliases":[
"test1.caching.cdn.lumen.net",
"test2.caching.cdn.lumen.net"
],
"status": "active"
}
200: Request Successful.
Retrieves a list of available resources at the network identifier level wrapped in an access group and SCID object. The access group returns all available services (SCIDs) under the services array. Caching services will be identified as such by the product property ("CACHING"). The networkIdentifiers array will return a list of properties identified by their primary alias for every property of the given SCID. A status attribute will be returned for each property.
GET
https://ws.lumen.com
/serviceConfiguration/(version)/(scope)
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
{
"accessGroup": {
"id": 1234,
"name": "Customer Corporation",
"apiCorrelationId": "API-XXXXXXXXXXXXXXX",
"serviceResource": "/1234",
"services": [
{
"id": "BBKR84567",
"serviceResource": "/1234/ BBBN5678",
"product": "CACHING",
"networkIdentifiers": [
{
"id": " prop1.alias.cdn.level3.net",",
"serviceResource": "/1234/BBBN5678/prop1.alias.cdn.lumen.net",
"status": "active"
},
{
"id": " prop2.alias.cdn.level3.net ",
"serviceResource": "/1234/BBBN5678/prop2.alias.cdn.lumen.net",
"status": "active"
}
]
}
]
}
}
200: Request Successful.
Removes a property via the delete operation. The status changes to "inactive" and the property is deactivated but not permanently removed. (It can be reactivated via a PUT operation.)
DELETE
https://ws.lumen.com
/serviceConfiguration/(version)/(scope)
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
https://ws.lumen.com/serviceConfiguration/v1.0/1234/BBBN5678/ test1.caching.cdn.lumen.net
200: Request Successful.
Reinstates a deactivated property. The status changes to "active".
PUT
https://ws.lumen.com
/serviceConfiguration/(version)/(scope)
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
https://ws.lumen.com/serviceConfiguration/v1.0/1234/BBBN5678/test1.caching.cdn.lumen.net
[Empty]
204: Success with no Content.
Explore Media portal
API articles