Show search and navigation.

 

Get Customer Origin Group - BETA

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

Retrieve a specific customer origin group through either of the following platform-specific endpoints:

Use the Get Origin Entries by Customer Origin Group endpoint to retrieve all of the origin entries associated with a customer origin group.

These endpoints do not currently support Azure Block Blob origin groups.

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

ClosedGet Customer Origin Group (HTTP Large)

Get Customer Origin Group (HTTP Large)

Retrieve a specific customer origin group for the HTTP Large delivery platform.

Request

A request to retrieve a customer origin group is described below.

HTTP Method Request URI

GET

https://api.vdms.io/cdn/origins/v0.5/http-large/groups/Customer Origin Group ID

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

Customer Origin Group ID

Required

Replace this variable with the desired origin group's system-defined ID.

Use the Get All Customer Origin Groups (HTTP Large) endpoint to retrieve a list of origin entries and their system-defined IDs.

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 contains the following response elements:

Name Data Type Description

host_header

String

Indicates the value that will be assigned to the Host header for all requests to this customer origin configuration.

id

Integer

Indicates the customer origin group's system-defined ID.

name

String

Indicates the customer origin group's name.

network_type_id

Integer

Indicates the method for resolving hostnames through its system-defined ID. Valid values are:

  • 1: Default. Indicates that the IP preference for this customer origin will be system-defined. Currently, this configuration causes hostnames to be resolved to IPv4 only.
  • 2: IPv6 Preferred over IPv4. Indicates that although hostnames for this customer origin can be resolved to either IP version, a preference will be given to IPv6.
  • 3: IPv4 Preferred over IPv6. Indicates that although hostnames for this customer origin can be resolved to either IP version, a preference will be given to IPv4.
  • 4: IPv4 Only. Indicates that hostnames for this customer origin can only be resolved to IPv4.
  • 5: IPv6 Only. Indicates that hostnames for this customer origin can only be resolved to IPv6.

Use the Get Available Hostname Resolution Methods endpoint to retrieve a list of methods and their system-defined IDs.

shield_pops

Array of string values

Contains this customer origin group's Origin Shield configuration.

Key information:

  • A customer origin group is protected by Origin Shield when one or more string value(s) have been defined.
  • Each string value represents an Origin Shield POP or bypass region code that defines how Origin Shield will behave for all regions or a specific region.

  • The number of string values contained within this array determines this customer origin group's Origin Shield configuration:

    • Single Value: If this array contains a single string value, then that string value defines the Origin Shield configuration for all regions. This is known as the Single POP option within the MCC.

    • Multiple Values: If this array contains multiple string values, then each string value defines an Origin Shield configuration for the region associated with the specified Origin Shield POP or bypass region code. This is known as the Multiple POPs option within the MCC.

      • Identify the region that corresponds to a value defined within this array by looking up the bypass region or Origin Shield POP code.
      • If a region has not been assigned an Origin Shield configuration, then requests for that region will be forwarded to the next closest Origin Shield region. This configuration is the equivalent of leaving a region blank from within the MCC.
  • Use the Get Origin Shield POPs endpoint to retrieve a list of regions, the Origin Shield POPs associated with those regions, and each POP's PCI-compliance status (is_pci_certified).

strict_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

tls_settings

Object

Contains settings that define TLS behavior.

Delivery over TLS requires a TLS certificate, an edge CNAME, and a CNAME record.
Learn more.

tls_settings Object

The tls_settings object defines TLS behavior through the following properties:

Name Data Type Description

allow_self_signed

Boolean

Indicates whether our CDN will allow delivery when an edge server detects a self-signed certificate from the origin server during the TLS handshake.

The corresponding MCC setting is Disallow Self-Signed. If you set the allow_self_signed property to True, then the Disallow Self-Signed option will be set to False.

public_keys_to_verify

Array of string values

Contains a list of SHA-1 digests for the public key of your end-entity (i.e., leaf) certificate.

sni_hostname

String

Indicates the hostname that will be sent as a SNI hint during the TLS handshake for this customer origin group.

Our service will not use Server Name Indication (SNI) during the TLS handshake for this customer origin group when this property is set to null or an empty value.

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.

GET https://api.vdms.io/cdn/origins/v0.5/http-large/groups/2471675 HTTP/1.1

