---
title: "Migrate settings from source tenant to target tenant"
method: POST
path: "/deployment-manager/deployment_artifacts/deploy"
tags: ["Configuration Templates"]
---

# Migrate settings from source tenant to target tenant

`POST /deployment-manager/deployment_artifacts/deploy`

To migrate the selected configuration of a tenant in Deployment Manager migration while using template from the compare screen.

## Query parameters

- `tenant` string, required

## Headers

- `Idempotency-Key` string
- `Accept-Encoding` string
- `Content-Encoding` string
- `Zuora-Entity-Ids` string
- `Zuora-Org-Ids` string
- `Zuora-Track-Id` string

## Request body

- TemplateMigrationClientRequest — Request to add a new Template migration. TemplateMigrationClientRequest object contains request details of target tenant, source tenant, and template information needed for migration.
  - `comments` string
  - `description` string, required — Description of the migration.
  - `emailIds` string — List of Emails with comma separator.
  - `entityUuid` string, required — Entity UUID
  - `metaData` JsonNode, nullable — Json node object contains metadata.
  - `name` string, required — Name of the migration.
  - `request` MigrationComponentContent[] — List of settings need to be migrated.
    - `attribute` string
    - `componentType` string — Type of selected components to be migrated.
    - `currentTargetResponse` JsonNode, nullable — Json node object contains metadata.
    - `description` string
    - `disabled` string
    - `errorMessage` string — Error information.
    - `httpMethods` string
    - `id` string
    - `key` string
    - `migratedOn` string, date-time — It is the time when migration is triggered.
    - `migrationId` string — Migration ID. It is generated at the time of triggering deployment.
    - `pathPattern` string — PathPattern of component.
    - `previousTargetResponse` JsonNode, nullable — Json node object contains metadata.
    - `result` string — Returns the result details of Components.
    - `segregationKey` string — Displays the differences between components.
    - `sourceResponse` JsonNode, nullable — Json node object contains metadata.
    - `status` string — Returns the status of each component.
    - `updateStatus` string — Updated Status.
  - `sendEmail` boolean, required — Flag determines whether or not to send an email.

## Response `200`

Successfully migrated from source to target.

- MigrationClientResponse — Response after migration is added.
  - `emailIds` string — List of Emails with comma separator
  - `environment` string — Environment information
  - `id` string, required — Variable to hold the job ID.
  - `migratedBy` string, required — User responsible for migration.
  - `migrationDescription` string, required — Description of the migration.
  - `migrationEnd` string, required — Timestamp when migration ended.
  - `migrationName` string, required — Name of the migration.
  - `migrationStart` string, required — Timestamp when migration started.
  - `response` MigrationComponentContent[]
    - `attribute` string
    - `componentType` string — Type of selected components to be migrated.
    - `currentTargetResponse` JsonNode, nullable — Json node object contains metadata.
    - `description` string
    - `disabled` string
    - `errorMessage` string — Error information.
    - `httpMethods` string
    - `id` string
    - `key` string
    - `migratedOn` string, date-time — It is the time when migration is triggered.
    - `migrationId` string — Migration ID. It is generated at the time of triggering deployment.
    - `pathPattern` string — PathPattern of component.
    - `previousTargetResponse` JsonNode, nullable — Json node object contains metadata.
    - `result` string — Returns the result details of Components.
    - `segregationKey` string — Displays the differences between components.
    - `sourceResponse` JsonNode, nullable — Json node object contains metadata.
    - `status` string — Returns the status of each component.
    - `updateStatus` string — Updated Status.
  - `sourceTenantDescription` string, required — Source Tenant Description.
  - `sourceTenantName` string, required — Source Tenant Name.
  - `status` string, required — Status of the Migration Job.
  - `type` string

## Other responses

- `201` — created. The request has been fulfilled and resulted in a new resource being created. The newly created resource can be referenced by the URL(s) returned in the entity of the response, with the most specific URL for the resource given by a Location header field.
- `400` — Bad request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found

---

[API](https://skmtc.dev/zuora/apis/api-reference.md) · [All operations](https://skmtc.dev/zuora/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/zuora/api-reference/revisions/d11e237f3e54/schema)