Show search and navigation.

 

Get Load/Purge Regions

Retrieves a list of platform-specific load/purge regions. Load/purge regions may be used to selectively apply a load or purge request to specific region(s).

The set of available regions varies by platform. The response to this endpoint includes all regions that apply to at least one of the platforms defined in the request.

Request

A request to retrieve a list of load/purge regions is described below.

HTTP Method Request URI

GET

https://api.edgecast.com/v2/mcc/lpqregions?mediaTypes=PlatformIDs

Define the following variable when submitting the above request:

VariableA variable represents a value that must be replaced. A variable consists of either a URL segment (e.g., "0001" in /0001/) or a query string value (e.g., "3" in mediaTypes=3). Description

PlatformIDs

Required

Replace this variable with the ID of each platform for which regions will be returned. Use a comma to delimit multiple platforms (e.g., 3,8).

The response will include all regions that apply to at least one of the platforms defined by the mediaTypes query string parameter.

Valid values are:

  • 3: HTTP Large
  • 8: HTTP Small
  • 14: Application Delivery Network (ADN)

Request Headers

This endpointIdentifies a request's connection point to our REST API service. only takes advantage of common request headers.

Request Body

Request body parameters are not required by this endpoint.

Response

The response to the above request includes an HTTP status code, response headers, and a response body.

Status Code

A status code indicates whether the request was successfully performed.

Response Headers

The response for this endpoint only includes standard HTTP response headers.

View common response headers.

Response Body

The response body for a successful request contains the following response parameters for each region returned by this endpoint:

Name Data Type Description

EdgeNodes

Array

Lists each POP (i.e., edge node) associated with the current region.

Code

String

EdgeNodes array

Identifies by a POP by its three-letter abbreviation.

Id

Integer

EdgeNodes array

Identifies a POP by its system-defined ID.

Id

Integer

Identifies a region by its system-defined ID.

Name

String

Identifies a region by its name.

Errors

The response body for an unsuccessful request may contain an error parameter that provides additional information.

View common error messages.

Sample Request and Response (JSON)

A sample JSON request is shown below.

GET https://api.edgecast.com/v2/mcc/lpqregions?mediaTypes=3 HTTP/1.1

Authorization: TOK:12345678-1234-1234-1234-1234567890ab

Accept: application/json

Host: api.edgecast.com

A sample JSON response is shown below.

HTTP/1.1 200 OK

Cache-Control: private

Content-Type: application/json; charset=utf-8

Date:Thu, 15 Apr 2021 12:00:00 GMT

Content-Length: 4091

