This endpoint is currently available as a BETA. Business-critical processes should not depend on this functionality.
Add an origin entry to a customer origin group through a platform-specific endpoint.
Key information:
ADN Origin Entries:
This endpoint will only create an ADN origin entry once it has successfully validated communication with our ADN gateway servers. It uses the following information to communicate with your server(s):
Use the cdn.origins scope to authenticate and authorize requests for the Origins API.
Request
Platform-specific requests to create an origin entry are described below.
| HTTP Method | Request URI |
|---|---|
|
POST |
HTTP Large: https://api.vdms.io/cdn/origins/v0.5/http-large ADN: https://api.vdms.io/cdn/origins/v0.5/adn |
This endpoint only takes advantage of common request headers.
The request parameters for this endpoint are described below.
| Name | Data Type | Description |
|---|---|---|
|
group_id Required |
Integer |
Identifies the origin entry's customer origin group. |
|
host Required |
String |
Identifies the web server(s) that will be associated with this origin entry through either a hostname or IP address. Key information:
|
|
is_primary Required |
Boolean |
Determines 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 |
Defines the origin entry's name. |
|
port |
Integer |
Determines 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 |
Determines 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 |
Identifies the origin group's type through its system-defined ID. Valid values are:
Default Value: 1
|
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 element:
| Name | Data Type | Description |
|---|---|---|
|
group_id |
Integer |
Indicates the origin entry's customer origin group. |
|
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.
POST https://api.vdms.io/cdn/origins/v0.5/http-large HTTP/1.1
Accept: application/json
Content-Type: application/json
Host:api.vdms.io
{
"name": "marketing-origin-entry-a",
"group_id": 12345,
"is_primary": false,
"storage_type_id": 1,
"protocol_type_id": 2,
"host": "cdn-lb.example.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: 205
{
"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,
"group_id": 12345
}