Images v4.174.0

Images List

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

Returns a paginated list of Images.

Public Images have IDs that begin with “linode/”. These distribution images are generally available to all users.
Private Images have IDs that begin with “private/”. These Images are Account-specific and only accessible to Users with appropriate Grants.
To view only public Images, call this endpoint with or without authentication. To view private Images as well, call this endpoint with authentication.

Authorizations

personalAccessToken
oauth	images:read_only

Query Parameters

page

Type:: [integer] >= 1
Default: 1
Default:: 1

The page of a collection to return.

page_size

Type:: [integer] 25..500
Default: 100
Default:: 100

The number of items to return per page.

Request Samples

Response Samples

Responses

Image Create

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

Captures a private gold-master Image from a Linode Disk.

Authorizations

personalAccessToken
oauth	images:read_write,linodes:read_only

Request Samples

Request Body Schema

cloud_init	`[boolean]` Whether this Image supports cloud-init.
description	`[string]` A detailed description of this Image.
disk_id Required	`[integer]` The ID of the Linode Disk that this Image will be created from.
label	`[string]` A short title of this Image. Defaults to the label of the Disk it is being created from if not provided.

Response Samples

Responses

Image Upload

POST https://api.linode.com/v4/images/upload

Initiates an Image upload.

This endpoint creates a new private Image object and returns it along with the URL to which image data can be uploaded.

Image data must be uploaded within 24 hours of creation or the upload will be canceled and the image deleted.
Image uploads should be made as an HTTP PUT request to the URL returned in the upload_to response parameter, with a Content-type: application/octet-stream header included in the request. For example:
```
curl -v \
  -H "Content-Type: application/octet-stream" \
  --upload-file example.img.gz \
  $UPLOAD_URL \
  --progress-bar \
  --output /dev/null
```
Uploaded image data should be compressed in gzip (.gz) format. The uncompressed disk should be in raw disk image (.img) format. A maximum compressed file size of 5GB is supported for upload at this time.

Note: To initiate and complete an Image upload in a single step, see our guide on how to Upload an Image using Cloud Manager or the Linode CLI image-upload plugin.

Authorizations

personalAccessToken
oauth	images:read_write

Request Samples

Request Body Schema

cloud_init	`[boolean]` Whether the uploaded Image supports cloud-init.
description	`[string]` Description for the uploaded Image.
label Required	`[string]` Label for the uploaded Image.
region Required	`[string]` The region to upload to. Once uploaded, the Image can be used in any region.

Response Samples

Responses

Image Delete

DELETE https://api.linode.com/v4/images/{imageId}

Deletes a private Image you have permission to read_write.

Deleting an Image is a destructive action and cannot be undone.

Authorizations

personalAccessToken
oauth	images:read_write

Path Parameters

imageId

[string]

Required

ID of the Image to look up.

Request Samples

Response Samples

Responses

Image View

GET https://api.linode.com/v4/images/{imageId}

Get information about a single Image.

Public Images have IDs that begin with “linode/”. These distribution images are generally available to all users.
Private Images have IDs that begin with “private/”. These Images are Account-specific and only accessible to Users with appropriate Grants.
To view a public Image, call this endpoint with or without authentication. To view a private Image, call this endpoint with authentication.

Authorizations

personalAccessToken
oauth	images:read_only

Path Parameters

imageId

[string]

Required

ID of the Image to look up.

Request Samples

Response Samples

Responses

Image Update

PUT https://api.linode.com/v4/images/{imageId}

Updates a private Image that you have permission to read_write.

Authorizations

personalAccessToken
oauth	images:read_write

Path Parameters

imageId

[string]

Required

ID of the Image to look up.

Request Samples

Request Body Schema

description Nullable	`[string]` 1..65000 characters A detailed description of this Image.
label	`[string]` A short description of the Image.

