API

Create a configuration profile

post
https://api.linode.com//linode/instances//configs

Adds a new configuration profile to a Linode. Configuration profiles define the kernel, devices, and how much memory a Linode boots with.

📘

This operation is for legacy configuration profiles only, and not Linode interfaces.

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: create_linode_config_profile

  • OAuth scopes. Your user needs these scopes assigned. Learn more.

    • Scopes: linodes:read_write

CLI

linode-cli linodes config-create 7590910 \
  --label "My Config" \
  --devices.sda.disk_id 123456 \
  --devices.sdb.disk_id 123457

Learn more

Path Params
string
enum
required

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

Allowed:
integer
required

ID of the Linode to look up Configuration profiles for.

Body Params
string | null

Optional field for arbitrary user comments on this configuration.

devices
object
required

A dictionary of device disks to use as a device map in a Linode's configuration profile.

  • An empty device disk dictionary or a dictionary with empty values for device slots is allowed.
  • If no devices are specified, booting from this configuration will hold until a device exists that allows the boot process to start.
helpers
object

Helpers enabled when booting to this Linode configuration.

interfaces
array of objects
length between 1 and 3

interfaces is applicable only to legacy configuration profiles and does not apply to Linode interfaces.

From one to three network interfaces to add to this Linode's configuration profile. The position in the array determines which of the Linode's network interfaces is configured:

  • First [0]: eth0
  • Second [1]: eth1
  • Third [2]: eth2

When updating a Linode's legacy interfaces, each interface must be redefined. An empty interfaces array results in a default public type interface configuration only.

If no public Interface is configured, public IP addresses are still assigned to the Linode but will not be usable without manual configuration.

📘

Changes to Linode Interface configurations can be enabled by rebooting the Linode.

vpc details

See the VPC documentation guide for its specifications and limitations.

vlan details

  • Only Next Generation Network (NGN) data centers support VLANs. Run the List regions operation to view the capabilities of data center regions. If a VLAN is attached to your Linode and you attempt to migrate or clone it to a non-NGN data center, the migration or cloning will not initiate. If a Linode cannot be migrated or cloned because of an incompatibility, you will be prompted to select a different data center or contact support.
  • See the VLANs Overview guide to view additional specifications and limitations.
interfaces
string
Defaults to linode/latest-64bit

The ID of the kernel used to boot a Linode. Run the List kernels operation to see all available kernels. Here are some commonly used kernels:

  • linode/latest-64bit. This is the default, our latest kernel at the time of an instance boot or reboot.

  • linode/grub2. The upstream distribution-supplied kernel that's installed on the primary disk, or a custom kernel if installed.

  • linode/direct-disk. The master boot record (MBR) of the primary disk or root device. Use this in place of a Linux kernel.

string
required
length between 1 and 48

Filterable The name of the configuration for display in Akamai Cloud Manager.

integer

Defaults to the total RAM of the Linode.

string

The root device to boot.

📘

  • If you leave this empty or set an invalid value, the root device defaults to /dev/sda.

  • If you specify a device at the root device location and it's not mounted, the Linode won't boot until a device is mounted.

string
enum

Defines the state of your Linode after booting. Defaults to default.

Allowed:
string
enum

Controls the virtualization mode. Defaults to paravirt.

  • paravirt is suitable for most cases. Linodes running in paravirt mode share some qualities with the host, ultimately making it run faster since there is less transition between it and the host.

  • fullvirt affords more customization, but is slower because 100% of the VM is virtualized.

Allowed:
Responses

Response body
object
string | null

Optional field for arbitrary user comments on this configuration.

devices
object

A dictionary of device disks to use as a device map in a Linode's configuration profile.

  • An empty device disk dictionary or a dictionary with empty values for device slots is allowed.
  • If no devices are specified, booting from this configuration will hold until a device exists that allows the boot process to start.
sda
object

Device can be either a Disk or Volume identified by disk_id or volume_id. Only one type per slot allowed. Can be null. Devices mapped from sde through sdh are unavailable in fullvirt virt_mode.

sdb
object

Device can be either a Disk or Volume identified by disk_id or volume_id. Only one type per slot allowed. Can be null. Devices mapped from sde through sdh are unavailable in fullvirt virt_mode.

sdc
object

