Get jail state

GET

/jail/{ctid}/state

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

Retrieve the current runtime state and pending lifecycle action for a jail by CTID

Authorizations

• BearerAuth

Parameters

Path Parameters

ctid

required

integer

>= 1

Jail CTID

Responses

200

Success

Media typeapplication/json

object

data

object

ctId

integer

memory

integer

overrideRequested

boolean

pcpu

number

pendingAction

string

state

string

error

string

message

string

status

string

Example^generated

{
  "data": {
    "ctId": 1,
    "memory": 1,
    "overrideRequested": true,
    "pcpu": 1,
    "pendingAction": "example",
    "state": "example"
  },
  "error": "example",
  "message": "example",
  "status": "example"
}

400

Bad Request

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

401

Unauthorized

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

404

Jail Not Found

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

503

Service Unavailable

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}