List Filesystems

The list filesystems command shows all filesystems in a given pool or project.

Query Parameters - filter – A simple string match filter that requires a property within the project to contain the same filter string within its value.

Example Request:

GET /api/storage/v1/pools/gold/projects/proj-01/filesystems HTTP/1.1
Host: zfs-storage.example.com
Accept: application/json

Successful request returns HTTP Status 200 (OK) along with an array of filesystem properties in JSON format.

Example Result:

HTTP/1.1 200 OK
Content-Type: application/json

{
    “filesystems”: [{
        “name”: “filesystem-01”,
        “project”: “proj-01”,
        “pool”: “gold”,
        ...
    }, {
        “name”: “filesystem-02”,
        “project”: “proj-01”,
        “pool”: “gold”,
        ...
    }]
}

A list of all filesystems across all pools and projects is also supported. In that case the URI would be /api/storage/v1/filesystems

Example Request to Get all Filesystems with the "abcd" String as Part its Properties:

GET /api/storage/v1/filesystems?filter=abcd HTTP/1.1
Host: zfs-storage.example.com
Accept: application/json