Images

List Images

get
https://api.linode.com/v4/images

Returns a paginated list of Images.

  • Calling this endpoint without authentication returns all public Images.
  • Authentication is required to return a combined paginated list of all public and your private Images.

Authorizations

Personal Access Token
OAuth: ( images:read_only)

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 https://api.linode.com/v4/images

Response Samples

{
  "data": [
    {
      "id": "",
      "created": "2018-01-01T00:01:01",
      "label": "Ubuntu 17.10",
      "type": "manual",
      "description": "",
      "created_by": "linode",
      "deprecated": "",
      "is_public": true,
      "size": 2500,
      "expiry": "",
      "vendor": "Ubuntu"
    }
  ],
  "page": 1,
  "pages": 1,
  "results": 1
}

Responses

200: A paginated list of Images.

data
array of objects
id
string

The unique ID of this Image.

created
string

When this Image was created.

label
Filterable
string

A short description of the Image.

type
string
Enum: "manual""automatic"

How the Image was created. Manual Images can be created at any time. "Automatic" Images are created automatically from a deleted Linode.

description
string

A detailed description of this Image.

created_by
string

The name of the User who created this Image, or "linode" for official Images.

deprecated
Filterable
boolean

Whether or not this Image is deprecated. Will only be true for deprecated public Images.

is_public
Filterable
boolean

True if the Image is public.

size
Filterable
integer

The minimum size this Image needs to deploy. Size is in MB.

expiry
string

Only Images created automatically (from a deleted Linode; type=automatic) will expire.

vendor
Filterable
string

The upstream distribution vendor. None for private Images.

page
integer
pages
integer
results
integer

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.

Create Image

post
https://api.linode.com/v4/images

Creates a private gold-master Image from a Linode Disk. There is no additional charge to store Images for Linode users. Images are limited to three per Account.

Authorizations

Personal Access Token
OAuth: ( images:read_write)

Request Body Schema

description
string

A detailed description of this Image.

label
Filterable
string

A short description of the Image. Labels cannot contain special characters.

disk_id
Required
integer

The ID of the Linode Disk that this Image will be created from.

description
string

A detailed description of this Image.

label
string

A short title of this Image. Defaults to the label of the Disk it is being created from if not provided.

Request Samples

curl -H "Content-Type: application/json" \
    -H "Authorization: Bearer $TOKEN" \
    -X POST -d '{
      "disk_id": 123,
      "label": "this_is_a_label",
      "description": "A longer description of the image"
    }' \
    https://api.linode.com/v4/images

Response Samples

{
  "id": 1234,
  "label": "My gold-master image",
  "type": "manual",
  "description": "The detailed description of my Image.",
  "created": "2018-01-01T00:01:01",
  "created_by": "somename",
  "deprecated": "",
  "is_public": "",
  "size": 2500,
  "expiry": "2018-08-01T00:01:01",
  "vendor": ""
}

Responses

200: New private Image created successfully.

id
string

The unique ID of this Image.

label
Filterable
string

A short description of the Image. Labels cannot contain special characters.

type
string
Enum: "manual""automatic"

How the Image was created. "Manual" Images can be created at any time. "Automatic" images are created automatically from a deleted Linode.

description
string

A detailed description of this Image.

created
string <date-time>

When this Image was created.

created_by
string

The name of the User who created this Image.

deprecated
Filterable
boolean

Whether or not this Image is deprecated. Will only be True for deprecated public Images.

is_public
Filterable
boolean

True if the Image is public.

size
Filterable
integer

The minimum size this Image needs to deploy. Size is in MB.

expiry
string <date-time>

Only Images created automatically (from a deleted Linode; type=automatic) will expire.

vendor
Filterable
Nullable
string

The upstream distribution vendor. None for private Images.

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.