Configuration API

Important

Deployment and Repair endpoints that are marked as “with product versioning” will turn Product Versioning on for the tenant. After using this endpoint, Product Versioning cannot be turned off. Ensure that you intend to use product versioning if you use Product Versioning enabled endpoints.

Endpoint Index

Action	Endpoint
Deploy test configuration WITH Product Versioning	POST /configuration/studio/deploy
Deploy test configuration WITHOUT Product Versioning	POST /configuration/deployTest
Repair test configuration WITH Product Versioning	POST /configuration/studio/repair
Deploy production configuration WITH Product Versioning	POST /configuration/deploy
Deploy production configuration WITHOUT Product Versioning	POST /assets/v1/deploy
Repair production configuration WITH Product Versioning	POST /configuration/repair

Configuration Deployment to Test Tenants

Note

The test deploy endpoints are intended for tenants created as test tenants. These tenants are usually created using configuration studio. Production tenants use different endpoints, below.

Warning

Do not use the deployment endpoint for Product Versioning or the Repair endpoint unless you intend to use product versioning in the tenant. After enabling product versioning, it cannot be turned off.

Deploy test configuration WITH Product Versioning¶

POST /configuration/studio/deploy

Request:

Name	Position	Type	Required
recreate	formdata	boolean	required
zipFile	formdata	file	required

Response: DeployTestAssetResponse

Deploy test configuration WITHOUT Product Versioning¶

POST /configuration/deployTest

Request:

Name	Position	Type	Required
tenantNameSuffix	formdata	string	optional
zipFile	formdata	file	required

Response: DeployTestAssetResponse

DeployTestAssetResponse¶

required
hostname string
logfile string
success boolean
tenantName string

Repair test configuration WITH Product Versioning¶

POST /configuration/studio/repair

Request:

Name	Position	Type	Required
version	formdata	integer	required
zipFile	formdata	file	required

Response: DeployProductionAssetResponse

Configuration Deployment to Production Tenants

Warning

Do not use the deployment endpoint for Product Versioning or the Repair endpoint unless you intend to use product versioning in the tenant. After enabling product versioning, it cannot be turned off.

Deploy production configuration WITH Product Versioning¶

POST /configuration/deploy

Request:

Name	Position	Type	Required
tenantName	formdata	string	required
zipFile	formdata	file	required

Response: DeployProductionAssetResponse

Deploy production configuration WITHOUT Product Versioning¶

POST /assets/v1/deploy

Request:

Name	Position	Type	Required
tenantName	formdata	string	required
zipFile	formdata	file	required

Response: DeployProductionAssetResponse

Note

If Product Versioning is turned on this endpoint will repair the latest configuration. It will not create a new version.

DeployProductionAssetResponse¶

required
hostname string
logfile string
success boolean
tenantName string

Repair production configuration WITH Product Versioning¶

POST /configuration/repair

Request:

Name	Position	Type	Required
tenantName	formdata	string	required
version	formdata	integer	required
zipFile	formdata	file	required

Response: DeployProductionAssetResponse

See the Product Versioning Repair topic for information on using the repair endpoints.