Deployments API

Endpoint Index

Action	Endpoint
Fetch versions in use	GET /deployments/versions
Fetch configuration zip file	GET /deployments/{configVersion}
Get status of a deployment	GET /deployments/status

Product Version Deployment History

The product versions that are in use in your system can be obtained with the following endpoint:

Fetch versions in use¶

GET /deployments/versions

Response: [ConfigurationVersionResponse]

ConfigurationVersionResponse¶

required
deployedTimestamp timestamp
version integer

Note

The deployedTimestamp indicates when the zip file was deployed. If the configuration has been repaired, a separate ConfigurationVersionResponse will be included with the timestamp of the repair, so there may be more than one entry for each version number.

Retrieving Configurations

The following endpoint will return a url that will allow you to download the configuration zip file that was deployed for a given version:

Fetch configuration zip file¶

GET /deployments/{configVersion}

Request:

Name	Position	Type	Required
configVersion	path	integer	required

Response: TenantAssetsUrlResponse

TenantAssetsUrlResponse¶

required
expiresTimestamp timestamp
tenantAssets TenantAssetsResponse
url string

Retrieving Deployment Status

Get status of a deployment¶

GET /deployments/status

Request:

Name	Position	Type	Required
tenantName	query	string	required
version	query	integer	optional

Response: DeploymentStatusResponse

DeploymentStatusResponse¶

required
deploymentStatus string INPROGRESS | DEPLOYED

optional
deploymentTimestamp timestamp
version integer