Configuration API
Endpoint Index
Action | Endpoint |
---|---|
Deploy test configuration | POST /configuration/studio/deploy |
Deploy production configuration | POST /configuration/deploy |
Repair test configuration | POST /configuration/studio/repair |
Repair production configuration | POST /configuration/repair |
Deploy configuration | POST /configuration/deployTest |
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.
Deploy test configuration¶
POST /configuration/studio/deploy
Name | Position | Type | Required |
---|---|---|---|
recreate | formdata | boolean | required |
tenantName | formdata | string | required |
zipFile | formdata | file | required |
DeployTestAssetResponse¶
requiredhostname stringlogfile stringsuccess booleantenantName string
Deploy production configuration¶
POST /configuration/deploy
Name | Position | Type | Required |
---|---|---|---|
tenantName | formdata | string | required |
zipFile | formdata | file | required |
DeployProductionAssetResponse¶
requiredhostname stringlogfile stringsuccess booleantenantName string
Repair test configuration¶
POST /configuration/studio/repair
Name | Position | Type | Required |
---|---|---|---|
tenantName | formdata | string | required |
version | formdata | integer | required |
zipFile | formdata | file | required |
Repair production configuration¶
POST /configuration/repair
Name | Position | Type | Required |
---|---|---|---|
tenantName | formdata | string | required |
version | formdata | integer | required |
zipFile | formdata | file | required |
See the Product Versioning Repair topic for information on using the repair endpoints.
Legacy Deployment Endpoints
Note
These endpoints are not enabled for product-versioning-enabled tenants.
Deploy configuration¶
POST /configuration/deployTest
Name | Position | Type | Required |
---|---|---|---|
tenantNameSuffix | formdata | string | optional |
zipFile | formdata | file | required |
DeployTestConfigurationLegacyResponse¶
requiredhostname stringlogfile stringsuccess booleantenantName string