Get Customer Origin Status

Retrieves the propagation status for a customer origin configuration.

This endpoint does not return propagation status for customer origin configurations that were updated more than 7 days ago.

Request

A request to retrieve status information is described below.

HTTP Method	Request URI
GET	https://api.transactcdn.com/v2/mcc/customers/AccountNumber/origins/CustomerOriginID/status

Define the following variables 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
AccountNumber Required	Replace this variable with a customer account number. This account number may be found in the upper left-hand corner of the TCC.
CustomerOriginID Required	Replace this variable with the system-defined ID of the desired customer origin configuration. A list of customer origin configurations and their corresponding system-defined IDs can be retrieved through the following endpoint: Get All Customer Origins - CAN

Request Headers

This endpointIdentifies a request's connection point to our REST API service. 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 varies according to the following factors:

• New / Update: The following response will be provided immediately after a customer origin configuration is created or updated:

  {
  	"Status": "New",
  	"Percent_propagated": 0
  }

• Existing Configurations: If the customer origin configuration is older than 7 days, then this endpoint will return a 400 Bad Request with the following response body:

  {
  	"Message": "Action Queue Id missing"
  }

• Deployment: Once the deployment of the new/updated customer origin configuration begins, the response body will contain the following response elements:

  Name	Data Type	Description
  Status	String	Indicates the customer origin'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	Contains a list of POPs and their current configuration propagation percentage.
  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.

Sample Request and Response

A sample request is shown below.

A sample response is shown below.

{
	"Status": "propagating",
	"Percent_propagated": 8.759656026818249,
	"Pops": [{
			"name": "South America : Valparaiso, Chile",
			"percentage_propagated": 15.789473684210526
		}, {
			...
			"name": "South America : Lima, Peru",
			"percentage_propagated": 14.285714285714285
		}, {
			"name": "North America : San Jose",
			"percentage_propagated": 14.000000000000002
		}, {
			"name": "Europe : London (LHR2)",
			"percentage_propagated": 15.894039735099339
		}, {
			"name": "Australia : Auckland",
			"percentage_propagated": 23.076923076923077
		}
	]
}