Update a jail network

PATCH

/jail/{ctid}/networks/{networkId}

curl --request PATCH \
  --url https://sylve.lan:8181/api/jail/1/networks/1 \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "defaultGateway": true, "dhcp": true, "ip4": 1, "ip4Raw": "example", "ip4gw": 1, "ip4gwRaw": "example", "ip6": 1, "ip6Raw": "example", "ip6gw": 1, "ip6gwRaw": "example", "macId": 1, "macRaw": "example", "name": "example", "slaac": true, "switchName": "example", "vlanPolicy": { "mode": "example", "taggedVlans": [ 1 ], "untaggedVlan": 1 } }'

Partially update a network attachment belonging to an inactive jail. Omitted fields are preserved, and a filtered switch requires an explicit access or trunk VLAN policy.

Authorizations

• BearerAuth

Parameters

Path Parameters

ctid

required

integer

>= 1

Jail CTID

networkId

required

integer

>= 1

Network attachment ID

Request Body

Network update request

Media typeapplication/json

object

defaultGateway

boolean

dhcp

boolean

ip4

integer

ip4Raw

string

ip4gw

integer

ip4gwRaw

string

ip6

integer

ip6Raw

string

ip6gw

integer

ip6gwRaw

string

macId

integer

macRaw

string

name

string

slaac

boolean

switchName

string

vlanPolicy

object

mode

string

taggedVlans

Array<integer>

untaggedVlan

integer

Example^generated

{
  "defaultGateway": true,
  "dhcp": true,
  "ip4": 1,
  "ip4Raw": "example",
  "ip4gw": 1,
  "ip4gwRaw": "example",
  "ip6": 1,
  "ip6Raw": "example",
  "ip6gw": 1,
  "ip6gwRaw": "example",
  "macId": 1,
  "macRaw": "example",
  "name": "example",
  "slaac": true,
  "switchName": "example",
  "vlanPolicy": {
    "mode": "example",
    "taggedVlans": [
      1
    ],
    "untaggedVlan": 1
  }
}

Responses

200

Success

Media typeapplication/json

object

data

object

attachment

object

defaultAccessVlan

integer

kind

string

Allowed values: vm jail

switchName

string

switchType

string

version

integer

vlanFiltering

boolean

vlanPolicy

object

mode

string

taggedVlans

Array<integer>

untaggedVlan

integer

defaultGateway

boolean

dhcp

boolean

id

integer

ipv4GwId

integer

ipv4GwObj

object

autoUpdate

boolean

createdAt

string

description

string

entries

Array<object>

object

createdAt

string

id

integer

objectId

integer

updatedAt

string

value

IP, CIDR, port, country code, FQDN, etc.

string

id

integer

isUsed

boolean

isUsedBy

string

lastRefreshAt

string

lastRefreshError

string

name

string

refreshIntervalSeconds

integer

resolutionChecksum

string

resolutions

Array<object>

object

createdAt

string

id

integer

objectId

integer

resolvedIp

Deprecated mirror for resolved IP entries

string

resolvedValue

string

updatedAt

string

sourceChecksum

string

type

“Host”, “Mac”, “Network”, “Port”, “Country”, “List”, “FQDN”, “DUID”

string

updatedAt

string

usedBy

Array<object>

object

id

integer

name

string

type

string

ipv4Id

integer

ipv4Obj

object

autoUpdate

boolean

createdAt

string

description

string

entries

Array<object>

object

createdAt

string

id

integer

objectId

integer

updatedAt

string

value

IP, CIDR, port, country code, FQDN, etc.

string

id

integer

isUsed

boolean

isUsedBy

string

lastRefreshAt

string

lastRefreshError

string

name

string

refreshIntervalSeconds

integer

resolutionChecksum

string

resolutions

Array<object>

object

createdAt

string

id

integer

objectId

integer

resolvedIp

Deprecated mirror for resolved IP entries

string

resolvedValue

string

updatedAt

string

sourceChecksum

string

type

“Host”, “Mac”, “Network”, “Port”, “Country”, “List”, “FQDN”, “DUID”

string

updatedAt

string

usedBy

Array<object>

object

id

integer

name

string

type

string

ipv6GwId

integer

ipv6GwObj

object

autoUpdate

boolean

createdAt

string

description

string

entries

Array<object>

object

createdAt

string

id

integer

objectId

integer

updatedAt

string

value

IP, CIDR, port, country code, FQDN, etc.

string

id

integer

isUsed

boolean

isUsedBy

string

lastRefreshAt

string

lastRefreshError

string

name

string

refreshIntervalSeconds

integer

resolutionChecksum

string

resolutions

Array<object>

object

createdAt

string

id

integer

objectId

integer

resolvedIp

Deprecated mirror for resolved IP entries

string

resolvedValue

string

updatedAt

string

sourceChecksum

string

type

“Host”, “Mac”, “Network”, “Port”, “Country”, “List”, “FQDN”, “DUID”

string

updatedAt

string

usedBy

Array<object>

object

id

integer

name

string

type

string

ipv6Id

integer

ipv6Obj

object

autoUpdate

boolean

createdAt

string

description

string

entries

