Skip to content
v0.5.1GitHub

Using

Lists every backup archive in `backup.dir`, plus the currently running backup job (if any) separately in `running`.

applies to v0.5.1
GET
/store-api/backups
curl --request GET \
  --url https://example.com/store-api/backups \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Backup list

Media typeapplication/json
object
backups
required
Array<object>
object
created_at
required
integer format: int64
format_version
required
integer format: int32
id
required
string
schedule
string | null
scope
required
string
size_bytes
required
integer format: int64
state
required
string
running
One of:
object
id
required
string
scope
required
string
started_at
required
integer format: int64

Example generated

{
  "backups": [
    {
      "created_at": 1,
      "format_version": 1,
      "id": "example",
      "schedule": "example",
      "scope": "example",
      "size_bytes": 1,
      "state": "example"
    }
  ],
  "running": {
    "id": "example",
    "scope": "example",
    "started_at": 1
  }
}

503

Section titled “503”

Backup is disabled

Media typetext/plain
string