Skip to navigation
Deployment ManagerMetadata Deployment

Compare and deploy a source tenant to a target tenant

View as Markdown
Compare and deploy a source tenant to a target tenant.

Authentication

AuthorizationBearer

Use Bearer {{token}} in the Authorization header for authentication.

Headers

Zuora-Entity-IdsstringOptional

An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.

Request

This endpoint expects a multipart form.
namestringRequired
Deployment's name.
descriptionstringRequired
Deployment's description.
sendEmailbooleanRequired
Specifies if an email should be sent.
emailsstringOptional

If sendEmail parameter is set to true, comma separated values of emails can be specified. Example email1@test.com,email2@test.com.

commentsstringOptional
Content of the email to be sent.
settingsbooleanRequired
Specified if settings module should be considered in the deployment process.
notificationsbooleanRequired
Specified if notifications module should be considered in the deployment process.
workflowsbooleanRequired
Specified if workflows module should be considered in the deployment process.
customFieldsbooleanRequired
Specified if customFields module should be considered in the deployment process.
customObjectsbooleanOptional
Specified if customObjects module should be considered in the deployment process.
productCatalogbooleanRequired
Specified if productCatalog module should be considered in the deployment process.
taxationbooleanOptional
Specified if taxation module should be considered in the deployment process.
userRolesbooleanRequired
Specified if userRoles module should be considered in the deployment process.
reportingbooleanRequired
Specified if reporting module should be considered in the deployment process.
sourceTenantIdstringRequired
Id of the source tenant.

Response headers

RateLimit-Remainingdouble

The number of requests remaining in the time window closest to quota exhaustion. See rate limits for more information.

RateLimit-Resetdouble

The number of seconds until the quota resets for the time window closest to quota exhaustion. See rate limits for more information.

Content-EncodingstringOptional

This header is returned if you specify the Accept-Encoding: gzip request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses:

  • application/json
  • application/xml
  • text/html
  • text/csv
  • text/plain
RateLimit-LimitstringOptional

The request limit quota for the time window closest to exhaustion. See rate limits for more information.

Zuora-Request-IdstringOptional
The Zuora internal identifier of the API call. You cannot control the value of this header.
Zuora-Track-IdstringOptional
A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.

Response

OK
idstringOptional
ID of the Deployment Manager migration process
statusenumOptional
Status of the Deployment Manager migration process