Backup Restore

These endpoints are not supported on Virtual Machine (VM) deployments.

Get all backup file names

This endpoint returns a list of all container backup file names.

GET /api/v2/data-migration/list-backups/

GET /api/v2/data-migration/list-backups/ HTTP/1.1
Accept: application/json
Authorization: Token "YOUR SDE ACCESS TOKEN"

HTTP/1.1 200 OK
Content-Type: application/json

{
    "results": [
        "SDE_Backup_localhost-3000_5.20_2022-07-07_21-19-12.915376+00-00.tar.gz",
        "SDE_Backup_localhost-3000_5.20_2022-07-07_21-19-13.846718+00-00.tar.gz",
        "SDE_Backup_localhost-3000_5.20_2022-07-07_21-08-13.413322+00-00.tar.gz",
        "SDE_Backup_localhost-3000_5.20_2022-07-07_21-01-01.104534+00-00.tar.gz",
        "SDE_Backup_localhost-3000_5.20_2022-07-07_21-07-23.409063+00-00.tar.gz"
    ]
}

Create a container backup

This endpoint creates a container backup.

POST /api/v2/data-migration/backup/

Fields	Required	Description
emails	Yes	The list of email addresses to notify on backup success or failure

POST /api/v2/data-migration/backup/ HTTP/1.1
Accept: application/json
Authorization: Token "YOUR SDE ACCESS TOKEN"

{
    "emails": "abc@abc.com"
}

HTTP/1.1 200 OK
Content-Type: application/json

{
    "message": "Backup initiated"
}

Restore a backup to a container instance

This endpoint restores a backup file to a container instance.

POST /api/v2/data-migration/restore/

Fields	Required	Description
emails	Yes	The list of email addresses to notify on restore success or failure.
file	Yes	An attached backup file.

POST /api/v2/data-migration/restore/ HTTP/1.1
Accept: form-data
Authorization: Token "YOUR SDE ACCESS TOKEN"

"emails": "abc@abc.com"
"file": <backup.tar.gz>

Retrieve a container backup

This endpoint retrieves a container backup file.

GET /api/v2/data-migration/retrieve-backup/{backup_file_name}/

URL Parameters

Parameter	Description
backup_file_name	The name of the backup file to be downloaded

GET /api/v2/data-migration/retrieve-backup/SDE_Backup_localhost-3000_5.16_2021-09-24_15-49-10.374684+00-00.tar.gz/ HTTP/1.1
Accept: application/json
Authorization: Token "YOUR SDE ACCESS TOKEN"

HTTP/1.1 200 OK
Content-Type: application/x-tar

Attached SDE_Backup_localhost-3000_5.16_2021-09-24_15-49-10.374684+00-00.tar.gz

Backup-Restore