Configuration API

Endpoint Index

ActionEndpoint
Deploy test configurationPOST /configuration/studio/deploy
Deploy production configurationPOST /configuration/deploy
Repair test configurationPOST /configuration/studio/repair
Repair production configurationPOST /configuration/repair
Deploy configurationPOST /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
    Request:
    NamePositionTypeRequired
    recreateformdatabooleanrequired
    tenantNameformdatastringrequired
    zipFileformdatafilerequired
DeployTestAssetResponse
required
hostname string
logfile string
success boolean
tenantName string
Deploy production configuration
POST /configuration/deploy
DeployProductionAssetResponse
required
hostname string
logfile string
success boolean
tenantName string
Repair test configuration
POST /configuration/studio/repair
    Request:
    NamePositionTypeRequired
    tenantNameformdatastringrequired
    versionformdataintegerrequired
    zipFileformdatafilerequired
Repair production configuration
POST /configuration/repair
    Request:
    NamePositionTypeRequired
    tenantNameformdatastringrequired
    versionformdataintegerrequired
    zipFileformdatafilerequired

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
DeployTestConfigurationLegacyResponse
required
hostname string
logfile string
success boolean
tenantName string