This API allows you to list available backups and restore individual items such as databases, websites, emails, and FTP accounts.
List items within a specific backup, grouped by type.
path Parameters
regionThe region you want to target
hosting_idUUID of the hosting account.
query Parameters
backup_idID of the backup to list items from.
List items within a specific backup, grouped by type. › Responses
total_countTotal number of backup item groups.
List of backup item groups categorized by type.
List all available backups for a hosting account.
path Parameters
regionThe region you want to target
hosting_idUUID of the hosting account.
query Parameters
pagePage number to retrieve.
page_sizeNumber of backups to return per page.
order_byOrder in which to return the list of backups.
List all available backups for a hosting account. › Responses
total_countTotal number of available backups.
List of available backups.
Get info about a backup specified by the backup ID.
path Parameters
regionThe region you want to target
hosting_idUUID of the hosting account.
backup_idID of the backup to retrieve.
Get info about a backup specified by the backup ID. › Responses
idID of the backup.
sizeTotal size of the backup in bytes. (in bytes)
created_atCreation date of the backup. (RFC 3339 format)
statusStatus of the backup. Available values are active, locked, and restoring.
total_itemsTotal number of restorable items in the backup.
Restore an entire backup to your hosting environment.
path Parameters
regionThe region you want to target
hosting_idUUID of the hosting account.
backup_idID of the backup to fully restore.
Restore an entire backup to your hosting environment. › Responses
progress_idIdentifier used to track the backup restoration progress.
List recent progresses associated with a specific backup, grouped by type.
Retrieve detailed information about a specific progress by its ID.
path Parameters
regionThe region you want to target
hosting_idID of the hosting associated with the progress.
progress_idID of the progress to retrieve.
Retrieve detailed information about a specific progress by its ID. › Responses
idID of the progress.
Groups of backup items included in this progress.
percentageCompletion percentage of the progress.
statusCurrent status of the progress operation.
Restore specific items from a backup (e.g., a database or mailbox).
path Parameters
regionThe region you want to target
hosting_idUUID of the hosting account.
Restore specific items from a backup (e.g., a database or mailbox). › Request Body
item_idsList of backup item IDs to restore individually.
Restore specific items from a backup (e.g., a database or mailbox). › Responses
progress_idIdentifier used to track the item restoration progress.