Import Tenant
This method imports tenant data produced as a result of a previous manual export done using either the Service Provider application or the Export Tenant method.
The Import Tenant method is intended for the relocation of a tenant from one cluster to another, either for load balancing or disaster recovery reasons. You can use this method to import a tenant from an earlier version of a configuration database (i.e., migration from an older cluster to a newer cluster).
Note that this method does not change any GUIDs of the tenant from the export. A reporting database for this tenant will be created during import. Also note that the Import Tenant method fails if a tenant with the same tenant URL or the same tenant GUID already exists in the new cluster.
Access numbers that were assigned to this tenant in the original cluster will be carried over and assigned to the same tenant in the new cluster.
Information About Imported Access Numbers
When an Access Number Does Not Exist
If an imported access number does not exist in the new cluster, it will be created and assigned to the imported tenant. It will not be not assigned to any trunks.
When an Access Number Exists But Is Not Assigned
If an imported access number exists in the new cluster and is not assigned to another tenant, it will be assigned to the imported tenant. A possible existing assignment of such an access number to a trunk will be preserved.
When an Access Number Is Already Assigned
If an imported access number happens to be already assigned to another tenant in the new cluster, it will not be reassigned to the imported tenant and no errors will be reported (i.e., assignment will be silently skipped). If the tenant had a range of numbers assigned, and if at least one number in the range coincides with a number in a range assigned to another tenant in the new cluster, assignment of the whole range will be silently skipped.
Request
| URL(s) | http[s]://<host>:<port>/configapi/v2/tenant
or http[s]://<host>:<port>/configapi/v2/tenant?lockTimeout=120 |
| Method | PUT |
| Body | Tenant data in a ZIP archive file (content type: application/ZIP) |
Response
| Code | Description |
| 200 | Tenant imported |
| 409 | Tenant already exists or tenant name already exists |
| 503 | Lock timeout |