deploy.host-database.restore

Replace the database with one of its backups

POST /deploy/api/apps/{id}/host-database/restoreIAM deploy:RestoreHostDatabaseChanges stateDestructive

The current data is backed up first (reason before-restore, kept 7 days), so a restore can be undone.

Request syntax

POST /deploy/api/apps/{id}/host-database/restore
{
  "backupId": "string"
}

Path parameters

  • idRequired

    string

    Constraints: uuid

Request body

  • backupIdRequired

    string

    The backup to restore: one of the app’s backups listed by get

Response

202 with `data`: `requestId`, the restore request the pool host carries out at its next pull. 404 when the app has no active pool-host database or the backup is not a finished one of this app, 409 while another restore is running.

A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.

Fields of data

  • requestIdAlways

    string

    The request the pool host answers at its next pull

Checked against the handlers: every route test validates their answers against this schema.

Errors

  • 400The request does not pass the schema above. The body is { "error": …, "issues": […] }, one issue per field.
  • 401No credentials, or an access key that is unknown, revoked or expired.
  • 403The caller's policies do not allow deploy:RestoreHostDatabase on this resource. The body names the action and the resource, and the refusal is recorded in the audit log.
  • 404The resource does not exist in your organization.

Examples

The required parameters only, with example values. Replace id and the other placeholders with your own.

dcloud deploy host-database restore id --backup-id example

Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_deploy_host-database_restore.