List Backup Target Datasets

GET

/cluster/backups/targets/{id}/datasets

curl --request GET \
  --url https://sylve.lan:8181/api/cluster/backups/targets/1/datasets \
  --header 'Authorization: <Authorization>'

List restorable datasets on a backup target

Authorizations

• BearerAuth

Parameters

Path Parameters

id

required

integer

Backup Target ID

Responses

200

Success

Media typeapplication/json

object

data

Array<object>

object

baseSuffix

string

encrypted

boolean

jailCtId

integer

kind

“dataset” | “jail” | “vm”

string

lineage

“active” | “rotated” | “other”

string

name

Full remote dataset path

string

outOfBand

boolean

snapshotCount

integer

snapshotCountKnown

boolean

suffix

string

vmRid

integer

error

string

message

string

status

string

Example^generated

{
  "data": [
    {
      "baseSuffix": "example",
      "encrypted": true,
      "jailCtId": 1,
      "kind": "example",
      "lineage": "example",
      "name": "example",
      "outOfBand": true,
      "snapshotCount": 1,
      "snapshotCountKnown": true,
      "suffix": "example",
      "vmRid": 1
    }
  ],
  "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 Not Found

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

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

409

Backup Target Disabled

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 Target Failure

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

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

503

Local Key Unavailable

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

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

504

Remote Target Timeout

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

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