Authorization: Bearer A1bcbGciOiJSUzI1NiIsImtpZCI6Ij13N1VGQ01z...A1bcbGciOiJSUzI1NiIsImtpZCI6Ij13N1VGQ01zOTIzQjI1MTYzRjU4MU1wQ0I3MUNBRDk3QjAzNkUwQjgiLCJ01XAiOiJKV1QiLCJ4NXQiOiJGMDc4bzVJN0pSWV9XQm9Ndcc5dGw3QTI0TGcifQ.1yJuYmYiOj11NjUzMDgwNzgsImV4cCI6MTU2NTMwODM3OCwiaXNzIjoiacR0ccM6Ly9pZC52ZG1zLmlvIiwiYXVkIjpbImc0dcBzOi8vaWQudmRtcy5pby9yZXNvdXJjZXMiLCJlYy5ydWxlcyJdLCJjbGllbnRfaWQiOiIxNTccOWZmZi04MTQzLTRmOW1tOWY1Yi1jNDgzZWVkNzclM2QiLCJzY29wZSI6WyJlYy5ydWxlcyJdfQ.XQ4TvzDrwLo4bO71cb1TbgYxmtcgTzC46Do0A9F3inAqw1qcr_Nr9IgRDxJDqR4Udc9QR86LVTQC2-ogGWP3pI12GtDtiUQdKYs5fpcuMf2Kbqau6kuU1M5BJm_GOcBNCCAJnU7SrDprVbPlwanGqk3yjcyo9nto8KWCRTwq2t31UQ1Ci31FZSr4vaMZJqk1vBW6NS3-yGowGCZbSIQBKpSgcc75coPtSjF1Qi6M4yORDyMC8c3KKlIp2b-6mpfDFXINIFV-XvnNuQ9v-lcc43_VWuDA_cQO8wmS4VzS1Ac1tpg1Pp4Bcdtjt12yKAXvi0X19R1BDmpxmO17cRRKYQ

Accept: application/json

Content-Type: application/json

Host:api.vdms.io

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: REPLACEME

{
	"id": 2641409,
	"name": "marketing",
	"host_header": "marketing.example.com",
	"shield_pops": [],
	"network_type_id": 1,
	"strict_pci_certified": false,
	"tls_settings": null
}
ClosedGet All Customer Origin Groups (ADN)

Get Customer Origin Group (ADN)

Retrieve a specific customer origin group for the ADN delivery platform.

Request

A request to retrieve a customer origin group is described below.

HTTP Method Request URI

GET

https://api.vdms.io/cdn/origins/v0.5/adn/groups/Customer Origin Group ID

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

Customer Origin Group ID

Required

Replace this variable with the desired origin group's system-defined ID.

Use the Get All Customer Origin Groups (ADN) endpoint to retrieve a list of origin entries and their system-defined IDs.

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 contains the following response elements for each customer origin group returned by this endpoint:

Name Data Type Description

gateway

Object

Describes this customer origin group's ADN gateway configuration.

host_header

String

Indicates the value that will be assigned to the Host header for all requests to this customer origin configuration.

id

Integer

Indicates the customer origin group's system-defined ID.

name

String

Indicates the customer origin group's name.

network_type_id

Integer

Indicates the method for resolving hostnames through its system-defined ID. Valid values are:

  • 1: Default. Indicates that the IP preference for this customer origin will be system-defined. Currently, this configuration causes hostnames to be resolved to IPv4 only.
  • 2: IPv6 Preferred over IPv4. Indicates that although hostnames for this customer origin can be resolved to either IP version, a preference will be given to IPv6.
  • 3: IPv4 Preferred over IPv6. Indicates that although hostnames for this customer origin can be resolved to either IP version, a preference will be given to IPv4.
  • 4: IPv4 Only. Indicates that hostnames for this customer origin can only be resolved to IPv4.
  • 5: IPv6 Only. Indicates that hostnames for this customer origin can only be resolved to IPv6.

Use the Get Available Hostname Resolution Methods endpoint to retrieve a list of methods and their system-defined IDs.

tls_settings

Object

Contains settings that define TLS behavior.

Delivery over TLS requires a TLS certificate, an edge CNAME, and a CNAME record.
Learn more.

validation_path

String

Indicates the URL to a sample asset. A set of optimal ADN gateway servers for this customer origin group is determined through the delivery of this sample asset.

gateway Object

The gateway object describes an ADN gateway configuration through the following properties:

Name Data Type Description

follow_redirect

Boolean

Indicates whether our edge servers will respect a URL redirect when validating the set of optimal ADN gateway servers for this customer origin group.

gateway_reselection

Boolean

Returns False.

pop_last_update

String

