Show search and navigation.

 

Get All Origin Entries - BETA

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

Retrieves all origin entries through a platform-specific endpoint.

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

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

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 origin entries is described below.

HTTP Method Request URI

GET

HTTP Large:

https://api.vdms.io/cdn/origins/v0.5/http-large

ADN:

https://api.vdms.io/cdn/origins/v0.5/adn

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 origin entry returned by this endpoint:

Name Data Type Description

cloud_storage

Object

Azure Block Blob Storage Only

Reserved for future use.

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:

  • Our service resolve hostnames to an IP address prior to delivery. The customer origin group's network_type_id property determines how hostnames will be resolved to an IP address.

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.

For example, enabling this property on an origin entry that uses the Match Client mode will cause it to be the primary origin entry for both HTTP and HTTPS.

This property is critical for determining how requests are load balanced. Setup for both modes are described below.

  • Primary / Failover: Our service load balances requests using primary / failover mode when this property is enabled on an origin entry within the desired customer origin group. This load balancing mode is restricted to that origin entry's protocol. If that origin entry has been configured to use the Match Client mode, then requests will be load balanced for both HTTP and HTTPS.
  • Round-Robin: Our service load balances requests using round-robin mode when this property is disabled on all origin entries within the desired customer origin group for the desired protocol.

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:

  • 1: HTTP Only
  • 2: HTTPS Only
  • 3: Match Client

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:

  • 1: Customer origin group

Default Value:

1

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

[{
		"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
	}, {
		"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,
		"group_id": 12345
	}
]