Skip to content
v0.5.1GitHub

Using

Manifest fields + state + size for one backup. A backup whose job is still running (no `.ndjson` file yet, only `.part`) reports `state: "running"` from the in-RAM job slot instead of 404.

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

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string

Backup id

Responses

Section titled “Responses”

200

Section titled “200”

Backup details

Media typeapplication/json

Manifest fields + state + size (GET /backups/{id} and POST /backups/upload). Everything but id/state/scope is optional: the currently-running-job shape (running) only fills started_at; the complete/incomplete shape fills the rest instead.

object
created_at
integer | null format: int64
encoding
string | null
format_version
integer | null format: int32
id
required
string
include_auth
boolean | null
json_snapshot_ts

The newest read-snapshot stamp of the JSON engine among the data shards.

integer | null format: int64
kv_snapshot_ts

The newest read-snapshot stamp of the KV engine among the data shards.

integer | null format: int64
lsn_cut
One of:

Per engine, a write-ahead-log position that every write in the archive is at or below; 0 for an engine outside the scope and for format version 1. Positions keep growing across restarts, so they compare across runs of the server.

object
json
required
integer format: int64
kv
required
integer format: int64
rel
required
integer format: int64
luradb_version
string | null
rel_snapshot_ts

The newest read-snapshot stamp of the relational engine among the data shards.

integer | null format: int64
schedule
string | null
scope
required
string
shards

Data shards of the server that wrote the archive; 0 for format version 1. Informational: a restore places every domain by the shard count of the server it runs on.

integer | null format: int32
size_bytes
integer | null format: int64
started_at
integer | null format: int64
state
required
string

Example generated

{
  "created_at": 1,
  "encoding": "example",
  "format_version": 1,
  "id": "example",
  "include_auth": true,
  "json_snapshot_ts": 1,
  "kv_snapshot_ts": 1,
  "lsn_cut": {
    "json": 1,
    "kv": 1,
    "rel": 1
  },
  "luradb_version": "example",
  "rel_snapshot_ts": 1,
  "schedule": "example",
  "scope": "example",
  "shards": 1,
  "size_bytes": 1,
  "started_at": 1,
  "state": "example"
}

400

Section titled “400”

Invalid backup id

Media typetext/plain
string

404

Section titled “404”

Backup not found

Media typetext/plain
string

503

Section titled “503”

Backup is disabled

Media typetext/plain
string