Update Failover Order - BETA

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

Update a customer origin group's failover order through a platform-specific endpoint.

Key information:

• Sort order is defined on a per protocol basis.
• If you create an origin entry that is configured to match the client's protocol (protocol_type_id=3), then our service will create an HTTP and an HTTPS version of it. Each of these origin entries may be assigned a different sort order.
• Ensure that sort order is applied as intended by defining a sort position for all of the customer origin group's origin entries that correspond to the desired protocol (i.e., HTTP or HTTPS). Defining a sort position for a subset of origin entries that correspond to that protocol may produce unexpected results.

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

Request

A request to update a customer origin group's failover order is described below.

HTTP Method	Request URI
PATCH	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
Customer Origin Group ID Required	Replace this variable with the desired origin group's system-defined ID. Use either 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.

Request Headers

This endpoint only takes advantage of common request headers.

Request Body

Request parameters for this endpoint are described below.

Name	Data Type	Description
host Required	String	Set to the desired origin entry's host entry. You must specify an exact match for this origin entry's host property. Use the Update Origin Entry endpoint to modify an origin entry.
id Required	Integer	Set to the desired origin entry's system-defined ID. Use the Get All Origin Entries (HTTP Large) endpoint to retrieve a list of origin entries and their system-defined IDs.
failover_order Required	Integer	Determines this origin entry's sort position. Specify 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.

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. A successful update returns a 204 No Content response.

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 does not contain a response element.

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.

[{
		"id": 5036043,
		"host": "https://sales-lb.example.com",
		"failover_order": 1
	}, {
		"id": 5036044,
		"host": "https://sales-lb2.example.com",
		"failover_order": 0
	}
]

A successful update returns a 204 No Content response.