Manage tenant data

Updated: June 21, 2026

Want to summarize with AI?

Provides procedures to back up, restore, monitor, and manage tenant configuration data in Cisco Catalyst SD-WAN Manager.

You can back up, restore, and manage tenant configuration data in SD-WAN Manager.

Back up tenant data
Create data backup file
Restore tenant data backup file
Monitor data backup restore
Delete tenant data backup file

Back up tenant data

You can back up configuration data for a tenant in SD-WAN Manager.

The tenant data backup solution of SD-WAN Manager multitenancy provides these functionalities:

Create, list, and extract configuration backup files.
Back up configuration database of a specific tenant with an option to restore it later.
Delete back up files of a tenant stored in SD-WAN Manager.

Usage

Tenant data backup operations can be performed:

By a tenant administrator in the tenant view.
By a provider administrator in the provider-as-tenant view.

Allowed backup operations

At any given time, a tenant is allowed to perform only one backup operation. The operation must complete before starting a new one. These operations are supported:

Back up a single configuration database
Download the backup file
Restore or import backup files
Delete backup files
List backup files

Limitations

Defines the limitations of provider access for backing up data.

A provider cannot back up provider data using this solution.
A provider can back up all tenant information at once only by backing up all tenants’ configuration databases using CLI.

View back up data

The tenant data backup solution creates a task in the tenant view of SD-WAN Manager.

Tenants can monitor the progress of the operation from the task view of the tenant dashboard.

Backup and restore guidelines for tenant data

You can enable tenants to securely back up, store, and restore configuration data in Cisco SD-WAN Manager while maintaining consistency and operational limits.

Follow these guidelines for tenant backup and restore operations.

The tenant backup file follows the format: Bkup_tenantId_MMDDYY-HHMMSS_taskIdWithoutDash.tar.gz.
Backup operation is read-only on the configuration database.
To ensure data consistency, do not perform major network changes while the operation is in progress.
Multiple tenants can perform backup and restore operations in parallel.
A tenant cannot start other backup operations when a restore operation is in progress.
Backup and restore operations must be performed on Cisco SD-WAN Manager instances running identical software versions.
A tenant can store a maximum of three backup files in Cisco SD-WAN Manager.
If three files already exist, the earliest backup file is deleted when a new backup is generated.
Backup files can also be downloaded and stored outside the Cisco SD-WAN Manager repository.
Ensure the following parameter values match in both the backup file and the target setup:
- Tenant ID
- Organization Name
- SP Organization Name

Create data backup file

To create, verify, extract, and list tenant configuration backup files using Cisco SD-WAN Manager APIs.

Procedure

	1.	Log in to Cisco SD-WAN Manager. If you are a provider user, log in as the admin. In the provider dashboard, choose a tenant from the drop-down list to enter the provider-as-tenant view. If you are a tenant user, log in as the tenantadmin.
	2.	Modify the URL path for REST API access. In the address bar, update the URL path with `dataservice`. Example: https://<tenant_URL>/dataservice
	3.	Create a configuration backup file by using the following API: https://<tenant_URL>/dataservice/tenantbackup/export.
	4.	Once the backup file is created, Cisco SD-WAN Manager task view shows the generated process ID. Example: { "processId": "72d69805-b987-436f-9b7a-afef2f3f9061", "status": "in-progress" }
	5.	Verify the task status. Use the obtained process ID with the following API, the response provides task details in JSON format. Example: https://<tenant_URL>/dataservice/device/action/status/72d69805-b987-436f-9b7a-afef2f3f9061
	6.	Extract or download the backup file. After the task completes, the backup file appears under the data section of the JSON task file. To extract or download it, use: `https://<tenant_URL>/dataservice/tenantbackup/download/1570057020772/backup_1570057020772_100919-181838.tar.gz`
	7.	List available backup files. Use the following API to list all backup files stored in Cisco SD-WAN Manager. `https://<tenant_URL>/dataservice/tenantbackup/list`

Restore tenant data backup file

Use these steps to restore tenant data backup file.

Before you begin

To run the restore API, use Postman or an equivalent API testing tool. Postman is used here as an example. You can download it from the Postman website.

Procedure

	1.	Open Google Chrome or another browser and enable Developer Mode.
	2.	Log in to Cisco SD-WAN Manager. If you're a provider user, log in as the admin and from the provider dashboard, choose a tenant from the drop-down list to enter the provider-as-tenant view. If you're a tenant user, log in as the tenantadmin.
	3.	Get header information for the restore API: Click the Network tab to view network capture. In the network capture view, click the Name column to sort listed items. Search and click index.html. Click the Headers tab and expand Request Headers. Copy all text under Request Headers to the clipboard.
	4.	Open Postman UI to import backup files using Postman: To disable SSL certificate verification, go to Postman > Preferences > General > Request and turn off SSL Certificate Verification. Create a new tab. Click Headers, then Bulk Edit, and paste the copied text from Request Headers. From the GET drop-down, choose POST. In the Request URL field, enter the tenant URL with the restore API: `https://<tenant_URL>/dataservice/tenantbackup/import` Click the Body tab and select form-data. Under the KEY column, enter bakup.tar.gz Click Send to run the API. In the Response section, view the JSON confirmation showing that the file was restored. Example: `{ "processId": "40adb6c0-eacc-4ad4-ba6c-2c2da2e96d1d", "status": "Import Successfully Submitted for tenant 1579026919487" }`

Monitor backup data restore

You can monitor the progress of the restoration in either of these ways:

Use Cisco SD-WAN Manager task view that indicates whether the backup file is imported successfully. You can view the process identifier of the created process or task.
```
{"processId": "40adb6c0-eacc-4ad4-ba6c-2c2da2e96d1d",
    "status": "Import Successfully Submitted for tenant 1579026919487"
}
```

Use the following URL with the process ID to check status directly:

https://<tenant_URL>/dataservice/device/action/status/<processId>

Example:

https://customer1.managed-sp.com/dataservice/device/action/status/40adb6c0-eacc-4ad4-ba6c-2c2da2e96d1d

Need help?

Open a support case

(Requires a Cisco Service Contract)

The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.