ALalchemillahq
ZFS

Get all ZFS Datasets with Pagination

Changed on

Get all ZFS Datasets with Pagination

get/zfs/datasets/paginated

Request

  • Base URL
    https://sylve.lan:8181/api
  • URL
    https://sylve.lan:8181/api/zfs/datasets/paginated
  • Auth
    API key in header Authorization

Query parameters

datasetType'ALL' | 'SNAPSHOT' | 'FILESYSTEM' | 'VOLUME' required

Dataset type

pageinteger

Page number

sizeinteger

Page size

searchstring

Search dataset names

nameFilterstring

Comma-separated dataset name substrings to exclude

sort[0][field]'name' | 'used' | 'referenced'

Sort field

sort[0][dir]'asc' | 'desc'

Sort direction

Response

Success

errorstring
messagestring
statusstring

Changes

  • 9a5026bf9057Revision changes
    • breaking

      added the new required query request parameter datasetType

    • info

      added the new optional query request parameter nameFilter

    • info

      added the new optional query request parameter page

    • info

      added the new optional query request parameter search

    • info

      added the new optional query request parameter size

    • info

      added the new optional query request parameter sort[0][dir]

    • info

      added the new optional query request parameter sort[0][field]

  • 5cf4dbcc2128Revision changes
    • info

      endpoint added