---
title: "Get jail guest information"
method: GET
path: "/jail/{ctid}/guest-info"
tags: ["Jail"]
---

# Get jail guest information

`GET /jail/{ctid}/guest-info`

## Request

- Base URL: `https://sylve.lan:8181/api`
- URL: `https://sylve.lan:8181/api/jail/{ctid}/guest-info`
- Auth: API key in header `Authorization`

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

## Path parameters

- `ctid` integer, required

## Response `200`

Success

- GithubComAlchemillahqSylveInternalAPIResponseGithubComAlchemillahqSylveInternalInterfacesServicesJailGuestInfo
  - `data` GithubComAlchemillahqSylveInternalInterfacesServicesJailGuestInfo
    - `available` boolean
    - `interfaces` GithubComAlchemillahqSylveInternalInterfacesServicesJailGuestNetworkInterface[]
      - `hardwareAddress` string
      - `ipAddresses` GithubComAlchemillahqSylveInternalInterfacesServicesJailGuestIPAddress[]
        - `address` string
        - `prefix` integer
        - `type` string
      - `name` string
      - `statistics` GithubComAlchemillahqSylveInternalInterfacesServicesJailGuestNetworkStatistics
        - `rxBytes` integer
        - `txBytes` integer
    - `networkMode` string
    - `osInfo` GithubComAlchemillahqSylveInternalInterfacesServicesJailGuestOSInfo
      - `architecture` string
      - `kernelRelease` string
      - `name` string
      - `version` string
  - `error` string
  - `message` string
  - `status` string

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `404`: Jail Not Found
- `500`: Internal Server Error

## Changes

- **2026-10-14** `b38a7f63b0aa`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/alchemillahq/apis/sylve-api/changes/jail/:ctid/guest-info/get.md)

---

[API](https://skmtc.dev/alchemillahq/apis/sylve-api.md) - [All operations](https://skmtc.dev/alchemillahq/apis/sylve-api/llms.txt) - [OpenAPI document](https://skmtc.dev/alchemillahq/apis/sylve-api/revisions/9565cdd0abf5?raw)