Using
Live status of a restore job. Lives in RAM only — gone after a restart; the outcome is also in the log.
applies to v0.5.1GET
/store-api/restores/{id}
const url = 'https://example.com/store-api/restores/example';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://example.com/store-api/restores/example \ --header 'Authorization: Bearer <token>'Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”id
required
string
Restore id
Responses
Section titled “Responses”Restore status
Media typeapplication/json
object
backup_id
required
string
errors
required
Array<object>
object
error
required
string
key
required
string
failed
required
integer format: int64
finished_at
integer | null format: int64
imported
required
integer format: int64
restore_id
required
string
skipped
required
integer format: int64
started_at
required
integer format: int64
state
required
string
Example generated
{ "backup_id": "example", "errors": [ { "error": "example", "key": "example" } ], "failed": 1, "finished_at": 1, "imported": 1, "restore_id": "example", "skipped": 1, "started_at": 1, "state": "example"}Restore not found
Media typetext/plain
string
Backup is disabled
Media typetext/plain
string