Get Deploy Request Status

Retrieves the propagation status for a deploy request to the production environment.

This endpoint does not support the retrieval of propagation status for deploy requests submitted to the staging environment.

Request

Retrieve deploy request status information via the following request:

HTTP Method	Request URI
GET	https://api.transactcdn.com/v2/mcc/customers/AccountNumber/rulesv4/DeployRequestID/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
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.
DeployRequestID Required	Replace this variable with the system-defined ID of the desired deploy request. Find out a deploy request's ID by performing the following steps: Open the customer's MCC. Navigate to the Rules Engine page for the desired platform. Find the Production section and then click either the policy name or the "View deploy request link." Look up the desired deploy request's ID in the breadcrumb navigation.

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 contains the following response elements:

Name	Data Type	Description
Status	String	Indicates the deploy request'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 : POP Location Syntax (Multiple POPs per Location): If a location contains multiple POPs, then a three-letter abbreviation will identify each POP: Region : POP Location (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 will contain an error response that provides additional information.

Staging Environment Deploy Requests

Requesting propagation status for a deploy request submitted to the Staging environment will return a 500 Internal Server Error with the following response body:

{
	"Message": "Operation Error. Contact Administrator"
}	

Sample Request and Response

A sample request is shown below.

A sample JSON response is shown below.

{
	"Status": "propagating",
	"Percent_propagated": 2.666083916083916,
	"Pops": [{
			"name": "South America : Valparaiso, Chile",
			"percentage_propagated": 5.263157894736842
		}, {
			...
			"name": "South America : Lima, Peru",
			"percentage_propagated": 10.0
		}, {
			"name": "North America : San Jose",
			"percentage_propagated": 4.0
		}, {
			"name": "Australia : Auckland",
			"percentage_propagated": 3.7037037037037033
		}
	]
}