Resources related to FreeBSD Jails.
The Jails resource represents FreeBSD Jails.
Returns a list of all jails.
Example request:
GET /api/v1.0/jails/jails/ HTTP/1.1
Content-Type: application/json
Example response:
HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json
[
{
"id": 1,
"jail_alias_bridge_ipv4": null,
"jail_alias_bridge_ipv6": null,
"jail_alias_ipv4": null,
"jail_alias_ipv6": null,
"jail_autostart": True,
"jail_bridge_ipv4": null,
"jail_bridge_ipv4_netmask": "",
"jail_bridge_ipv6": null,
"jail_bridge_ipv6_prefix": "",
"jail_defaultrouter_ipv4": null,
"jail_defaultrouter_ipv6": null,
"jail_flags": "allow.raw_sockets=true",
"jail_host": "transmission_1",
"jail_ipv4": "192.168.3.2",
"jail_ipv4_netmask": "24",
"jail_ipv6": null,
"jail_ipv6_prefix": "",
"jail_mac": "02:c3:79:00:08:0b",
"jail_nat": false,
"jail_status": "Running",
"jail_type": "pluginjail",
"jail_vnet": true
}
]
Query Parameters: | |
---|---|
|
|
Response Headers: | |
|
|
Status Codes: |
|
Creates a new jail and returns the new jail object.
Example request:
POST /api/v1.0/jails/jails/ HTTP/1.1
Content-Type: application/json
{
"jail_host": "test",
"jail_type": "pluginjail"
}
Example response:
HTTP/1.1 201 Created
Vary: Accept
Content-Type: application/json
{
"id": 1,
"jail_alias_bridge_ipv4": null,
"jail_alias_bridge_ipv6": null,
"jail_alias_ipv4": null,
"jail_alias_ipv6": null,
"jail_autostart": true,
"jail_bridge_ipv4": null,
"jail_bridge_ipv4_netmask": "",
"jail_bridge_ipv6": null,
"jail_bridge_ipv6_prefix": "",
"jail_defaultrouter_ipv4": null,
"jail_defaultrouter_ipv6": null,
"jail_flags": "allow.raw_sockets=true",
"jail_host": "transmission_1",
"jail_ipv4": "192.168.3.2",
"jail_ipv4_netmask": "24",
"jail_ipv6": null,
"jail_ipv6_prefix": "",
"jail_mac": "02:c3:79:00:08:0b",
"jail_nat": false,
"jail_status": "Running",
"jail_type": "pluginjail",
"jail_vnet": true
}
Json Parameters: | |
---|---|
|
|
Request Headers: | |
|
|
Response Headers: | |
|
|
Status Codes: |
|
Starts a jail.
Example request:
POST /api/v1.0/jails/jails/1/start/ HTTP/1.1
Content-Type: application/json
Example response:
HTTP/1.1 202 Accepted
Vary: Accept
Content-Type: application/json
Jail started.
Request Headers: | |
---|---|
|
|
Response Headers: | |
|
|
Status Codes: |
|
Stops a jail.
Example request:
POST /api/v1.0/jails/jails/1/stop/ HTTP/1.1
Content-Type: application/json
Example response:
HTTP/1.1 202 Accepted
Vary: Accept
Content-Type: application/json
Jail stopped.
Request Headers: | |
---|---|
|
|
Response Headers: | |
|
|
Status Codes: |
|