Skip to navigation
Deployment ManagerConfiguration Templates

Create a deployment template

View as Markdown

Creates templates based on user preference. There are 2 ways to select components.

  • Selecting the whole component.
  • Advanced Options -> which helps user to select specific components to be migrated.

It takes the enviroment details from the logged in user automatically, while creating the template.

Authentication

AuthorizationBearer

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

Headers

Idempotency-KeystringOptional<=255 characters
Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.
Accept-EncodingstringOptional

Include the Accept-Encoding: gzip header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.

If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a Content-Encoding header with the compression algorithm so that your client can decompress it.

Content-EncodingstringOptional

Include the Content-Encoding: gzip header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.

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 should not set this header.

Zuora-Org-IdsstringOptional

Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.

The IDs must be a sub-set of the user’s accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user’s accessible orgs.

Zuora-Track-IdstringOptional<=64 characters

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.

The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Request

CreateTemplateRequestContent JSON object which contains the details to create a template.
descriptionstringRequired
Creates template description.
namestringRequired
Name of the Template.
templateTenantstringRequired
ID of the template tenant.
contentobjectOptional
Provides details about the different components that need to be compared and deployed.
customFieldsbooleanOptional
Selected custom fields component or not.
customObjectsbooleanOptional
Selected custom objects component or not.
notificationsbooleanOptional
Selected Notification component or not.
selectedComponentslist of objectsOptional
ConfigurationTemplateContent object contains the selected meta data information.
settingsbooleanOptional
Selected Settings component or not.
workflowsbooleanOptional
Selected Workflow component or not.

Response headers

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.

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.

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

Successfully created the template.
activebooleanOptional
Whether or not the template is active.
contentobjectOptional
Provides details about the different components that need to be compared and deployed.
createdBystringOptional
Information about the user who created it.
createdOnstringOptional
When it is created.
descriptionstringOptional
Template description which contains the information about the created template.
entityNamestringOptional
Name of the Entity
environmentstringOptional
Details of the environment in which the template was created.
errorsstringOptional
Error information.
idstringOptional
Id of the template.
namestringOptional
Name of the template.
statusstringOptional
The status of the template creation, such as whether it is in progress, completed, or failed.
tenantNamestringOptional
Tenant's name for whom the template is created.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error