[{
		"EdgeNodes" : [{
				"Code" : "DCA",
				"Id" : 2
			}, {
				"Code" : "LAX",
				"Id" : 3
			}, {
				"Code" : "SEA",
				"Id" : 4
			}, {
				"Code" : "DFW",
				"Id" : 5
			}, {
				"Code" : "ORD",
				"Id" : 6
			}, {
				"Code" : "ATL",
				"Id" : 7
			}, {
				"Code" : "JFK",
				"Id" : 15
			}, {
				"Code" : "MIA",
				"Id" : 22
			}, {
				"Code" : "SJC",
				"Id" : 25
			}, {
				"Code" : "CPM",
				"Id" : 122
			}, {
				"Code" : "EWR",
				"Id" : 123
			}, {
				"Code" : "MDW",
				"Id" : 127
			}, {
				"Code" : "FTW",
				"Id" : 129
			}, {
				"Code" : "IAD",
				"Id" : 131
			}, {
				"Code" : "FLL",
				"Id" : 139
			}, {
				"Code" : "LGA",
				"Id" : 149
			}, {
				"Code" : "FTY",
				"Id" : 153
			}, {
				"Code" : "PAE",
				"Id" : 160
			}, {
				"Code" : "RHV",
				"Id" : 161
			}, {
				"Code" : "OXR",
				"Id" : 164
			}, {
				"Code" : "PHL",
				"Id" : 188
			}, {
				"Code" : "BOS",
				"Id" : 202
			}
		],
		"Id" : 1,
		"Name" : "North America"
	}, {
		"EdgeNodes" : [{
				"Code" : "DCA",
				"Id" : 2
			}, {
				"Code" : "ATL",
				"Id" : 7
			}, {
				"Code" : "JFK",
				"Id" : 15
			}, {
				"Code" : "MIA",
				"Id" : 22
			}, {
				"Code" : "EWR",
				"Id" : 123
			}, {
				"Code" : "IAD",
				"Id" : 131
			}, {
				"Code" : "FLL",
				"Id" : 139
			}, {
				"Code" : "LGA",
				"Id" : 149
			}, {
				"Code" : "FTY",
				"Id" : 153
			}, {
				"Code" : "PHL",
				"Id" : 188
			}, {
				"Code" : "BOS",
				"Id" : 202
			}
		],
		"Id" : 2,
		"Name" : "US: Eastern Time Zone"
	}, {
		"EdgeNodes" : [{
				"Code" : "DFW",
				"Id" : 5
			}, {
				"Code" : "ORD",
				"Id" : 6
			}, {
				"Code" : "MDW",
				"Id" : 127
			}, {
				"Code" : "FTW",
				"Id" : 129
			}
		],
		"Id" : 3,
		"Name" : "US: Central Time Zone"
	}, {
		"EdgeNodes" : [{
				"Code" : "LAX",
				"Id" : 3
			}, {
				"Code" : "SEA",
				"Id" : 4
			}, {
				"Code" : "DFW",
				"Id" : 5
			}, {
				"Code" : "ORD",
				"Id" : 6
			}, {
				"Code" : "SJC",
				"Id" : 25
			}, {
				"Code" : "CPM",
				"Id" : 122
			}, {
				"Code" : "PAE",
				"Id" : 160
			}, {
				"Code" : "RHV",
				"Id" : 161
			}, {
				"Code" : "OXR",
				"Id" : 164
			}
		],
		"Id" : 4,
		"Name" : "US: Pacific Time Zone"
	}, {
		"EdgeNodes" : [{
				"Code" : "FRA",
				"Id" : 8
			}, {
				"Code" : "LHR",
				"Id" : 9
			}, {
				"Code" : "AMS",
				"Id" : 18
			}, {
				"Code" : "CDG",
				"Id" : 21
			}, {
				"Code" : "MAD",
				"Id" : 23
			}, {
				"Code" : "VIE",
				"Id" : 30
			}, {
				"Code" : "ARN",
				"Id" : 68
			}, {
				"Code" : "FCN",
				"Id" : 87
			}, {
				"Code" : "ORY",
				"Id" : 130
			}, {
				"Code" : "STO",
				"Id" : 141
			}, {
				"Code" : "HEL",
				"Id" : 142
			}, {
				"Code" : "CPH",
				"Id" : 143
			}, {
				"Code" : "MXP",
				"Id" : 144
			}, {
				"Code" : "WAW",
				"Id" : 147
			}, {
				"Code" : "LCY",
				"Id" : 148
			}, {
				"Code" : "RTM",
				"Id" : 156
			}, {
				"Code" : "FRF",
				"Id" : 173
			}, {
				"Code" : "TOJ",
				"Id" : 174
			}, {
				"Code" : "POX",
				"Id" : 199
			}
		],
		"Id" : 5,
		"Name" : "Europe"
	}, {
		"EdgeNodes" : [{
				"Code" : "SYD",
				"Id" : 10
			}, {
				"Code" : "NRT",
				"Id" : 12
			}, {
				"Code" : "SIN",
				"Id" : 20
			}, {
				"Code" : "KIX",
				"Id" : 27
			}, {
				"Code" : "HHP",
				"Id" : 86
			}, {
				"Code" : "MEL",
				"Id" : 125
			}, {
				"Code" : "BTH",
				"Id" : 136
			}, {
				"Code" : "CGK",
				"Id" : 137
			}, {
				"Code" : "HND",
				"Id" : 138
			}, {
				"Code" : "KHH",
				"Id" : 145
			}, {
				"Code" : "ICN",
				"Id" : 175
			}, {
				"Code" : "MEB",
				"Id" : 200
			}
		],
		"Id" : 6,
		"Name" : "Asia"
	}, {
		"EdgeNodes" : [{
				"Code" : "GRU",
				"Id" : 67
			}, {
				"Code" : "CGH",
				"Id" : 151
			}
		],
		"Id" : 7,
		"Name" : "South America"
	}
]

Sample Request and Response (XML)

A sample XML request is shown below.

GET https://api.edgecast.com/v2/mcc/lpqregions?mediaTypes=3 HTTP/1.1

Authorization: TOK:12345678-1234-1234-1234-1234567890ab

Accept: application/xml

Host: api.edgecast.com

A sample XML response is shown below.

HTTP/1.1 200 OK

Cache-Control: private

Content-Type: application/xml; charset=utf-8

Date:Thu, 15 Apr 2021 12:00:00 GMT

Content-Length: 13378

