Update Linode interface settings

put

https://api.linode.com/{apiVersion}/linode/instances/{linodeId}/interfaces/settings

Updates Network Helper and default route settings on the Linode. Before enabling or disabling Network Helper, you need to power off the Linode.

Permissions and scopes

To call this operation, you need permissions, based on the model you're using:

Identity and access permissions. Your user needs a role with these permissions. Learn more.
- Permissions: update_linode
OAuth scopes. Your user needs these scopes assigned. Learn more.
- Scopes: linodes:read_write

CLI

Public interface

linode-cli linodes interface-settings-update $linodeId \
  --network_helper true \
  --default_route.ipv4_interface_id 4527 \
  --default_route.ipv6_interface_id 4541 \
  --default_route.ipv4_eligible_interface_ids 4527 \
  --default_route.ipv4_eligible_interface_ids 4541 \
  --default_route.ipv6_eligible_interface_ids 4527 \
  --default_route.ipv6_eligible_interface_ids 4541

VLAN interface

linode-cli linodes interface-settings-update $linodeId \
  --network_helper true

VPC interface

linode-cli linodes interface-settings-update $linodeId \
  --network_helper true \
  --default_route.ipv4_interface_id 5527 \
  --default_route.ipv4_eligible_interface_ids 5527 \
  --default_route.ipv4_eligible_interface_ids 5541

Learn more

Responses

Response body

object

default_route

object

Interfaces used for the IPv4 default_route and IPv6 default_route when multiple interfaces are eligible for the role.

ipv4_eligible_interface_ids

array of integers

Read-only The VPC or public interface IDs that are eligible to be the IPv4 default_route for this Linode. If the ipv4_eligible_interface_ids array is empty, this means there are no eligible interfaces eligible for the IPv4 default route role.

ipv4_eligible_interface_ids

ipv4_interface_id

integer | null

Defaults to null

The VPC or public interface ID assigned as the IPv4 default_route. The List Linode interface settings operation provides eligible IPv4 interface IDs.

ipv6_eligible_interface_ids

array of integers

Read-only The public interface IDs that are eligible to be the IPv6 default_route for this Linode. If the ipv6_eligible_interface_ids array is empty, this means there are no eligible interfaces eligible for the IPv6 default route role.

ipv6_eligible_interface_ids

ipv6_interface_id

integer | null

Defaults to null

The public interface ID assigned as the IPv6 default_route. The List Linode interface settings operation provides eligible IPv6 interface IDs.

network_helper

boolean

Enables the Network Helper feature. The default value is determined by the network_helper setting in the account settings. Power off the Linode before disabling or enabling Network Helper.

Language

Credentials


xxxxxxxxxx
1
curl --request PUT \
2
     --url https://api.linode.com/v4/linode/instances/linodeId/interfaces/settings \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'


xxxxxxxxxx
15
 
1
{
2
  "default_route": {
3
    "ipv4_eligible_interface_ids": [
4
      1,
5
      2
6
    ],
7
    "ipv4_interface_id": 1,
8
    "ipv6_eligible_interface_ids": [
9
      4,
10
      5
11
    ],
12
    "ipv6_interface_id": 4
13
  },
14
  "network_helper": false
15
}

200The updated Linode interface settings.

defaultSee Errors for the range of possible error response codes.