Linode Instances

List Configuration Profiles

get
https://api.linode.com/v4/linode/instances/{linodeId}/configs

Lists Configuration profiles associated with a Linode.

Authorizations

Personal Access Token
OAuth: ( linodes:read_only)

Path Parameters

linodeId
Required
integer

ID of the Linode to look up Configuration profiles for.

Query Parameters

page
integer > = 1
Default: 1

The page of a collection to return.

page_size
integer [25 .. 100]
Default: 100

The number of items to return per page.

Request Samples

curl -H "Authorization: Bearer $TOKEN" \
    https://api.linode.com/v4/linode/instances/123/configs

Response Samples

{
  "data": [
    {
      "id": "",
      "label": "My Config",
      "kernel": "linode/latest-64bit",
      "comments": "This is my main Config",
      "memory_limit": 2048,
      "run_level": "default",
      "virt_mode": "paravirt",
      "helpers": {
        "updatedb_disabled": true,
        "distro": true,
        "modules_dep": true,
        "network": true,
        "devtmpfs_automount": ""
      },
      "devices": {
        "sda": "",
        "sdb": "",
        "sdc": "",
        "sdd": "",
        "sde": "",
        "sdf": "",
        "sdg": "",
        "sdh": ""
      },
      "root_device": "/dev/sda"
    }
  ],
  "page": 1,
  "pages": 1,
  "results": 1
}

Responses

200: Returns an array of Configuration profiles associated with this Linode.

data
array of objects
id
integer

The ID of this Config.

label
Filterable
string

The Config's label is for display purposes only.

kernel
string

A Kernel ID to boot a Linode with. Defaults to "linode/latest-64bit".

comments
Nullable
string

Optional field for arbitrary User comments on this Config.

memory_limit
integer

Defaults to the total RAM of the Linode.

run_level
string
Enum: "default""single""binbash"

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

virt_mode
string
Enum: "paravirt""fullvirt"

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.
  • full_virt affords more customization, but is slower because 100% of the VM is virtualized.
helpers
object

Helpers enabled when booting to this Linode Config.

updatedb_disabled
boolean

Disables updatedb cron job to avoid disk thrashing.

distro
boolean

Helps maintain correct inittab/upstart console device.

modules_dep
boolean

Creates a modules dependency file for the Kernel you run.

network
boolean

Automatically configures static networking.

devtmpfs_automount
boolean

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

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 waiting for a device to exist before being able to boot.
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.

disk_id
integer

The Disk ID, or null if a Volume is assigned to this slot.

volume_id
integer

The Volume ID, or null if a Disk is assigned to this slot.

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.

disk_id
integer

The Disk ID, or null if a Volume is assigned to this slot.

volume_id
integer

The Volume ID, or null if a Disk is assigned to this slot.

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.

disk_id
integer

The Disk ID, or null if a Volume is assigned to this slot.

volume_id
integer

The Volume ID, or null if a Disk is assigned to this slot.

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.

disk_id
integer

The Disk ID, or null if a Volume is assigned to this slot.

volume_id
integer

The Volume ID, or null if a Disk is assigned to this slot.

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.

disk_id
integer

The Disk ID, or null if a Volume is assigned to this slot.

volume_id
integer

The Volume ID, or null if a Disk is assigned to this slot.

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.

disk_id
integer

The Disk ID, or null if a Volume is assigned to this slot.

volume_id
integer

The Volume ID, or null if a Disk is assigned to this slot.

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.

disk_id
integer

The Disk ID, or null if a Volume is assigned to this slot.

volume_id
integer

The Volume ID, or null if a Disk is assigned to this slot.

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.

disk_id
integer

The Disk ID, or null if a Volume is assigned to this slot.

volume_id
integer

The Volume ID, or null if a Disk is assigned to this slot.

root_device
stringa-z, A-Z, 0-9, /, _, -

The root device to boot.

  • If no value or an invalid value is provided, root device will default to /dev/sda.
  • If the device specified at the root device location is not mounted, the Linode will not boot until a device is mounted.
page
integer
pages
integer
results
integer

Create Configuration Profile

post
https://api.linode.com/v4/linode/instances/{linodeId}/configs

Adds a new Configuration profile to a Linode.

Authorizations

Personal Access Token
OAuth: ( linodes:read_write)

Path Parameters

linodeId
Required
integer

ID of the Linode to look up Configuration profiles for.

Request Body Schema

devices
Required
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 waiting for a device to exist before being able to boot.
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.

disk_id
integer

The Disk ID, or null if a Volume is assigned to this slot.

volume_id
integer

The Volume ID, or null if a Disk is assigned to this slot.

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.

disk_id
integer

The Disk ID, or null if a Volume is assigned to this slot.

volume_id
integer

The Volume ID, or null if a Disk is assigned to this slot.

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.

disk_id
integer

The Disk ID, or null if a Volume is assigned to this slot.

volume_id
integer

The Volume ID, or null if a Disk is assigned to this slot.

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.

disk_id
integer

The Disk ID, or null if a Volume is assigned to this slot.

volume_id
integer

The Volume ID, or null if a Disk is assigned to this slot.

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.

disk_id
integer

The Disk ID, or null if a Volume is assigned to this slot.

volume_id
integer

The Volume ID, or null if a Disk is assigned to this slot.

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.

disk_id
integer

The Disk ID, or null if a Volume is assigned to this slot.

volume_id
integer

The Volume ID, or null if a Disk is assigned to this slot.

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.

disk_id
integer

The Disk ID, or null if a Volume is assigned to this slot.

volume_id
integer