capabilities	`[array]` A list containing the following possible capabilities of this Image: `cloud-init`: This Image supports cloud-init with Metadata. Only applies to public Images.
created	`[string]<date-time>` When this Image was created.
created_by	`[string]` The name of the User who created this Image, or “linode” for public Images.
deprecated	`[boolean]` Whether or not this Image is deprecated. Will only be true for deprecated public Images.
description Nullable	`[string]` 1..65000 characters A detailed description of this Image.
eol Nullable	`[string]<date-time>` The date of the public Image’s planned end of life. `null` for private Images.
expiry Nullable	`[string]<date-time>` Only Images created automatically from a deleted Linode (type=automatic) will expire. `null` for private Images.
id	`[string]` The unique ID of this Image.
is_public	`[boolean]` True if the Image is a public distribution image. False if Image is private Account-specific Image.
label	`[string]` A short description of the Image.
size	`[integer]` The minimum size this Image needs to deploy. Size is in MB.
status	`[string]` Enum: `creating` `pending_upload` `available` The current status of this Image. Only Images in an “available” status can be deployed. Images in a “creating” status are being created from a Linode Disk, and will become “available” shortly. Images in a “pending_upload” status are waiting for data to be uploaded, and become “available” after the upload and processing are complete. The “+order_by” and “+order” operators are not available for filtering on this key.
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.
updated	`[string]<date-time>` When this Image was last updated.
vendor Nullable	`[string]` The upstream distribution vendor. `null` for private Images.

capabilities	`[array]` A list containing the following possible capabilities of this Image: `cloud-init`: This Image supports cloud-init with Metadata. Only applies to public Images.
created	`[string]<date-time>` When this Image was created.
created_by	`[string]` The name of the User who created this Image, or “linode” for public Images.
deprecated	`[boolean]` Whether or not this Image is deprecated. Will only be true for deprecated public Images.
description Nullable	`[string]` 1..65000 characters A detailed description of this Image.
eol Nullable	`[string]<date-time>` The date of the public Image’s planned end of life. `null` for private Images.
expiry Nullable	`[string]<date-time>` Only Images created automatically from a deleted Linode (type=automatic) will expire. `null` for private Images.
id	`[string]` The unique ID of this Image.
is_public	`[boolean]` True if the Image is a public distribution image. False if Image is private Account-specific Image.
label	`[string]` A short description of the Image.
size	`[integer]` The minimum size this Image needs to deploy. Size is in MB.
status	`[string]` Enum: `creating` `pending_upload` `available` The current status of this Image. Only Images in an “available” status can be deployed. Images in a “creating” status are being created from a Linode Disk, and will become “available” shortly. Images in a “pending_upload” status are waiting for data to be uploaded, and become “available” after the upload and processing are complete. The “+order_by” and “+order” operators are not available for filtering on this key.
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.
updated	`[string]<date-time>` When this Image was last updated.
vendor Nullable	`[string]` The upstream distribution vendor. `null` for private Images.

capabilities	`[array]` A list containing the following possible capabilities of this Image: `cloud-init`: This Image supports cloud-init with Metadata. Only applies to public Images.
created	`[string]<date-time>` When this Image was created.
created_by	`[string]` The name of the User who created this Image, or “linode” for public Images.
deprecated	`[boolean]` Whether or not this Image is deprecated. Will only be true for deprecated public Images.
description Nullable	`[string]` 1..65000 characters A detailed description of this Image.
eol Nullable	`[string]<date-time>` The date of the public Image’s planned end of life. `null` for private Images.
expiry Nullable	`[string]<date-time>` Only Images created automatically from a deleted Linode (type=automatic) will expire. `null` for private Images.
id	`[string]` The unique ID of this Image.
is_public	`[boolean]` True if the Image is a public distribution image. False if Image is private Account-specific Image.
label	`[string]` A short description of the Image.
size	`[integer]` The minimum size this Image needs to deploy. Size is in MB.
status	`[string]` Enum: `creating` `pending_upload` `available` The current status of this Image. Only Images in an “available” status can be deployed. Images in a “creating” status are being created from a Linode Disk, and will become “available” shortly. Images in a “pending_upload” status are waiting for data to be uploaded, and become “available” after the upload and processing are complete. The “+order_by” and “+order” operators are not available for filtering on this key.
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.
updated	`[string]<date-time>` When this Image was last updated.
vendor Nullable	`[string]` The upstream distribution vendor. `null` for private Images.

Search Results

No Results

Filters

Images v4.174.0

Images List

Authorizations

Query Parameters

Request Samples

Response Samples

Responses

Image Create

Authorizations

Request Samples

Request Body Schema

Response Samples

Responses

Image Upload

Authorizations

Request Samples

Request Body Schema

Response Samples

Responses

Image Delete

Authorizations

Path Parameters

Request Samples

Response Samples

Responses

Image View

Authorizations

Path Parameters

Request Samples

Response Samples

Responses

Image Update

Authorizations

Path Parameters

Request Samples

Request Body Schema

Response Samples

Responses

On this page