Get a configuration profile interface

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

Returns a single configuration profile interface. To access this operation, your user needs at least the read_only grant for the Linode.

linode-cli linodes config-interface-view $linodeId $configId $interfaceId


Learn more...

linodes:read_only


Learn more...

Responses

Response body

object

active

boolean

Read-only Returns true if the interface is in use, meaning that the Linode has been booted using the configuration profile to which the interface belongs.

integer

Read-only The unique ID representing this interface.

ip_ranges

array of strings | null

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

When included in a request:

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.
Submit this as an empty array removes all existing values.
Omit this object to leave existing values as is.

📘
This is only supported for interfaces with a purpose of vpc.

ip_ranges

ipam_address

string | null

This interface's private IP address in classless inter-domain routing (CIDR) notation.

For interfaces with a purpose of public:

If you include this in a request, set it to an empty string ("") or null.
Returned as null in a response.

For interfaces with a purpose of vlan:

To avoid conflicting addresses, make sure this value is unique for each vlan interface.
This should be unique among devices attached to the VLAN to avoid conflict.
If Network Helper is enabled, the Linode's interface will be automatically configured to use this address after the Linode is rebooted. If Network Helper is disabled, enable the address using manual static IP configuration.

For interfaces with a purpose of vpc:

If you include this in a request, set it to an empty string ("") or null.
Returned as null in a response.

ipv4

object

IPv4 addresses configured for this interface. This only applies to interfaces with a purpose of vpc. Returned as null if no vpc interface is assigned.

nat_1_1

string | null

The 1:1 NAT IPv4 address, used to associate a public IPv4 address with the interface's VPC subnet IPv4 address.

Only supported for interfaces with a purpose of vpc.
Returned as null if no 1:1 NAT is set for a vpc type interface.
Returned as an empty string ("") for non-vpc type interfaces.

When included in a request:

You can set this to a specific, public IPv4 address that's available on the Linode. You can also use the any keyword to enable the Linode's assigned public IPv4 address.
A specified address can't be shared with another Linode.
Omit this object or include it and set it to null or an empty string ("") to block creation of a 1:1 NAT.

📘
You can't set this to a specific IPv4 address when creating a new Linode. During the creation process, the network automatically establishes a public IPv4 address for the Linode. Since this address doesn't exist yet, you can't include a custom IPv4 address to change it. After your Linode is created, you can update your configuration profile interface to change the nat_1_1 address.

vpc

string | null

The VPC subnet IPv4 address for this interface.

This only applies to interfaces with a purpose of vpc.
Returned as an empty string ("") for non-vpc type interfaces.

When included in a request:

The vpc can't be assigned to an existing Linode as an address or in a range.
The target address can't be the first two or last two addresses in the subnet IPv4 range.
If omitted, a valid address within the Subnet IPv4 range is automatically assigned.

label

string | null

Filterable The name of this interface.

For interfaces with a purpose of vlan:

Required.
This needs to be unique among a Linode's interfaces. A Linode can't be attached to the same VLAN multiple times.
This can only contain ASCII letters, numbers, and dashes (-). You can't use two consecutive dashes (--).
If the VLAN label is new, a VLAN is created. Up to 10 VLANs can be created in each data center region. To view your active VLANs, run the List VLANs operation.

For interfaces with a purpose of public:

If you include this in a request, set it to an empty string ("") or null.
Returned as null in a response.

For interfaces with a purpose of vpc:

If you include this in a request, set it to an empty string ("") or null.
Returned as null in a response.

primary

boolean

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

📘
This needs to be set to false for any interface that uses vlan as its purpose.

purpose

string

required

The type of interface. This can be public, vlan, or vpc.

For interfaces with a purpose of public:

You can only define one public interface per Linode.
The Linode's default public IPv4 address is assigned to the public interface.
A Linode needs a public interface in the first or eth0 position to be reachable via the public internet, after it boots. If no public interface is configured, you can only access the Linode through LISH, or through another Linode that's connected to the same VLAN or VPC.

For interfaces with a purpose of vlan:

Configuring this purpose of interface attaches a Linode to the VLAN with the specified label.
If an ipam_address is configured, the Linode uses this address.

For interfaces with a purpose of vpc:

Configuring this purpose of interface attaches a Linode to an existing VPC subnet with the specified subnet_id.
When the interface is activated, the Linode is configured to use an IP address from the range in the assigned VPC subnet. See ipv4.vpc for more information.

public vlan vpc

subnet_id

integer | null

The id of the VPC subnet for this interface. Use this value in a request to assign a Linode to a VPC subnet.

Required for vpc type interfaces.
Returned as null for non-vpc type interfaces.
Once you've assigned a VPC subnet to an interface, you can't update it.
You need to reboot a Linode using the interface's configuration profile to assign the Linode to a VPC subnet.

vpc_id

integer | null

Read-only The id of the VPC configured for this interface. Returned as null for non-vpc type interfaces.

Language

Credentials


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.linode.com/v4/linode/instances/linodeId/configs/configId/interfaces/interfaceId \
3
     --header 'accept: application/json'


xxxxxxxxxx
18
 
1
{
2
  "active": true,
3
  "id": 101,
4
  "ip_ranges": [
5
    "10.0.0.64/26",
6
    "fd04:495a:691c:971c::1:0/112"
7
  ],
8
  "ipam_address": "10.0.0.1/24",
9
  "ipv4": {
10
    "nat_1_1": "string",
11
    "vpc": "10.0.0.2"
12
  },
13
  "label": "example-interface",
14
  "primary": true,
15
  "purpose": "vlan",
16
  "subnet_id": 101,
17
  "vpc_id": 111
18
}

200A configuration interface object.

📘

📘

📘

defaultSee Errors for the range of possible error response codes.