Get a Jail (Simple)

GET

/jail/simple/{ctid}

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

Retrieve the lightweight projection of a jail by its CTID

Authorizations

• BearerAuth

Parameters

Path Parameters

ctid

required

integer

>= 1

Jail CTID

Responses

200

Success

Media typeapplication/json

object

data

object

cores

integer

ctId

integer

id

integer

memory

integer

name

string

resourceLimits

boolean

state

string

type

string

Allowed values: freebsd linux

error

string

message

string

status

string

Example

{
  "data": {
    "type": "freebsd"
  }
}

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

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