Update an image

put

https://api.linode.com/{apiVersion}/images/{imageId}

Updates a private image.

📘
You can't update the regions with this operation. Use the Replicate an image operation to modify the existing regions for your image.

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: update_image
OAuth scopes. Your user needs these scopes assigned. Learn more.
- Scopes: images:read_write

CLI

linode-cli images update private/12345 \
  --label "My gold-master image" \
  --description "The detailed description \
    of my image."

Learn more

Responses

Response body

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*

created

date-time

required

Read-only When this image was created.

created_by

string

required

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

deprecated

boolean

required

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

description

string | null

required

A detailed description of this image.

eol

date-time | null

required

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

expiry

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.

image_sharing

shared_with | shared_by

required

Details about image sharing.

shared_with

shared_by

is_public

boolean

required

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

is_shared

string

enum

required

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

true false none

label

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

region

string

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

status

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

size

integer

required

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

status

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*

total_size

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.

type

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

updated

date-time

required

Read-only When this image was last updated.

vendor

string | null

required

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

Language

Credentials


xxxxxxxxxx
1
curl --request PUT \
2
     --url https://api.linode.com/v4/images/imageId \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'


xxxxxxxxxx
39
 
1
{
2
  "capabilities": [
3
    "cloud-init",
4
    "distributed-sites"
5
  ],
6
  "created": "2021-08-14T22:44:02",
7
  "created_by": "linode",
8
  "deprecated": false,
9
  "description": "Example image description.",
10
  "eol": "2026-07-01T04:00:00",
11
  "expiry": null,
12
  "id": "private/15",
13
  "image_sharing": {
14
    "shared_by": null,
15
    "shared_with": {
16
      "sharegroup_count": 0,
17
      "sharegroup_list_url": "/images/private/15/sharegroups"
18
    }
19
  },
20
  "is_public": false,
21
  "is_shared": false,
22
  "label": "Debian 11",
23
  "regions": [
24
    {
25
      "region": "us-iad",
26
      "status": "available"
27
    }
28
  ],
29
  "size": 2500,
30
  "status": "available",
31
  "tags": [
32
    "repair-image",
33
    "fix-1"
34
  ],
35
  "total_size": 1234567,
36
  "type": "manual",
37
  "updated": "2021-08-14T22:44:02",
38
  "vendor": "Debian"
39
}

200The updated image.

defaultSee Errors for the range of possible error response codes.