Client area

MCP tool · SSL, backups, cron & logs

restore_backup

Restore a backup over the live hosting account — the whole account, or only the parts you name.

restore_backup
D Destructive
DestructiveIdempotent

Description

Restore a backup over the live hosting account — the whole account, or only the parts you name. This overwrites current data and is irreversible, and it restores nothing on this call: it checks the backup and every part you asked for actually exist, then returns {status:"confirmation_required", confirmationUrl, …}. Show the human the confirmationUrl to approve in the client area; never approve it yourself. Then poll get_pending_action, and once it runs follow the restore itself with get_restore_status — a restore is asynchronous and can still fail after approval.

Input

Name Type Description
input required string A domain, email address, website URL, numeric service id, or hosting-account username the customer actually owns. Resolved to the owning account automatically; the resolved target is echoed back in the response.
backup_id required string The backup to restore, from list_backupsbackups[].id (or backups[].file on a directadmin node).
items string[] Whole components to restore: files, databases, database_users, email, dns, ssl, cron, ftp, config. Omit to restore the whole account.
item_ids string[] Specific items to restore — one database, one mailbox — from get_backup_contentsitems[].id. Use instead of items, not alongside it.
paths string[] Individual files or folders to restore from the home directory, as absolute paths inside it (e.g. /domains/example.com/public_html/wp-config.php).
merge boolean Keep live files where they conflict with the backup instead of overwriting them. Default false — a plain restore overwrites.
attempt_key string An idempotency key you choose. Reusing it within an hour returns the same held restore.
Esc
navigate open Esc close