Get a backup

GET

/backups/{backupId}

curl --request GET \
  --url https://example.com/api/v1/backups/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --cookie __Host-shardkeep_session=<__Host-shardkeep_session>

Needs backups.read on its server (global administrators only once the server is deleted).

Authorizations

• sessionCookie
• bearerToken

Parameters

Path Parameters

backupId

required

string format: uuid

Responses

200

The backup.

Media typeapplication/json

object

id

required

string format: uuid

serverId

required

string format: uuid

destinationId

required

string format: uuid

nodeId

required

The Node that took it; a NODE_DIRECTORY backup is stored there.

string format: uuid

scheduleId

string format: uuid

trigger

required

string

Allowed values: MANUAL SCHEDULE BEFORE_RESTORE

state

required

string

Allowed values: RUNNING SUCCEEDED FAILED

sizeBytes

required

integer format: int64

software

required

What the server runs. A Shardkeep template, never a container image.

object

template

required

string

>= 1 characters <= 64 characters /^[a-z0-9][a-z0-9-]*$/

version

required

string

>= 1 characters <= 64 characters

build

string

<= 64 characters

plugins

required

Array<object>

object

pluginId

required

string

catalogVersionId

string

name

required

string

version

required

string

error

string

startedAt

required

string format: date-time

finishedAt

string format: date-time

Example

{
  "trigger": "MANUAL",
  "state": "RUNNING",
  "software": {
    "template": "paper",
    "version": "1.21.4"
  }
}

401

Not signed in, or the credentials are invalid.

Media typeapplication/problem+json

An RFC 9457 problem with a machine-readable code.

object

type

required

string

title

required

string

status

required

integer

detail

string

code

required

Stable machine-readable error code.

string

Example

{
  "type": "about:blank",
  "title": "Conflict",
  "status": 409,
  "code": "conflict"
}

404

Not found, or not visible to you.

Media typeapplication/problem+json

An RFC 9457 problem with a machine-readable code.

object

type

required

string

title

required

string

status

required

integer

detail

string

code

required

Stable machine-readable error code.

string

Example

{
  "type": "about:blank",
  "title": "Conflict",
  "status": 409,
  "code": "conflict"
}