Device can be either a Disk or Volume identified by disk_id or volume_id. Only one type per slot allowed. Can be null. Devices mapped from sde through sdh are unavailable in fullvirt virt_mode.

sdd
object

Device can be either a Disk or Volume identified by disk_id or volume_id. Only one type per slot allowed. Can be null. Devices mapped from sde through sdh are unavailable in fullvirt virt_mode.

sde
object

Device can be either a Disk or Volume identified by disk_id or volume_id. Only one type per slot allowed. Can be null. Devices mapped from sde through sdh are unavailable in fullvirt virt_mode.

sdf
object

Device can be either a Disk or Volume identified by disk_id or volume_id. Only one type per slot allowed. Can be null. Devices mapped from sde through sdh are unavailable in fullvirt virt_mode.

sdg
object

Device can be either a Disk or Volume identified by disk_id or volume_id. Only one type per slot allowed. Can be null. Devices mapped from sde through sdh are unavailable in fullvirt virt_mode.

sdh
object

Device can be either a Disk or Volume identified by disk_id or volume_id. Only one type per slot allowed. Can be null. Devices mapped from sde through sdh are unavailable in fullvirt virt_mode.

helpers
object

Helpers enabled when booting to this Linode configuration.

boolean
Defaults to false

Populates the /dev directory early during boot without udev. Defaults to false.

boolean

Helps maintain correct inittab or upstart console device.

boolean

Creates a modules dependency file for the kernel you run.

boolean | null

Set to true to automatically configure static networking. The network option applies only to legacy configuration profile interfaces and does not apply to Linode interfaces.

boolean

Set to true to disable the updatedb cron job to avoid disk thrashing.

integer

Read-only The ID of this Config.

interfaces
array of objects
length between 1 and 3

interfaces is applicable only to legacy configuration profiles and does not apply to Linode interfaces.

From one to three network interfaces to add to this Linode's configuration profile. The position in the array determines which of the Linode's network interfaces is configured:

  • First [0]: eth0
  • Second [1]: eth1
  • Third [2]: eth2

When updating a Linode's legacy interfaces, each interface must be redefined. An empty interfaces array results in a default public type interface configuration only.

If no public Interface is configured, public IP addresses are still assigned to the Linode but will not be usable without manual configuration.

📘

Changes to Linode Interface configurations can be enabled by rebooting the Linode.

vpc details

See the VPC documentation guide for its specifications and limitations.

vlan details

  • Only Next Generation Network (NGN) data centers support VLANs. Run the List regions operation to view the capabilities of data center regions. If a VLAN is attached to your Linode and you attempt to migrate or clone it to a non-NGN data center, the migration or cloning will not initiate. If a Linode cannot be migrated or cloned because of an incompatibility, you will be prompted to select a different data center or contact support.
  • See the VLANs Overview guide to view additional specifications and limitations.
interfaces
object
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
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.

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.

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.

string
enum
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

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.

integer | null

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

string
Defaults to linode/latest-64bit

The ID of the kernel used to boot a Linode. Run the List kernels operation to see all available kernels. Here are some commonly used kernels:

  • linode/latest-64bit. This is the default, our latest kernel at the time of an instance boot or reboot.

  • linode/grub2. The upstream distribution-supplied kernel that's installed on the primary disk, or a custom kernel if installed.

  • linode/direct-disk. The master boot record (MBR) of the primary disk or root device. Use this in place of a Linux kernel.

string
length between 1 and 48

Filterable The name of the configuration for display in Akamai Cloud Manager.

integer

Defaults to the total RAM of the Linode.

string

The root device to boot.

📘

  • If you leave this empty or set an invalid value, the root device defaults to /dev/sda.

  • If you specify a device at the root device location and it's not mounted, the Linode won't boot until a device is mounted.

string
enum

Defines the state of your Linode after booting. Defaults to default.

default single binbash

string
enum

Controls the virtualization mode. Defaults to paravirt.

  • paravirt is suitable for most cases. Linodes running in paravirt mode share some qualities with the host, ultimately making it run faster since there is less transition between it and the host.

  • fullvirt affords more customization, but is slower because 100% of the VM is virtualized.

paravirt fullvirt

Language
Credentials

Updated 13 days ago

Did this page help you?