Skip to content
SYLVE

Get jail guest information

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

Best-effort OS and live network information for running FreeBSD jails. Available is false when inspection is unsupported or tools are unavailable.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
ctid
required
integer
>= 1

Jail CTID

Responses

Section titled “Responses”

200

Section titled “200”

Success

Media typeapplication/json
object
data
object
available
boolean
interfaces
Array<object>
object
hardwareAddress
string
ipAddresses
Array<object>
object
address
string
prefix
integer
type
string
name
string
statistics
object
rxBytes
integer
txBytes
integer
networkMode
string
osInfo
object
architecture
string
kernelRelease
string
name
string
version
string
error
string
message
string
status
string
Examplegenerated
{
  "data": {
    "available": true,
    "interfaces": [
      {
        "hardwareAddress": "example",
        "ipAddresses": [
          {
            "address": "example",
            "prefix": 1,
            "type": "example"
          }
        ],
        "name": "example",
        "statistics": {
          "rxBytes": 1,
          "txBytes": 1
        }
      }
    ],
    "networkMode": "example",
    "osInfo": {
      "architecture": "example",
      "kernelRelease": "example",
      "name": "example",
      "version": "example"
    }
  },
  "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"
}

401

Section titled “401”

Unauthorized

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

404

Section titled “404”

Jail Not Found

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