Restore a Backup Target Dataset

POST

/cluster/backups/targets/{id}/restore

curl --request POST \
  --url https://sylve.lan:8181/api/cluster/backups/targets/1/restore \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "destinationDataset": "example", "encryptionKey": "example", "encryptionKeyFormat": "example", "operationId": "example", "remoteDataset": "example", "restoreNetwork": true, "restoreNodeId": "example", "snapshot": "example" }'

Queue an idempotent out-of-band restore from a backup target, optionally on another cluster node

Authorizations

• BearerAuth

Parameters

Path Parameters

id

required

integer

Backup Target ID

Header Parameters

Idempotency-Key

string

Idempotency key used when operationId is omitted

Request Body

Restore Request

Media typeapplication/json

object

destinationDataset

string

encryptionKey

string

encryptionKeyFormat

string

operationId

string

remoteDataset

string

restoreNetwork

boolean

restoreNodeId

string

snapshot

string

Example^generated

{
  "destinationDataset": "example",
  "encryptionKey": "example",
  "encryptionKeyFormat": "example",
  "operationId": "example",
  "remoteDataset": "example",
  "restoreNetwork": true,
  "restoreNodeId": "example",
  "snapshot": "example"
}

Responses

202

Accepted

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

400

Bad Request

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

401

Unauthorized

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

403

Forbidden

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

404

Backup Target or Restore Node Not Found

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

409

Restore Conflict

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

413

Request Entity Too Large

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

500

Internal Server Error

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

502

Remote Node Failure

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

503

Service Unavailable

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

504

Remote Node Timeout

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}