Get Pools

GET

/zfs/pools

curl --request GET \
  --url 'https://sylve.lan:8181/api/zfs/pools?all=false' \
  --header 'Authorization: <Authorization>'

Get all ZFS pools

Authorizations

• BearerAuth

Parameters

Query Parameters

all

boolean

Include pools that are not configured as usable

Responses

200

Success

Media typeapplication/json

object

data

Array<object>

object

allocated

integer

dedup

object

key

additional properties

object

allocated

integer

class

string

fragmentation

number

free

integer

guid

string

name

string

path

string

phys_path

string

properties

object

key

additional properties

object

source

object

data

string

type

string

value

string

size

integer

state

string

vdev_type

string

vdevs

object

key

additional properties

object recursive

dedup_ratio

number

fragmentation

number

free

integer

l2cache

object

key

additional properties

object

allocated

integer

class

string

fragmentation

number

free

integer

guid

string

name

string

path

string

phys_path

string

properties

object

key

additional properties

object

source

object

data

string

type

string

value

string

size

integer

state

string

vdev_type

string

vdevs

object

key

additional properties

object recursive

logs

object

key

additional properties

object

allocated

integer

class

string

fragmentation

number

free

integer

guid

string

name

string

path

string

phys_path

string

properties

object

key

additional properties

object

source

object

data

string

type

string

value

string

size

integer

state

string

vdev_type

string

vdevs

object

key

additional properties

object recursive

name

string

pool_guid

string

properties

object

key

additional properties

object

source

object

data

string

type

string

value

string

size

integer

spa_version

string

spares

object

key

additional properties

object

allocated

integer

class

string

fragmentation

number

free

integer

guid

string

name

string

path

string

phys_path

string

properties

object

key

additional properties

object

source

object

data

string

type

string

value

string

size

integer

state

string

vdev_type

string

vdevs

object

key

additional properties

object recursive

special

object

key

additional properties

object

allocated

integer

class

string

fragmentation

number

free

integer

guid

string

name

string

path

string

phys_path

string

properties

object

key

additional properties

object

source

object

data

string

type

string

value

string

size

integer

state

string

vdev_type

string

vdevs

object

key

additional properties

object recursive

state

string

Allowed values: ONLINE DEGRADED FAULTED OFFLINE REMOVED UNAVAIL CORRUPT_DATA UNKNOWN

txg

string

type

string

zpl_version

string

error

string

message

string

status

string

Example

{
  "data": [
    {
      "state": "ONLINE"
    }
  ]
}

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