Array<object>

object

createdAt

string

id

integer

objectId

integer

updatedAt

string

value

IP, CIDR, port, country code, FQDN, etc.

string

id

integer

isUsed

boolean

isUsedBy

string

lastRefreshAt

string

lastRefreshError

string

name

string

refreshIntervalSeconds

integer

resolutionChecksum

string

resolutions

Array<object>

object

createdAt

string

id

integer

objectId

integer

resolvedIp

Deprecated mirror for resolved IP entries

string

resolvedValue

string

updatedAt

string

sourceChecksum

string

type

“Host”, “Mac”, “Network”, “Port”, “Country”, “List”, “FQDN”, “DUID”

string

updatedAt

string

usedBy

Array<object>

object

id

integer

name

string

type

string

jid

integer

macId

integer

macObj

object

autoUpdate

boolean

createdAt

string

description

string

entries

Array<object>

object

createdAt

string

id

integer

objectId

integer

updatedAt

string

value

IP, CIDR, port, country code, FQDN, etc.

string

id

integer

isUsed

boolean

isUsedBy

string

lastRefreshAt

string

lastRefreshError

string

name

string

refreshIntervalSeconds

integer

resolutionChecksum

string

resolutions

Array<object>

object

createdAt

string

id

integer

objectId

integer

resolvedIp

Deprecated mirror for resolved IP entries

string

resolvedValue

string

updatedAt

string

sourceChecksum

string

type

“Host”, “Mac”, “Network”, “Port”, “Country”, “List”, “FQDN”, “DUID”

string

updatedAt

string

usedBy

Array<object>

object

id

integer

name

string

type

string

manualSwitch

object

bridge

string

createdAt

string

defaultAccessVlan

integer

id

integer

name

string

updatedAt

string

vlanFiltering

boolean

vlanStateAvailable

boolean

vlanStateError

string

name

string

slaac

boolean

standardSwitch

object

address

string

address6

string

address6Id

integer

address6Obj

object

autoUpdate

boolean

createdAt

string

description

string

entries

Array<object>

object

createdAt

string

id

integer

objectId

integer

updatedAt

string

value

IP, CIDR, port, country code, FQDN, etc.

string

id

integer

isUsed

boolean

isUsedBy

string

lastRefreshAt

string

lastRefreshError

string

name

string

refreshIntervalSeconds

integer

resolutionChecksum

string

resolutions

Array<object>

object

createdAt

string

id

integer

objectId

integer

resolvedIp

Deprecated mirror for resolved IP entries

string

resolvedValue

string

updatedAt

string

sourceChecksum

string

type

“Host”, “Mac”, “Network”, “Port”, “Country”, “List”, “FQDN”, “DUID”

string

updatedAt

string

usedBy

Array<object>

object

id

integer

name

string

type

string

addressId

integer

addressObj

object

autoUpdate

boolean

createdAt

string

description

string

entries

Array<object>

object

createdAt

string

id

integer

objectId

integer

updatedAt

string

value

IP, CIDR, port, country code, FQDN, etc.

string

id

integer

isUsed

boolean

isUsedBy

string

lastRefreshAt

string

lastRefreshError

string

name

string

refreshIntervalSeconds

integer

resolutionChecksum

string

resolutions

Array<object>

object

createdAt

string

id

integer

objectId

integer

resolvedIp

Deprecated mirror for resolved IP entries

string

resolvedValue

string

updatedAt

string

sourceChecksum

string

type

“Host”, “Mac”, “Network”, “Port”, “Country”, “List”, “FQDN”, “DUID”

string

updatedAt

string

usedBy

Array<object>

object

id

integer

name

string

type

string

addresses

Array<object>

object

cidr

string

family

integer

id

integer

object

object

autoUpdate

boolean

createdAt

string

description

string

entries

Array<object>

object

createdAt

string

id

integer

objectId

integer

updatedAt

string

value

IP, CIDR, port, country code, FQDN, etc.

string

id

integer

isUsed

boolean

isUsedBy

string

lastRefreshAt

string

lastRefreshError

string

name

string

refreshIntervalSeconds

integer

resolutionChecksum

string

resolutions

Array<object>

object

createdAt

string

id

integer

objectId

integer

resolvedIp

Deprecated mirror for resolved IP entries

string

resolvedValue

string

updatedAt

string

sourceChecksum

string

type

“Host”, “Mac”, “Network”, “Port”, “Country”, “List”, “FQDN”, “DUID”

string

updatedAt

string

usedBy

Array<object>

object

id

integer

name

string

type

string

objectId

integer

ordering

integer

switchId

integer

bridgeMacMode

string

bridgeMacObject

object

autoUpdate

boolean

createdAt

string

description

string

entries

Array<object>

object

createdAt

string

id

integer

objectId

integer

updatedAt

string

value

IP, CIDR, port, country code, FQDN, etc.

string

id

integer

isUsed

boolean

isUsedBy

string

lastRefreshAt

string

lastRefreshError

string

name

string

refreshIntervalSeconds

integer

resolutionChecksum

string

resolutions

Array<object>

object

createdAt

string

id

integer

objectId

integer

resolvedIp

