API

Upload an image

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

Creates a new private image container and returns a URL as the upload_to object in the response. Use this URL to upload your own disk image to the container.

👍

There's a tutorial

This operation has specific requirements for use. Check out its workflow for details.

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

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

    • Scopes: images:read_write

CLI

# Run the operation to just get the upload_to URL
linode-cli images upload \
  --description "Optional details about the Image" \
  --label "Example Image" \
  --region us-east

# Upload the image file in a single step
linode-cli image-upload \
  --description "Optional details about the Image" \
  --label "Example Image" \
  --region us-east \
  /path/to/image-file.img.gz

Learn more

Path Params
string
enum
required

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

Allowed:
Body Params

The uploaded image details.

boolean

Whether the uploaded Image supports cloud-init.

string

Description for the uploaded image.

string
required

Label for the uploaded image.

string
required

The region to upload to. Once uploaded, the image can be used in any region.

📘

Only core regions that support our Object Storage service can store an uploaded image.

tags
array of strings
length between 0 and 500

Tags you can use to organize images. A tag can be from 3 to 100 characters long, and an image can have a maximum of 500 total tags.

tags
Responses

Response body
object
image
object

Image object.

capabilities
array of strings
required

Read-only A list of the possible capabilities of this image.

  • cloud-init. The image supports the cloud-init multi-distribution method with our Metadata service. This only applies to public images.

  • distributed-sites. Whether the image can be used in distributed compute regions. Compared to a core compute region, distributed compute regions offer limited functionality, but they're globally distributed. Your image can be geographically closer to you, potentially letting you deploy it quicker. See Regions and images for complete details.

capabilities*
date-time
required

Read-only When this image was created.

string
required

Read-only The name of the user who created this image, or linode for public images.

boolean
required

Filterable, Read-only A true value indicates a deprecated image. Only public images can be deprecated.

string | null
required

A detailed description of this image.

date-time | null
required

Read-only The time of the public image's planned removal from service. This is null for private images.

date-time | null
required

Read-only Only images created automatically from a deleted compute instance (type=automatic) expire. This is null for private images.

string
required

Read-only The unique identifier for each image.

shared_with | shared_by
required

Details about image sharing.

boolean
required

Filterable, Read-only A true value if the image is a public distribution image. A false value indicates private, account-specific images.

string
enum
required

Filterable, Read-only A true value for shared private images. none for images shared within a group.

true false none

string
required

Filterable A short description of the image.

regions
array of objects
required

Read-only Details on the regions where this image is stored. See Regions and images for full details on support for regions.

regions*
object
string

The unique identifier for the core compute region where this image is stored.

string
enum

The status of the image in this region. Possible values are available, creating, pending, pending deletion, pending replication, or replicating.

available creating pending pending deletion pending replication replicating

integer
required

Filterable, Read-only The minimum size in MB this image needs to deploy.

string
enum
required

Filterable, Read-only The current status of the image. Possible values are available, creating, and pending_upload.

📘

The +order_by and +order operators are not available when filtering on this key.

creating pending_upload available

tags
array of strings
required
length between 0 and 500

Filterable Tags used for organizational purposes. A tag can be from 3 to 100 characters long, and an image can have a maximum of 500 total tags.

tags*
integer
required

Read-only The total size in bytes of all instances of this image, in all regions.

📘

This object is empty for existing images. It's intended for use with future functionality.

string
enum
required

Filterable, Read-only How the image was created. Create a manual image at any time. An automatic image is created automatically from a deleted compute instance. Other users within share groups can access a shared image.

manual automatic shared

date-time
required

Read-only When this image was last updated.

string | null
required

Filterable, Read-only The upstream distribution vendor. This is null for private images.

string

The URL to upload the Image to.

Language
Credentials

Updated 29 days ago

Did this page help you?
Original text
Rate this translation
Your feedback will be used to help improve Google Translate