Skip to content
SYLVE

Get ZFS dashboard history

GET
/zfs/dashboard/history
curl --request GET \
  --url 'https://sylve.lan:8181/api/zfs/dashboard/history?rangeSeconds=86400&maxPoints=900' \
  --header 'Authorization: <Authorization>'

Retrieves bounded, downsampled pool and ARC telemetry for the ZFS dashboard

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
rangeSeconds
integer
default: 86400 >= 60 <= 6048000

History range in seconds

maxPoints
integer
default: 900 >= 120 <= 2000

Maximum points per series

poolGuid
string

Optional pool GUID

Responses

Section titled “Responses”

200

Section titled “200”

Success

Media typeapplication/json
object
data
object
arc
Array<object>
object
compressedSize
integer
dataSize
integer
demandHitRatio
number
evictNotEnoughEvents
integer
evictionsPerSecond
number
headerSize
integer
hitRatio
number
id
integer
l2Allocated
integer
l2DeviceCount
integer
l2HitRatio
number
l2ReadBytesPerSecond
integer
l2Size
integer
l2WriteBytesPerSecond
integer
maxSize
integer
memoryThrottleEvents
integer
metadataSize
integer
minSize
integer
otherSize
integer
prefetchHitRatio
number
size
integer
targetSize
integer
time
integer
uncompressedSize
integer
cursors
object
arc
integer
pool
integer
generatedAt
integer
pools
Array<object>
object
guid
string
name
string
points
Array<object>
object
allocated
integer
dedupRatio
number
fragmentation
number
free
integer
health
string
id
integer
intervalSeconds
integer
maxReadBytesPerSecond
integer
maxReadIOPS
integer
maxReadLatencyNanos
integer
maxWriteBytesPerSecond
integer
maxWriteIOPS
integer
maxWriteLatencyNanos
integer
readBytesPerSecond
integer
readIOPS
integer
readLatencyNanos
integer
sampleCount
integer
size
integer
time
integer
worstHealth
string
writeBytesPerSecond
integer
writeIOPS
integer
writeLatencyNanos
integer
resetRequired
boolean
resolutionSeconds
integer
error
string
message
string
status
string
Examplegenerated
{
  "data": {
    "arc": [
      {
        "compressedSize": 1,
        "dataSize": 1,
        "demandHitRatio": 1,
        "evictNotEnoughEvents": 1,
        "evictionsPerSecond": 1,
        "headerSize": 1,
        "hitRatio": 1,
        "id": 1,
        "l2Allocated": 1,
        "l2DeviceCount": 1,
        "l2HitRatio": 1,
        "l2ReadBytesPerSecond": 1,
        "l2Size": 1,
        "l2WriteBytesPerSecond": 1,
        "maxSize": 1,
        "memoryThrottleEvents": 1,
        "metadataSize": 1,
        "minSize": 1,
        "otherSize": 1,
        "prefetchHitRatio": 1,
        "size": 1,
        "targetSize": 1,
        "time": 1,
        "uncompressedSize": 1
      }
    ],
    "cursors": {
      "arc": 1,
      "pool": 1
    },
    "generatedAt": 1,
    "pools": [
      {
        "guid": "example",
        "name": "example",
        "points": [
          {
            "allocated": 1,
            "dedupRatio": 1,
            "fragmentation": 1,
            "free": 1,
            "health": "example",
            "id": 1,
            "intervalSeconds": 1,
            "maxReadBytesPerSecond": 1,
            "maxReadIOPS": 1,
            "maxReadLatencyNanos": 1,
            "maxWriteBytesPerSecond": 1,
            "maxWriteIOPS": 1,
            "maxWriteLatencyNanos": 1,
            "readBytesPerSecond": 1,
            "readIOPS": 1,
            "readLatencyNanos": 1,
            "sampleCount": 1,
            "size": 1,
            "time": 1,
            "worstHealth": "example",
            "writeBytesPerSecond": 1,
            "writeIOPS": 1,
            "writeLatencyNanos": 1
          }
        ]
      }
    ],
    "resetRequired": true,
    "resolutionSeconds": 1
  },
  "error": "example",
  "message": "example",
  "status": "example"
}

400

Section titled “400”

Bad Request

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

404

Section titled “404”

Pool Not Managed

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

500

Section titled “500”

Internal Server Error

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}