Set jail network inheritance

PUT

/jail/{ctid}/network/inheritance

curl --request PUT \
  --url https://sylve.lan:8181/api/jail/1/network/inheritance \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "ipv4": true, "ipv6": true }'

Set IPv4 and IPv6 host-network inheritance for an inactive jail. Enabling either protocol removes the jail’s attached network records.

Authorizations

• BearerAuth

Parameters

Path Parameters

ctid

required

integer

>= 1

Jail CTID

Request Body

Network inheritance request

Media typeapplication/json

object

ipv4

required

boolean

ipv6

required

boolean

Example^generated

{
  "ipv4": true,
  "ipv6": true
}

Responses

200

Success

Media typeapplication/json

object

data

object

ctId

integer

inheritIPv4

boolean

inheritIPv6

boolean

removedNetworkIds

Array<integer>

error

string

message

string

status

string

Example^generated

{
  "data": {
    "ctId": 1,
    "inheritIPv4": true,
    "inheritIPv6": true,
    "removedNetworkIds": [
      1
    ]
  },
  "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"
}

403

Forbidden

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

409

Conflict

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

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

413

Request Entity Too Large

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