Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zuora Configuration Templates API

Configuration Templates in Zuora Deployment Manager enable you to configure your tenants in minutes by importing a templated metadata configuration file. This feature eliminates the need for long manual configuration processes that would have previously taken hours. You will be able to access a comprehensive repository of industry-specific templates. It will be easier for you to deploy and release.

Zuora Configuration Templates API is one of 80 APIs that Zuora publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Configuration Templates. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 8 operations across 6 paths, and defines 13 schemas. It is described by OpenAPI 2.0, at version 2023-12-15.

8 operations 6 paths 13 schemas 1 DELETE4 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
2023-12-15
Resource Areas
1

Paths & Operations 8

Across 6 paths, the API surfaces 8 operations — 1 DELETE, 4 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Configuration Templates 8

Configuration Templates in Zuora Deployment Manager enable you to configure your tenants in minutes by importing a templated metadata configuration file. This feature eliminates t…

POST
/deployment-manager/deployment_templates
Create a deployment template
POST_DeploymentTemplate 8 params → 200201400401403404
GET
/deployment-manager/deployment_templates
List all templates
GET_Templates 6 params → 200400401403404
GET
/deployment-manager/deployment_templates/{id}
List all details of a template
GET_DeploymentTemplateDetail 7 params → 200400401403404
DELETE
/deployment-manager/deployment_templates/{id}
Delete a template
DELETE_DeploymentTemplate 7 params → 200204400401403404
GET
/deployment-manager/deployment_artifacts
Download a template
GET_DownloadDeploymentTemplate 7 params → 200400401403404
GET
/deployment-manager/deployment_artifacts/retrieve-settings
List all details of source components
GET_SourceComponentDetails 6 params → 200400401403404
POST
/deployment-manager/deployment_artifacts/compare
Compare settings between a source tenant and a target tenant
POST_CompareTemplate 9 params → 200201401403404
POST
/deployment-manager/deployment_artifacts/deploy
Migrate settings from source tenant to target tenant
POST_MigrateTenantSettings 9 params → 200201400401403404

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are MigrationComponentContent (18 properties), MigrationClientResponse (13 properties), TemplateDetailResponse (12 properties), ConfigurationTemplateContent (10 properties). Each schema is shown below with its type and property counts.

MigrationClientResponse
object
Response after migration is added.
13 properties 9 required
CompareSchemaKeyValue
object
When a comparison is made between a source and target tenant, it sends a response to the user interface.
3 properties
ConfigTemplateErrorResponse
object
1 property
JsonNode
object
Json node object contains metadata.
ConfigurationTemplateContent
object
It contains information about template schemas with segregation keys.
10 properties
CreateTemplateRequestContent
object
CreateTemplateRequestContent object contains information for creating template.
10 properties 3 required
CompareSchemaInfoResponse
object
When Tenant's Compare API returns a result, this object is used to send the response to UI.
8 properties
SettingSourceComponentResponse
object
Provides details about the different components that need to be compared and deployed.
7 properties
SettingComponentKeyValue
object
Provides details about the individual components that need to be compared and deployed.
4 properties
TemplateDetailResponse
object
Contains all template details.
12 properties
TemplateResponse
object
It contains a collection of all the templates that have been created.
1 property
TemplateMigrationClientRequest
object
Request to add a new Template migration. TemplateMigrationClientRequest object contains request details of target tenant, source tenant, and template informati…
8 properties 4 required
MigrationComponentContent
object
When a comparison is made between a source and target tenant, it sends a response to the user interface.
18 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zuora-configuration-templates-api-openapi.yml Raw ↑

Other APIs Zuora publishes across the network.

Zuora V1 API
Zuora Accounting Codes API
Zuora Accounting Periods API
Zuora Accounts API
Zuora Actions API
Zuora Aggregate Queries API
Zuora API Health API
Zuora Attachments API
Zuora Bill Run API
Zuora Bill Run Health API
Zuora Billing Documents API
Zuora Billing Preview Run API