{"description":"api_interface_config","type":"object","properties":{"id":{"description":"Unique identifier for this interface configuration","type":"number"},"name":{"description":"Name of the configured interface i.e. bond0","type":"string"},"default_gateway":{"description":"Default IPv4 gateway on which all traffic generated from nodes is sent out on this interface","type":"string"},"default_gateway_ipv6":{"description":"Default IPv6 gateway on which all traffic generated from nodes is sent out on this interface","type":"string"},"bonding_mode":{"type":"string","enum":["ACTIVE_BACKUP","IEEE_8023AD"],"description":"Linux bonding mode on this interface, if it is bonded.:\n * `ACTIVE_BACKUP` - BONDING_MODE_ACTIVE_BACKUP,\n * `IEEE_8023AD` - BONDING_MODE_IEEE_8023AD"},"mtu":{"description":"Maximum transmission unit configuration value","type":"number"}}}
PUT
Set configuration of an interface. Changes in interface MTU will be applied to the untagged STATIC network as well as the interface.
Parameters
Name
Description
Required
interface_id
The unique ID of the network interface
Yes
If-Match
ETag for expected version
No
Request
Schema
{"description":"api_interface_config","type":"object","properties":{"id":{"description":"Unique identifier for this interface configuration","type":"number"},"name":{"description":"Name of the configured interface i.e. bond0","type":"string"},"default_gateway":{"description":"Default IPv4 gateway on which all traffic generated from nodes is sent out on this interface","type":"string"},"default_gateway_ipv6":{"description":"Default IPv6 gateway on which all traffic generated from nodes is sent out on this interface","type":"string"},"bonding_mode":{"type":"string","enum":["ACTIVE_BACKUP","IEEE_8023AD"],"description":"Linux bonding mode on this interface, if it is bonded.:\n * `ACTIVE_BACKUP` - BONDING_MODE_ACTIVE_BACKUP,\n * `IEEE_8023AD` - BONDING_MODE_IEEE_8023AD"},"mtu":{"description":"Maximum transmission unit configuration value","type":"number"}}}
Response
Codes
Code
Description
202
Return value on success
PATCH
Update a subset of an interface configuration. Changes in interface MTU will be applied to the untagged STATIC network as well as the interface.
Parameters
Name
Description
Required
interface_id
The unique ID of the network interface
Yes
If-Match
ETag for expected version
No
Request
Schema
{"description":"api_interface_config","type":"object","properties":{"id":{"description":"Unique identifier for this interface configuration","type":"number"},"name":{"description":"Name of the configured interface i.e. bond0","type":"string"},"default_gateway":{"description":"Default IPv4 gateway on which all traffic generated from nodes is sent out on this interface","type":"string"},"default_gateway_ipv6":{"description":"Default IPv6 gateway on which all traffic generated from nodes is sent out on this interface","type":"string"},"bonding_mode":{"type":"string","enum":["ACTIVE_BACKUP","IEEE_8023AD"],"description":"Linux bonding mode on this interface, if it is bonded.:\n * `ACTIVE_BACKUP` - BONDING_MODE_ACTIVE_BACKUP,\n * `IEEE_8023AD` - BONDING_MODE_IEEE_8023AD"},"mtu":{"description":"Maximum transmission unit configuration value","type":"number"}}}
