Get all ZFS Datasets with Pagination

GET

/zfs/datasets/paginated

curl --request GET \
  --url 'https://sylve.lan:8181/api/zfs/datasets/paginated?datasetType=ALL&page=1&size=25&sort%5B0%5D%5Bfield%5D=name&sort%5B0%5D%5Bdir%5D=asc' \
  --header 'Authorization: <Authorization>'

Get all ZFS Datasets with Pagination

Authorizations

• BearerAuth

Parameters

Query Parameters

datasetType

required

string

Allowed values: ALL SNAPSHOT FILESYSTEM VOLUME

Dataset type

page

integer

default: 1

Page number

size

integer

default: 25

Page size

search

string

Search dataset names

nameFilter

string

Comma-separated dataset name substrings to exclude

sort[0][field]

string

Allowed values: name used referenced

Sort field

sort[0][dir]

string

Allowed values: asc desc

Sort direction

Responses

200

Success

Media typeapplication/json

object

data

object

data

Array<object>

object

available

integer

compressratio

number

createtxg

string

guid

string

mountpoint

string

name

string

pool

string

properties

object

key

additional properties

object

source

object

data

string

type

string

value

string

referenced

integer

type

string

Allowed values: ALL FILESYSTEM VOLUME SNAPSHOT

used

integer

last_page

integer

error

string

message

string

status

string

Example

{
  "data": {
    "data": [
      {
        "type": "ALL"
      }
    ]
  }
}

400

Bad Request

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"
}