Configuration API

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:

    Name

    Position

    Type

    Required

    recreate

    formdata

    boolean

    optional

    tenantName

    formdata

    string

    required

    zipFile

    formdata

    file

    required

  • Response:DeployTestAssetResponse

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:

    Name

    Position

    Type

    Required

    tenantName

    formdata

    string

    required

    version

    formdata

    integer

    required

    zipFile

    formdata

    file

    required

  • Response:DeployProductionAssetResponse

Repair Production Configuration

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.

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
}