Deprecated mirror for resolved IP entries

string

resolvedValue

string

updatedAt

string

sourceChecksum

string

type

“Host”, “Mac”, “Network”, “Port”, “Country”, “List”, “FQDN”, “DUID”

string

updatedAt

string

usedBy

Array<object>

object

id

integer

name

string

type

string

bridgeMacObjectId

integer

bridgeMacSourcePort

string

bridgeName

string

createdAt

string

defaultAccessVlan

integer

defaultRoute

DefaultRoute owns the IPv4 default route for static or DHCP addressing.

boolean

defaultRoute6

DefaultRoute6 owns the IPv6 default route for static or SLAAC addressing.

boolean

dhcp

boolean

disableBridgeOffloads

DisableBridgeOffloads keeps FreeBSD from changing bridge-member capabilities as transient tap and epair interfaces come and go. Sorts flapping issues (Please tell @hayzam if you faced flapping before/after enabling this option).

boolean

disableIPv6

boolean

gateway6AddressId

integer

gateway6AddressObj

object

autoUpdate

boolean

createdAt

string

description

string

entries

Array<object>

object

createdAt

string

id

integer

objectId

integer

updatedAt

string

value

IP, CIDR, port, country code, FQDN, etc.

string

id

integer

isUsed

boolean

isUsedBy

string

lastRefreshAt

string

lastRefreshError

string

name

string

refreshIntervalSeconds

integer

resolutionChecksum

string

resolutions

Array<object>

object

createdAt

string

id

integer

objectId

integer

resolvedIp

Deprecated mirror for resolved IP entries

string

resolvedValue

string

updatedAt

string

sourceChecksum

string

type

“Host”, “Mac”, “Network”, “Port”, “Country”, “List”, “FQDN”, “DUID”

string

updatedAt

string

usedBy

Array<object>

object

id

integer

name

string

type

string

gateway6Manual

string

gatewayAddressId

integer

gatewayAddressObj

object

autoUpdate

boolean

createdAt

string

description

string

entries

Array<object>

object

createdAt

string

id

integer

objectId

integer

updatedAt

string

value

IP, CIDR, port, country code, FQDN, etc.

string

id

integer

isUsed

boolean

isUsedBy

string

lastRefreshAt

string

lastRefreshError

string

name

string

refreshIntervalSeconds

integer

resolutionChecksum

string

resolutions

Array<object>

object

createdAt

string

id

integer

objectId

integer

resolvedIp

Deprecated mirror for resolved IP entries

string

resolvedValue

string

updatedAt

string

sourceChecksum

string

type

“Host”, “Mac”, “Network”, “Port”, “Country”, “List”, “FQDN”, “DUID”

string

updatedAt

string

usedBy

Array<object>

object

id

integer

name

string

type

string

gatewayManual

string

hostVlan

integer

id

integer

mtu

integer

name

string

network6Id

integer

network6Manual

string

network6Obj

object

autoUpdate

boolean

createdAt

string

description

string

entries

Array<object>

object

createdAt

string

id

integer

objectId

integer

updatedAt

string

value

IP, CIDR, port, country code, FQDN, etc.

string

id

integer

isUsed

boolean

isUsedBy

string

lastRefreshAt

string

lastRefreshError

string

name

string

refreshIntervalSeconds

integer

resolutionChecksum

string

resolutions

Array<object>

object

createdAt

string

id

integer

objectId

integer

resolvedIp

Deprecated mirror for resolved IP entries

string

resolvedValue

string

updatedAt

string

sourceChecksum

string

type

“Host”, “Mac”, “Network”, “Port”, “Country”, “List”, “FQDN”, “DUID”

string

updatedAt

string

usedBy

Array<object>

object

id

integer

name

string

type

string

networkId

integer

networkManual

string

networkObj

object

autoUpdate

boolean

createdAt

string

description

string

entries

Array<object>

object

createdAt

string

id

integer

objectId

integer

updatedAt

string

value

IP, CIDR, port, country code, FQDN, etc.

string

id

integer

isUsed

boolean

isUsedBy

string

lastRefreshAt

string

lastRefreshError

string

name

string

refreshIntervalSeconds

integer

resolutionChecksum

string

resolutions

Array<object>

object

createdAt

string

id

integer

objectId

integer

resolvedIp

Deprecated mirror for resolved IP entries

string

resolvedValue

string

updatedAt

string

sourceChecksum

string

type

“Host”, “Mac”, “Network”, “Port”, “Country”, “List”, “FQDN”, “DUID”

string

updatedAt

string

usedBy

Array<object>

object

id

integer

name

string

type

string

ports

Array<object>

object

id

integer

name

string

switch

object recursive

switchId

integer

vlanPolicy

object

mode

string

taggedVlans

Array<integer>

untaggedVlan

integer

private

boolean

slaac

boolean

updatedAt

string

vlan

integer

vlanFiltering

boolean

switchId

integer

switchType

string

vlanPolicy

object

mode

string

taggedVlans

Array<integer>

untaggedVlan

integer

error

string

message

string

status

string

Example

{
  "data": {
    "attachment": {
      "kind": "vm"
    }
  }
}

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