Menu

Lumen help

Geo definitions

Description

Creates a new geo definition. Requires a geoid and a list of country codes.

Geo services manage geo definitions at both the service component and property level (service component if no alias is provided, or a property when an alias has been specified). A geo definition is a combination of a unique ID (geoid) and a list of country codes.

Method

POST

Base URI

https://ws.lumen.com

URI syntax

/serviceConfiguration/(version)/(scope)/GeoDefs

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

AG = Access Group

SCID = Service Component Identifier

ALIAS = Optional Alias identifies Property

Example

{
"geoid": "<String containing [A-Za-z0-9_]>", # required
"cc": [ "<country code>", … ] # required
}

{
"geoid": "NorthAmerica",
"cc": [ "CA", "US" ]
}

Possible status and error messages returned to client

200: Request Successful.

404: Not Found.

Description

Retrieves a single geo definition by geoid. The results include the order attribute, indicating the position of this geo definition in the array of definitions.

Geo services manage geo definitions at both the service component and property level (service component if no alias is provided, or a property when an alias has been specified). A geo definition is a combination of a unique ID (geoid) and a list of country codes.

Method

GET

Base URI

https://ws.lumen.com

URI syntax

/serviceConfiguration/(version)/(scope)/GeoDefs/(geoid)

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/GeoDefs/NorthAmerica

https://ws.lumen.com/serviceConfiguration/v1.0/1234/BBBN5678/GeoDefs/NorthAmerica

{
"cc":
"CA, US",
"geoid": "NorthAmerica",
"order": 0
}

Possible status and error messages returned to client

200: Request Successful.

404: Not Found.

Description

Retrieves the array of geo definitions for service component or property.

Geo services manage geo definitions at both the service component and property level (service component if no alias is provided, or a property when an alias has been specified). A geo definition is a combination of a unique ID (geoid) and a list of country codes.

Method

GET

Base URI

https://ws.lumen.com

URI syntax

/serviceConfiguration/(version)/(scope)/GeoDefs

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/GeoDefs

https://ws.lumen.com/serviceConfiguration/v1.0/1234/BBBN5678/GeoDefs

[
{
"cc": "GE, FR",
"geoid": "Europe"
},
{
"cc": "CA, US",
"geoid": "NorthAmerica"
}
]

Possible status and error messages returned to client

200: Request Successful.

Description

Updates the country codes for an existing geo definition.

Geo services manage geo definitions at both the service component and property level (service component if no alias is provided, or a property when an alias has been specified). A geo definition is a combination of a unique ID (geoid) and a list of country codes.

Method

PUT

Base URI

https://ws.lumen.com

Body syntax

{
"geoid": "<String containing [A-Za-z0-9_]>", # required
"cc": [ "<country code>", … ] # required
}

URI syntax

/serviceConfiguration/(version)/(scope)/GeoDefs

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/GeoDefs/NorthAmerica

https://ws.lumen.com/serviceConfiguration/v1.0/1234/BBBN5678/GeoDefs/NorthAmerica

{
"geoid": "NorthAmerica",
"cc": [ "CA", "US", "MX" ]
}

[Empty]

Possible status and error messages returned to client

204: Success no Content.

Description

Removes an existing geo definition identified by geoid.

Geo services manage geo definitions at both the service component and property level (service component if no alias is provided, or a property when an alias has been specified). A geo definition is a combination of a unique id (geoid) and a list of country codes.

Method

DELETE

Base URI

https://ws.lumen.com

URI syntax

/serviceConfiguration/(version)/(scope)/GeoDefs

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/GeoDefs/NorthAmerica

https://ws.lumen.com/serviceConfiguration/v1.0/1234/BBBN5678/GeoDefs/NorthAmerica

[Empty]

Possible status and error messages returned to client

200: Request Successful.