Skip to content

Get initial jail statistics

GET
/jail/{ctid}/stats
curl --request GET \
--url https://sylve.lan:8181/api/jail/1/stats \
--header 'Authorization: <Authorization>'

Retrieve the finest available statistics window and its availability metadata for a jail

ctid
required
integer
>= 1

Jail CTID

Success

Media typeapplication/json
object
data
object
historyState
string
Allowed values: available never-recorded outside-supported-range
lastSampleAt
string
points
Array<object>
object
cpuUsage
number
createdAt
string
id
integer
jid
integer
memoryUsage
number
resolvedStep
string
Allowed values: minutely hourly daily weekly monthly yearly
error
string
message
string
status
string
Example
{
"data": {
"historyState": "available",
"resolvedStep": "minutely"
}
}

Bad Request

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

Unauthorized

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

Jail Not Found

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

Internal Server Error

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