<ArrayOfEdgeNodeRegion xmlns="http://www.whitecdn.com/schemas/apiservices/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
	<EdgeNodeRegion>
		<EdgeNodes>
			<EdgeNode>
				<Code>DCA</Code>
				<Id>2</Id>
			</EdgeNode>
			<EdgeNode>
				<Code>LAX</Code>
				<Id>3</Id>
			</EdgeNode>
			<EdgeNode>
				<Code>SEA</Code>
				<Id>4</Id>
			</EdgeNode>
			<EdgeNode>
				<Code>DFW</Code>
				<Id>5</Id>
			</EdgeNode>
			<EdgeNode>
				<Code>ORD</Code>
				<Id>6</Id>
			</EdgeNode>
			<EdgeNode>
				<Code>ATL</Code>
				<Id>7</Id>
			</EdgeNode>
			<EdgeNode>
				<Code>JFK</Code>
				<Id>15</Id>
			</EdgeNode>
			<EdgeNode>
				<Code>MIA</Code>
				<Id>22</Id>
			</EdgeNode>
			<EdgeNode>
				<Code>SJC</Code>
				<Id>25</Id>
			</EdgeNode>
			<EdgeNode>
				<Code>CPM</Code>
				<Id>122</Id>
			</EdgeNode>
			<EdgeNode>
				<Code>EWR</Code>
				<Id>123</Id>
			</EdgeNode>
			<EdgeNode>
				<Code>MDW</Code>
				<Id>127</Id>
			</EdgeNode>
			<EdgeNode>
				<Code>FTW</Code>
				<Id>129</Id>
			</EdgeNode>
			<EdgeNode>
				<Code>IAD</Code>
				<Id>131</Id>
			</EdgeNode>
			<EdgeNode>
				<Code>FLL</Code>
				<Id>139</Id>
			</EdgeNode>
			<EdgeNode>
				<Code>LGA</Code>
				<Id>149</Id>
			</EdgeNode>
			<EdgeNode>
				<Code>FTY</Code>
				<Id>153</Id>
			</EdgeNode>
			<EdgeNode>
				<Code>PAE</Code>
				<Id>160</Id>
			</EdgeNode>
			<EdgeNode>
				<Code>RHV</Code>
				<Id>161</Id>
			</EdgeNode>
			<EdgeNode>
				<Code>OXR</Code>
				<Id>164</Id>
			</EdgeNode>
			<EdgeNode>
				<Code>PHL</Code>
				<Id>188</Id>
			</EdgeNode>
			<EdgeNode>
				<Code>BOS</Code>
				<Id>202</Id>
			</EdgeNode>
		</EdgeNodes>
		<Id>1</Id>
		<Name>North America</Name>
	</EdgeNodeRegion>
	<EdgeNodeRegion>
		<EdgeNodes>
			<EdgeNode>
				<Code>DCA</Code>
				<Id>2</Id>
			</EdgeNode>
			<EdgeNode>
				<Code>ATL</Code>
				<Id>7</Id>
			</EdgeNode>
			<EdgeNode>
				<Code>JFK</Code>
				<Id>15</Id>
			</EdgeNode>
			<EdgeNode>
				<Code>MIA</Code>
				<Id>22</Id>
			</EdgeNode>
			<EdgeNode>
				<Code>EWR</Code>
				<Id>123</Id>
			</EdgeNode>
			<EdgeNode>
				<Code>IAD</Code>
				<Id>131</Id>
			</EdgeNode>
			<EdgeNode>
				<Code>FLL</Code>
				<Id>139</Id>
			</EdgeNode>
			<EdgeNode>
				<Code>LGA</Code>
				<Id>149</Id>
			</EdgeNode>
			<EdgeNode>
				<Code>FTY</Code>
				<Id>153</Id>
			</EdgeNode>
			<EdgeNode>
				<Code>PHL</Code>
				<Id>188</Id>
			</EdgeNode>
			<EdgeNode>
				<Code>BOS</Code>
				<Id>202</Id>
			</EdgeNode>
		</EdgeNodes>
		<Id>2</Id>
		<Name>US: Eastern Time Zone</Name>
	</EdgeNodeRegion>
	<EdgeNodeRegion>
		<EdgeNodes>
			<EdgeNode>
				<Code>DFW</Code>
				<Id>5</Id>
			</EdgeNode>
			<EdgeNode>
				<Code>ORD</Code>
				<Id>6</Id>
			</EdgeNode>
			<EdgeNode>
				<Code>MDW</Code>
				<Id>127</Id>
			</EdgeNode>
			<EdgeNode>
				<Code>FTW</Code>
				<Id>129</Id>
			</EdgeNode>
		</EdgeNodes>
		<Id>3</Id>
		<Name>US: Central Time Zone</Name>
	</EdgeNodeRegion>
	<EdgeNodeRegion>
		<EdgeNodes>
			<EdgeNode>
				<Code>LAX</Code>
				<Id>3</Id>
			</EdgeNode>
			<EdgeNode>
				<Code>SEA</Code>
				<Id>4</Id>
			</EdgeNode>
			<EdgeNode>
				<Code>DFW</Code>
				<Id>5</Id>
			</EdgeNode>
			<EdgeNode>
				<Code>ORD</Code>
				<Id>6</Id>
			</EdgeNode>
			<EdgeNode>
				<Code>SJC</Code>
				<Id>25</Id>
			</EdgeNode>
			<EdgeNode>
				<Code>CPM</Code>
				<Id>122</Id>
			</EdgeNode>
			<EdgeNode>
				<Code>PAE</Code>
				<Id>160</Id>
			</EdgeNode>
			<EdgeNode>
				<Code>RHV</Code>
				<Id>161</Id>
			</EdgeNode>
			<EdgeNode>
				<Code>OXR</Code>
				<Id>164</Id>
			</EdgeNode>
		</EdgeNodes>
		<Id>4</Id>
		<Name>US: Pacific Time Zone</Name>
	</EdgeNodeRegion>
	<EdgeNodeRegion>
		<EdgeNodes>
			<EdgeNode>
				<Code>FRA</Code>
				<Id>8</Id>
			</EdgeNode>
			<EdgeNode>
				<Code>LHR</Code>
				<Id>9</Id>
			</EdgeNode>
			<EdgeNode>
				<Code>AMS</Code>
				<Id>18</Id>
			</EdgeNode>
			<EdgeNode>
				<Code>CDG</Code>
				<Id>21</Id>
			</EdgeNode>
			<EdgeNode>
				<Code>MAD</Code>
				<Id>23</Id>
			</EdgeNode>
			<EdgeNode>
				<Code>VIE</Code>
				<Id>30</Id>
			</EdgeNode>
			<EdgeNode>
				<Code>ARN</Code>
				<Id>68</Id>
			</EdgeNode>
			<EdgeNode>
				<Code>FCN</Code>
				<Id>87</Id>
			</EdgeNode>
			<EdgeNode>
				<Code>ORY</Code>
				<Id>130</Id>
			</EdgeNode>
			<EdgeNode>
				<Code>STO</Code>
				<Id>141</Id>
			</EdgeNode>
			<EdgeNode>
				<Code>HEL</Code>
				<Id>142</Id>
			</EdgeNode>
			<EdgeNode>
				<Code>CPH</Code>
				<Id>143</Id>
			</EdgeNode>
			<EdgeNode>
				<Code>MXP</Code>
				<Id>144</Id>
			</EdgeNode>
			<EdgeNode>
				<Code>WAW</Code>
				<Id>147</Id>
			</EdgeNode>
			<EdgeNode>
				<Code>LCY</Code>
				<Id>148</Id>
			</EdgeNode>
			<EdgeNode>
				<Code>RTM</Code>
				<Id>156</Id>
			</EdgeNode>
			<EdgeNode>
				<Code>FRF</Code>
				<Id>173</Id>
			</EdgeNode>
			<EdgeNode>
				<Code>TOJ</Code>
				<Id>174</Id>
			</EdgeNode>
			<EdgeNode>
				<Code>POX</Code>
				<Id>199</Id>
			</EdgeNode>
		</EdgeNodes>
		<Id>5</Id>
		<Name>Europe</Name>
	</EdgeNodeRegion>
	<EdgeNodeRegion>
		<EdgeNodes>
			<EdgeNode>
				<Code>SYD</Code>
				<Id>10</Id>
			</EdgeNode>
			<EdgeNode>
				<Code>NRT</Code>
				<Id>12</Id>
			</EdgeNode>
			<EdgeNode>
				<Code>SIN</Code>
				<Id>20</Id>
			</EdgeNode>
			<EdgeNode>
				<Code>KIX</Code>
				<Id>27</Id>
			</EdgeNode>
			<EdgeNode>
				<Code>HHP</Code>
				<Id>86</Id>
			</EdgeNode>
			<EdgeNode>
				<Code>MEL</Code>
				<Id>125</Id>
			</EdgeNode>
			<EdgeNode>
				<Code>BTH</Code>
				<Id>136</Id>
			</EdgeNode>
			<EdgeNode>
				<Code>CGK</Code>
				<Id>137</Id>
			</EdgeNode>
			<EdgeNode>
				<Code>HND</Code>
				<Id>138</Id>
			</EdgeNode>
			<EdgeNode>
				<Code>KHH</Code>
				<Id>145</Id>
			</EdgeNode>
			<EdgeNode>
				<Code>ICN</Code>
				<Id>175</Id>
			</EdgeNode>
			<EdgeNode>
				<Code>MEB</Code>
				<Id>200</Id>
			</EdgeNode>
		</EdgeNodes>
		<Id>6</Id>
		<Name>Asia</Name>
	</EdgeNodeRegion>
	<EdgeNodeRegion>
		<EdgeNodes>
			<EdgeNode>
				<Code>GRU</Code>
				<Id>67</Id>
			</EdgeNode>
			<EdgeNode>
				<Code>CGH</Code>
				<Id>151</Id>
			</EdgeNode>
		</EdgeNodes>
		<Id>7</Id>
		<Name>South America</Name>
	</EdgeNodeRegion>
</ArrayOfEdgeNodeRegion>