Skip to content
Olivares AI docs

One backup's manifest and size by bundle id

GET
/v1/console/dr/backups/{id}
 
curl --request GET \
  --url https://example.com/v1/console/dr/backups/example \
  --header 'Authorization: Bearer <token>'

Returns one backup’s manifest and size. The id is the bundle’s filename; a malformed id (path separators, dotdot) is rejected before the filesystem is touched.

Authorizations

Section titled “ Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
id
required
string
>= 1 characters

The backup’s bundle id (its filename).

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

OK

Media type application/json
object
filename
required
string
id
required
string
manifest
required
object
created_at
required

The instant the backup was taken; RPO at a disaster is time-of-disaster minus this.

string format: date-time
engine
required
string
Allowed values: sqlite postgres
engine_version

The engine binary version that produced the bundle.

string
format
required

The manifest format; a reader rejects an unknown format.

string
size_bytes
required
integer format: int64
Example 
{
  "manifest": {
    "engine": "sqlite"
  }
}

400

Section titled “ 400 ”

Bad request

Media type application/json
object
error
required
object
code
required
string
message
required
string
module

With code module_not_enabled: the namespace of the module this node does not run.

string
Example generated 
{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

401

Section titled “ 401 ”

Unauthenticated

Media type application/json
object
error
required
object
code
required
string
message
required
string
module

With code module_not_enabled: the namespace of the module this node does not run.

string
Example generated 
{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

403

Section titled “ 403 ”

Forbidden

Media type application/json
object
error
required
object
code
required
string
message
required
string
module

With code module_not_enabled: the namespace of the module this node does not run.

string
Example generated 
{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

404

Section titled “ 404 ”

Not found

Media type application/json
object
error
required
object
code
required
string
message
required
string
module

With code module_not_enabled: the namespace of the module this node does not run.

string
Example generated 
{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

409

Section titled “ 409 ”

Conflict / setup required

Media type application/json
object
error
required
object
code
required
string
message
required
string
module

With code module_not_enabled: the namespace of the module this node does not run.

string
Example generated 
{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

429

Section titled “ 429 ”

Rate limited

Media type application/json
object
error
required
object
code
required
string
message
required
string
module

With code module_not_enabled: the namespace of the module this node does not run.

string
Example generated 
{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}