List Backup Target Dataset Snapshots

GET

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

curl --request GET \
  --url 'https://sylve.lan:8181/api/cluster/backups/targets/1/datasets/snapshots?dataset=example&limit=100' \
  --header 'Authorization: <Authorization>'

List restorable snapshots for a dataset on a backup target

Authorizations

• BearerAuth

Parameters

Path Parameters

id

required

integer

Backup Target ID

Query Parameters

dataset

required

string

Remote dataset

limit

integer

default: 100 >= 1 <= 500

Maximum snapshots to return

cursor

string

Opaque continuation cursor

Responses

200

Success

Media typeapplication/json

object

data

object

hasMore

boolean

items

Array<object>

object

childCount

Number of child datasets on the target

integer

committed

Verified c1 commit marker is present

boolean

creation

Creation timestamp

string

dataset

Dataset portion (without @snap)

string

encrypted

boolean

guid

string

legacy

Restore point predates commit manifests

boolean

lineage

“active” | “rotated” | “other”

string

name

Full dataset@snap name

string

outOfBand

True when snapshot is outside the active lineage

boolean

refer

Referenced size

string

shortName

Just the @snap portion

string

used

Space used

string

nextCursor

string

error

string

message

string

status

string

Example^generated

{
  "data": {
    "hasMore": true,
    "items": [
      {
        "childCount": 1,
        "committed": true,
        "creation": "example",
        "dataset": "example",
        "encrypted": true,
        "guid": "example",
        "legacy": true,
        "lineage": "example",
        "name": "example",
        "outOfBand": true,
        "refer": "example",
        "shortName": "example",
        "used": "example"
      }
    ],
    "nextCursor": "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 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"
}