Databases

Replay one of this database's own backup files (server path) into it: exact name, a backup from the last hour and, from the dashboard, a recent sign-in; owner/admin only. Prefer POST /databases/{id}/backups/restore

post/databases/{databaseId}/restore

Request

  • Base URL: https://hostingsurge.com/api/v1
  • URL: https://hostingsurge.com/api/v1/databases/{databaseId}/restore
  • Auth: one of:
    • HTTP bearer
    • API key in cookie __Host-hs_session

Path parameters

databaseIdstring uuid required
Example:3f2b8a4e-5c1d-4e8f-9a7b-2c6d1e0f4a5b

Request body

replaceExistingboolean
dumpAllboolean
confirmstring required

must equal the database name. Needs a successful backup of this database from the last hour (take one with POST /databases/{id}/backups/run first) and, from the dashboard, a sign-in within the last 5 minutes

Response

Restore queued

importIdstring required
state'queued' | 'running' | 'success' | 'failed' required
exitCodeinteger nullable required
outputstring required
finishedAtstring nullable required

ISO-8601 timestamp

Changes

No recorded changes to this operation across all 1 revision of this API.