Update a configuration profile interface

put

https://api.linode.com/{apiVersion}/linode/instances/{linodeId}/configs/{configId}/interfaces/{interfaceId}

Update a vpc or public configuration profile interface for a specific configuration profile, on a specific Linode.

A successful request triggers a linode_config_update event.
Only certain attributes can be updated for a configuration profile interface. You need to add a new configuration profile interface on your Linode if you need new values for any other attribute. Here are the supported objects, based on the interface's purpose:
- public. The primary attribute.
- vpc. The ip_ranges, ipv4, or primary attributes.
You can't update a configuration profile with a purpose of vlan.

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_config_profile_interface
OAuth scopes. Your user needs these scopes assigned. Learn more.
- Scopes: linodes:read_write

CLI

linode-cli linodes config-interface-update $linodeId $configId $interfaceId \
  --primary true \
  --ipv4.vpc "10.0.1.2" \
  --ipv4.nat_1_1 "203.0.113.2"

Learn more

Path Params

apiVersion

string

enum

required

Enum Call either the v4 URL, or v4beta for operations still in Beta.

Allowed:

linodeId

integer

required

The id of the Linode.

configId

integer

required

The id of the Configuration Profile.

interfaceId

integer

required

The id of the Linode Configuration Profile Interface.

Body Params

Linode configuration profile interface update request object.

ip_ranges

array of strings

IPv4 CIDR VPC subnet ranges that are routed to this interface.

A range can't include any addresses that are assigned to an active Linode or another VPC subnet.
When updating, you need to include any existing ranges to maintain them. If a range is left out, it will be removed.
Include this as an empty array ([]) to remove all existing values.
Omit this array to leave all existing ip_ranges as is.

📘
This only applies to interfaces with a purpose of vpc.

ip_ranges

ipv4

object

IPv4 addresses configured for this interface.

📘
This only applies to interfaces with a purpose of vpc.

primary

boolean

Set to true to label this configuration profile interface as the default route to the Linode.

Each Linode can have one interface set as its primary.
If you don't specifically set a primary, the first non-vlan type interface is automatically treated as the primary.

Responses

200Configuration profile interface successfully updated.

defaultSee Errors for the range of possible error response codes.