Get Customer Origin Group Status - BETA

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

Find out a customer origin group's propagation status through a platform-specific endpoint.

You may only retrieve propagation status information for customer origin groups that contain at least one origin entry.

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.

Request

A request to find out a customer origin group's propagation status 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/status ADN: https://api.vdms.io/cdn/origins/v0.5/adn/groups/Customer Origin Group ID/status

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 Origin Groups (HTTP Large) or the Get All 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:

Name	Data Type	Description
state	String	Indicates the customer origin group's current propagation status. Valid values are: New: Indicates that the configuration has been created, but the propagation process has not started. A new configuration may stay in this state for a few minutes while it undergoes a validation/verification process. propagating: Indicates that the configuration is in the process of being propagated. propagated: Indicates that the configuration has been propagated across the entire network.
percent_propagated	Decimal	Indicates the average configuration propagation percentage across all POPs.
pops	Array of objects	Contains a list of POPs and their current configuration propagation percentage.

pops Array

The pops array describes a customer origin group's propagation status for each POP through the following properties:

Name	Data Type	Description
name	String	Identifies a POP by region and name. Syntax (Single POP per Location): Region : POPName Syntax (Multiple POPs per Location): If a location contains multiple POPs, then a three-letter abbreviation will identify each POP: Region : POPName (POP)
percentage_propagated	Decimal	Indicates the percentage of servers within a POP to which the configuration has been propagated.

Errors

The response body for an unsuccessful request may contain an error element that provides additional information.

View common error messages.

Invalid Customer Origin Group

Requesting propagation status for a customer origin group that either does not exist or does not contain at least one origin entry returns a 404 Not Found.

Sample response:

{
	"errors": [{
			"id": "5757D0464DB0404DA155590A7FEECC83",
			"code": "not_found"
		}
	]
}

Sample Request and Response (JSON)

A sample JSON request is shown below.

A sample JSON response is shown below.

{
    "state": "propagated",
    "percent_propagated": 100.0,
    "pops": [
        {
            "name": "North America : Atlanta",
            "percentage_propagated": 100.0
        }
    ]
}