---
title: "Get all ZFS Datasets with Pagination"
method: GET
path: "/zfs/datasets/paginated"
tags: ["ZFS"]
---

# Get all ZFS Datasets with Pagination

`GET /zfs/datasets/paginated`

Get all ZFS Datasets with Pagination

## Query parameters

- `datasetType` 'ALL' | 'SNAPSHOT' | 'FILESYSTEM' | 'VOLUME', required
- `page` integer
- `size` integer
- `search` string
- `nameFilter` string
- `sort[0][field]` 'name' | 'used' | 'referenced'
- `sort[0][dir]` 'asc' | 'desc'

## Response `200`

Success

- GithubComAlchemillahqSylveInternalAPIResponseGithubComAlchemillahqSylveInternalInterfacesServicesZfsPaginatedDatasetsResponse
  - `data` GithubComAlchemillahqSylveInternalInterfacesServicesZfsPaginatedDatasetsResponse
    - `data` GzfsDataset[]
      - `available` integer
      - `compressratio` number
      - `createtxg` string
      - `guid` string
      - `mountpoint` string
      - `name` string
      - `pool` string
      - `properties` object
      - `referenced` integer
      - `type` 'ALL' | 'FILESYSTEM' | 'VOLUME' | 'SNAPSHOT'
      - `used` integer
    - `last_page` integer
  - `error` string
  - `message` string
  - `status` string

## Other responses

- `400` — Bad Request
- `500` — Internal Server Error

## Changes

- **2026-08-12** `9a5026bf9057` — 1 breaking, 6 info
  - added the new required `query` request parameter `datasetType`
  - added the new optional `query` request parameter `nameFilter`
  - added the new optional `query` request parameter `page`
  - added the new optional `query` request parameter `search`
  - …3 more
- **2026-01-01** `5cf4dbcc2128` — 1 info
  - endpoint added
- **2025-03-11** `2b736ca1b025` — 1 breaking
  - api path removed without deprecation

[Change history](https://skmtc.dev/alchemillahq/apis/sylve-api/changes/zfs/datasets/paginated/get.md)

---

[API](https://skmtc.dev/alchemillahq/apis/sylve-api.md) · [All operations](https://skmtc.dev/alchemillahq/apis/sylve-api/llms.txt) · [OpenAPI document](https://skmtc.dev/alchemillahq/apis/sylve-api/revisions/85f3f607253e?raw)