Upload an image

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 the following:

  • Identity and access permissions. Your user needs a role with these permissions assigned. 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
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

Language
Credentials
LoadingLoading…
Response
Choose an example:
application/json