backup

Return backup progress

Required security scopes:

api:manage

get/backup/{backup_id}

Request

The document declares no server URL.
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/vivino/apis/the-rankdb-api/docs/backup/:backup_id/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

backup_idstring required

Response

cancelledboolean required

Will be true if backup was cancelled

customobject

Custom information provided by backup

doneboolean required

Will be true when the backup has finished processing

errorsobject

Failed operations, indexed by list IDs

finishedstring date-time

Time backup was finished

listsinteger required

Number of lists to be backed up

lists_doneinteger required

Number of lists backed up now

sizeinteger required

Size of stored data

startedstring date-time required

Time backup was started

storagestring required

Storage used for backup

uristring required

URI of backed up content. Used for restore.

Example response

{
  "cancelled": false,
  "custom": {
    "Officiis rerum qui dolor atque ut.": "Quam sunt reprehenderit quasi ipsa doloribus maiores."
  },
  "done": false,
  "errors": {
    "highscore-dk-all": "not found"
  },
  "finished": "2000-09-09T16:20:50Z",
  "lists": 8409293731941957000,
  "lists_done": 6395906341434804000,
  "size": 6170196923559175000,
  "started": "1993-04-08T06:51:59Z",
  "storage": "Adipisci officiis architecto quisquam quia.",
  "uri": "Neque nostrum quisquam nulla deleniti."
}

Changes

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