Indicates the timestamp at which the most recent ADN gateway selection took place.

pops

Array of objects

Contains this customer origin group's ADN gateway configuration.

selected

Boolean

Indicates whether an ADN gateway has been associated with this customer origin group.

selection_error

String

Indicates the error message that occurred during ADN gateway selection. Returns a null value if an error did not occur during ADN gateway selection.

selection_last_requested

String

Indicates the timestamp at which you manually requested ADN gateway selection for this customer origin group.

pops Array

The pops array describes each ADN gateway configuration through the following properties:

Name Data Type Description

city

String

Indicates the ADN gateway's city.

code

String

Indicates the ADN gateway's POP code.

ordinal

Integer

Indicates the ADN gateway's failover position. Valid values are:

  • 1: Identifies the primary ADN gateway through which all requests will flow.
  • 2: Identifies a backup ADN gateway through which traffic will flow when the primary ADN gateway is unavailable.
  • 3: Identifies a backup ADN gateway through which traffic will flow when both the primary and backup ADN gateway is unavailable.

region

String

Indicates the ADN gateway's region.

tls_settings Object

The tls_settings object defines TLS behavior through the following properties:

Name Data Type Description

allow_self_signed

Boolean

Indicates whether our CDN will allow delivery when an edge server detects a self-signed certificate from the origin server during the TLS handshake.

The corresponding MCC setting is Disallow Self-Signed. If you set the allow_self_signed property to True, then the Disallow Self-Signed option will be set to False.

public_keys_to_verify

Array of string values

Contains a list of SHA-1 digests for the public key of your end-entity (i.e., leaf) certificate.

sni_hostname

String

Indicates the hostname that will be sent as a SNI hint during the TLS handshake for this customer origin group.

Our service will not use Server Name Indication (SNI) during the TLS handshake for this customer origin group when this property is set to null or an empty value.

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.

GET https://api.vdms.io/cdn/origins/v0.5/adn/groups/1744035 HTTP/1.1

Authorization: Bearer A1bcbGciOiJSUzI1NiIsImtpZCI6Ij13N1VGQ01z...A1bcbGciOiJSUzI1NiIsImtpZCI6Ij13N1VGQ01zOTIzQjI1MTYzRjU4MU1wQ0I3MUNBRDk3QjAzNkUwQjgiLCJ01XAiOiJKV1QiLCJ4NXQiOiJGMDc4bzVJN0pSWV9XQm9Ndcc5dGw3QTI0TGcifQ.1yJuYmYiOj11NjUzMDgwNzgsImV4cCI6MTU2NTMwODM3OCwiaXNzIjoiacR0ccM6Ly9pZC52ZG1zLmlvIiwiYXVkIjpbImc0dcBzOi8vaWQudmRtcy5pby9yZXNvdXJjZXMiLCJlYy5ydWxlcyJdLCJjbGllbnRfaWQiOiIxNTccOWZmZi04MTQzLTRmOW1tOWY1Yi1jNDgzZWVkNzclM2QiLCJzY29wZSI6WyJlYy5ydWxlcyJdfQ.XQ4TvzDrwLo4bO71cb1TbgYxmtcgTzC46Do0A9F3inAqw1qcr_Nr9IgRDxJDqR4Udc9QR86LVTQC2-ogGWP3pI12GtDtiUQdKYs5fpcuMf2Kbqau6kuU1M5BJm_GOcBNCCAJnU7SrDprVbPlwanGqk3yjcyo9nto8KWCRTwq2t31UQ1Ci31FZSr4vaMZJqk1vBW6NS3-yGowGCZbSIQBKpSgcc75coPtSjF1Qi6M4yORDyMC8c3KKlIp2b-6mpfDFXINIFV-XvnNuQ9v-lcc43_VWuDA_cQO8wmS4VzS1Ac1tpg1Pp4Bcdtjt12yKAXvi0X19R1BDmpxmO17cRRKYQ

Accept: application/json

Content-Type: application/json

Host:api.vdms.io

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: 534

{
	"id": 2641674,
	"name": "sales",
	"host_header": "www.example.com",
	"validation_path": "http://www.example.com",
	"network_type_id": 1,
	"gateway": {
		"selection_last_requested": "2022-06-18T01:09:36Z",
		"follow_redirect": true,
		"pop_last_update": "2019-08-08T20:30:45Z",
		"selection_error": null,
		"selected": false,
		"gateway_reselection": false,
		"pops": []
	},
	"tls_settings": null
}