This endpoint is currently available as a BETA. Business-critical processes should not depend on this functionality.
Retrieve all of the origin entries associated with a customer origin group through a platform-specific endpoint.
These endpoints return two origin entries for each origin entry configured to match the client's protocol (i.e., match client). Specifically, they return both an HTTP and a HTTPS version of the origin entry. These linked origin entries are assigned the same system-defined ID.
Use the cdn.origins scope to authenticate and authorize requests for the Origins API.
Request
A request to retrieve a customer origin group's origin entries is described below.
| HTTP Method | Request URI |
|---|---|
|
GET |
HTTP Large: https://api.vdms.io/cdn/origins/v0.5/http-large/groups/Customer Origin Group ID/origins ADN: https://api.vdms.io/cdn/origins/v0.5/adn/groups/Customer Origin Group ID/origins |
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 |
|---|---|
|
Required |
Replace this variable with the desired origin group's system-defined ID. Use the Get All Customer Origin Groups (HTTP Large) or the Get All Customer Origin Groups (ADN) endpoint to retrieve a list of origin entries and their system-defined IDs. |
This endpoint only takes advantage of common request headers.
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.
A status code indicates whether the request was successfully performed.
The response for this endpoint only includes standard HTTP response headers.
The response body for a successful request contains the following response elements for each origin entry returned by this endpoint:
| Name | Data Type | Description |
|---|---|---|
|
failover_order |
Integer |
Indicates this origin entry's sort position as a 0-based number. Position 0 is reserved for the primary origin entry as determined by the is_primary field. The primary purpose of this position is to determine the order in which requests are load balanced for Primary / Failover mode. If a primary origin entry has been defined for this protocol, then all traffic for that protocol will be directed to the origin entry that has the lowest value. If the hostname or IP address associated with that origin entry is unreachable, then traffic will be directed to the next lowest value. This process will continue until our service can establish communication with your origin. |
|
host |
String |
Identifies the web server(s) that will be associated with this origin entry through either a hostname or IP address. Key information:
|
|
id |
Integer |
Indicates the origin entry's system-defined ID. |
|
is_primary |
Boolean |
Indicates whether this origin entry identifies the primary hostname or IP address for the protocol defined within the protocol_type_id property. You may only enable this property on a single origin entry within a customer origin group per protocol. For the purpose of this restriction, an origin entry that uses the Match Client mode is considered to be assigned both HTTP and HTTPS. This property is critical for determining how requests are load balanced. Setup for both modes are described below.
|
|
name |
String |
Indicates the origin entry's name. |
|
port |
Integer |
Indicates the port for communication with your origin servers. Default Value: This property's default value varies according to the value defined within the protocol_type_id property. 80 | 443
|
|
protocol_type_id |
Integer |
Indicates this origin entry's protocol through its system-defined ID. Valid values are:
Use the Get Available Protocols endpoint to retrieve a list of protocols and their system-defined IDs. Default Value: 1
|
|
storage_type_id |
Integer |
Indicates the origin group's type through its system-defined ID. Valid values are:
Default Value: 1
|
The response body for an unsuccessful request may contain an error element that provides additional information.
Sample Request and Response (JSON)
A sample JSON request is shown below.
GET https://api.vdms.io/cdn/origins/v0.5/http-large/groups/12345/origins HTTP/1.1
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: 441
[{
"id": 5036042,
"name": "marketing-origin-entry-a",
"host": "https://cdn-lb.example.com",
"port": 443,
"is_primary": false,
"storage_type_id": 1,
"protocol_type_id": 2,
"failover_order": 0
}, {
"id": 5036043,
"name": "marketing-origin-entry-b",
"host": "https://cdn-lb2.example.com",
"port": 443,
"is_primary": false,
"storage_type_id": 1,
"protocol_type_id": 2,
"failover_order": 1
}
]