Get Origin Shield POPs - BETA

This endpoint is currently available as a BETA. Business-critical processes should not depend on this functionality.

Lists the available Origin Shield locations for the HTTP Large platform by region. Use Origin Shield POP codes (code) and bypass codes (bypass_code) to set or to interpret Origin Shield settings for a customer origin group.

Use the cdn.origins scope to authenticate and authorize requests for the Origins API.

Request

Use this endpoint to retrieve one or more Origin Shield POPs.

HTTP Method	Request URI
GET	All Origin Shield POPs: https://api.vdms.io/cdn/origins/v0.5/http-large/origin-shield-pops Filtered Origin Shield POPs: https://api.vdms.io/cdn/origins/v0.5/http-large/origin-shield-pops?findcode=Code

Define the following variable when requesting a filtered list of Origin Shield POPs:

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
Code Required	Replace this variable with either of the following codes: POP Code: Pass an Origin Shield's POP code to retrieve information about that specific Origin Shield POP. Bypass Region Code: Pass one of the following bypass code to retrieve information about that region including all of its Origin Shield POPs: BYAP: Asia BYEC: US East BYEU: Europe BYWC: US West

Request Headers

This endpoint 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 returns the following object for each region: 

Name	Data Type	Description
bypass_code	String	Indicates the four-letter abbreviation that corresponds to this region's bypass code.
bypass_name	String	Indicates the name of this region's bypass configuration.
pops	Array of objects	Contains a list of Origin Shield POPs for the region defined by the region_name property. You may only define a single Origin Shield POP per region when setting up a customer origin group's Origin Shield configuration.
region_id	Integer	Indicates the region's system-defined ID.
region_name	String	Indicates the name of the current region.

pops Array

The pops array describes each Origin Shield POP that corresponds to the current region through the following properties:

Name	Data Type	Description
id	Integer	Indicates the system-defined ID assigned to this Origin Shield POP.
code	String	Indicates the three-letter abbreviation corresponding to this POP location.
city	String	Indicates the Origin Shield's city.
is_pci_certified	Boolean	Indicates whether this customer origin group is restricted to Payment Card Industry (PCI)-compliant Origin Shield POPs. Valid values are: true | false

Errors

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

View common error messages.

Sample Request and Response (JSON)

A sample JSON request is shown below.

A sample JSON response is shown below.

[{
		"region_id": 2,
		"region_name": "Europe",
		"bypass_code": "BYEU",
		"bypass_name": "Bypass Europe",
		"pops": [{
				"id": 318,
				"code": "AMA",
				"city": "Amsterdam",
				"is_pci_certified": false
			}, {
				"id": 341,
				"code": "AMB",
				"city": "Amsterdam",
				"is_pci_certified": false
			}, {
				"id": 143,
				"code": "CPH",
				"city": "Copenhagen",
				"is_pci_certified": false
			}, {
				"id": 294,
				"code": "FRB",
				"city": "Frankfurt",
				"is_pci_certified": false
			}, {
				"id": 325,
				"code": "FRC",
				"city": "Frankfurt",
				"is_pci_certified": false
			}, {
				"id": 142,
				"code": "HEL",
				"city": "Helsinki",
				"is_pci_certified": false
			}, {
				"id": 296,
				"code": "LHB",
				"city": "London",
				"is_pci_certified": false
			}, {
				"id": 317,
				"code": "LHA",
				"city": "London",
				"is_pci_certified": false
			}, {
				"id": 410,
				"code": "LHC",
				"city": "London",
				"is_pci_certified": true
			}, {
				"id": 397,
				"code": "MDR",
				"city": "Madrid",
				"is_pci_certified": true
			}, {
				"id": 388,
				"code": "MIL",
				"city": "Milan",
				"is_pci_certified": false
			}, {
				"id": 337,
				"code": "PAB",
				"city": "Paris",
				"is_pci_certified": false
			}, {
				"id": 338,
				"code": "PAA",
				"city": "Paris",
				"is_pci_certified": true
			}, {
				"id": 333,
				"code": "RIX",
				"city": "Riga, Latvia",
				"is_pci_certified": false
			}, {
				"id": 141,
				"code": "STO",
				"city": "Stockholm",
				"is_pci_certified": false
			}, {
				"id": 381,
				"code": "SKA",
				"city": "Stockholm",
				"is_pci_certified": false
			}, {
				"id": 376,
				"code": "VIA",
				"city": "Vienna",
				"is_pci_certified": true
			}, {
				"id": 447,
				"code": "WMI",
				"city": "Warsaw",
				"is_pci_certified": false
			}
		]
	}
]