The Volume ID, or null if a Disk is assigned to this slot.

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.

disk_id
integer

The Disk ID, or null if a Volume is assigned to this slot.

volume_id
integer

The Volume ID, or null if a Disk is assigned to this slot.

label
Required
Filterable
string [1 .. 48] characters

The Config's label is for display purposes only.

comments
Nullable
string

Optional field for arbitrary User comments on this Config.

helpers
object

Helpers enabled when booting to this Linode Config.

updatedb_disabled
boolean

Disables updatedb cron job to avoid disk thrashing.

distro
boolean

Helps maintain correct inittab/upstart console device.

modules_dep
boolean

Creates a modules dependency file for the Kernel you run.

network
boolean

Automatically configures static networking.

devtmpfs_automount
boolean

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

kernel
string

A Kernel ID to boot a Linode with. Defaults to "linode/latest-64bit".

memory_limit
integer

Defaults to the total RAM of the Linode.

root_device
string a-z, A-Z, 0-9, /, _, -

The root device to boot.

  • If no value or an invalid value is provided, root device will default to /dev/sda.
  • If the device specified at the root device location is not mounted, the Linode will not boot until a device is mounted.
run_level
string
Enum: "default""single""binbash"

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

virt_mode
string
Enum: "paravirt""fullvirt"

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.
  • full_virt affords more customization, but is slower because 100% of the VM is virtualized.

Request Samples

curl -H "Content-Type: application/json" \
    -H "Authorization: Bearer $TOKEN" \
    -X POST -d '{
      "kernel": "linode/latest-64bit",
      "comments": "This is my main Config",
      "memory_limit": 2048,
      "run_level": "default",
      "virt_mode": "paravirt",
      "helpers": {
        "updatedb_disabled": true,
        "distro": true,
        "modules_dep": true,
        "network": true,
        "devtmpfs_automount": false
      },
      "label": "My Config",
      "devices": {
        "sda": {
          "disk_id": 123456,
          "volume_id": null
        },
        "sdb": {
          "disk_id": 123457,
          "volume_id": null
        }
      }
    }' \
    https://api.linode.com/v4/linode/instances/123/configs

Response Samples

{
  "id": 1234,
  "label": "My Config",
  "kernel": "linode/latest-64bit",
  "comments": "This is my main Config",
  "memory_limit": 2048,
  "run_level": "default",
  "virt_mode": "paravirt",
  "helpers": [
    {
      "updatedb_disabled": true,
      "distro": true,
      "modules_dep": true,
      "network": true,
      "devtmpfs_automount": ""
    }
  ],
  "devices": [
    {
      "sda": "",
      "sdb": "",
      "sdc": "",
      "sdd": "",
      "sde": "",
      "sdf": "",
      "sdg": "",
      "sdh": ""
    }
  ],
  "root_device": "/dev/sda"
}

Responses

200: A Configuration profile was created.

id
integer

The ID of this Config.

label
Filterable
string [1 .. 48] characters

The Config's label is for display purposes only.

kernel
string

A Kernel ID to boot a Linode with. Defaults to "linode/latest-64bit".

comments
Nullable
string

Optional field for arbitrary User comments on this Config.

memory_limit
integer

Defaults to the total RAM of the Linode.

run_level
string
Enum: "default""single""binbash"

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

virt_mode
string
Enum: "paravirt""fullvirt"

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.
  • full_virt affords more customization, but is slower because 100% of the VM is virtualized.
helpers
object

Helpers enabled when booting to this Linode Config.

updatedb_disabled
boolean

Disables updatedb cron job to avoid disk thrashing.

distro
boolean

Helps maintain correct inittab/upstart console device.

modules_dep
boolean

Creates a modules dependency file for the Kernel you run.

network
boolean

Automatically configures static networking.

devtmpfs_automount
boolean

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

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 waiting for a device to exist before being able to boot.
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.

disk_id
integer

The Disk ID, or null if a Volume is assigned to this slot.

volume_id
integer

The Volume ID, or null if a Disk is assigned to this slot.

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.

disk_id
integer

The Disk ID, or null if a Volume is assigned to this slot.

volume_id
integer

The Volume ID, or null if a Disk is assigned to this slot.

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.

disk_id
integer

The Disk ID, or null if a Volume is assigned to this slot.

volume_id
integer

The Volume ID, or null if a Disk is assigned to this slot.

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.

disk_id
integer

The Disk ID, or null if a Volume is assigned to this slot.

volume_id
integer

The Volume ID, or null if a Disk is assigned to this slot.

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.

disk_id
integer

The Disk ID, or null if a Volume is assigned to this slot.

volume_id
integer

The Volume ID, or null if a Disk is assigned to this slot.

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.

disk_id
integer

The Disk ID, or null if a Volume is assigned to this slot.

volume_id
integer

The Volume ID, or null if a Disk is assigned to this slot.

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.

disk_id
integer

The Disk ID, or null if a Volume is assigned to this slot.

volume_id
integer

The Volume ID, or null if a Disk is assigned to this slot.

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.

disk_id
integer

The Disk ID, or null if a Volume is assigned to this slot.

volume_id
integer

The Volume ID, or null if a Disk is assigned to this slot.

root_device
string a-z, A-Z, 0-9, /, _, -

The root device to boot.

  • If no value or an invalid value is provided, root device will default to /dev/sda.
  • If the device specified at the root device location is not mounted, the Linode will not boot until a device is mounted.

default: Error

errors
array of objects
reason
string

What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.

field
string

The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as "null" if the error is not specific to any single element of the request.