---
updatedAt: 2026-08-24T15:06:26.000Z
agentTools:
  siteIndex: https://techdocs.akamai.com/llms.txt
  projectIndex: https://techdocs.akamai.com/linode-api/llms.txt
---

# Update a shared image

__Beta__ Updates the details of an image shared within a share group. Run this operation to edit the `label` and `description` of a particular shared image.

- Run the [List share groups](ref:get-sharegroups) operation to get the `id` you should use as the `(sharegroupId)` path parameter that identifies an existing share group. To get the `imageID`, run the [List shared images by group](ref:get-sharegroup-images) operation.

- You can update either of the fields, but when you provide a new `label`, make sure that it's not an empty string.

> 📘
>
> This operation is in Beta and available from the `v4beta` URL.


**Permissions and scopes**

To call this operation, you need the following:

- **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth).

  - Scopes: `images:read_write`


**CLI**

```shell
linode-cli image-sharegroups image-update 123 1234 --label "new_label" --description "A new description."
```

[Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)

# OpenAPI definition

````json
{
  "components": {
    "securitySchemes": {
      "oauth": {
        "flows": {
          "authorizationCode": {
            "authorizationUrl": "https://login.linode.com/oauth/authorize",
            "scopes": {
              "account:read_only": "Allows access to GET information about your account.",
              "account:read_write": "Allows access to all endpoints related to your account.",
              "databases:read_only": "Allows access to GET information about databases.",
              "databases:read_write": "Allows access to all endpoints related to databases.",
              "domains:read_only": "Allows access to GET Domains on your account.",
              "domains:read_write": "Allows access to all Domain endpoints.",
              "events:read_only": "Allows access to GET your Events.",
              "events:read_write": "Allows access to all endpoints related to your Events.",
              "firewall:read_only": "Allows access to GET information about your Firewalls.",
              "firewall:read_write": "Allows access to all Firewall endpoints.",
              "images:read_only": "Allows access to GET your Images.",
              "images:read_write": "Allows access to all endpoints related to your Images.",
              "ips:read_only": "Allows access to GET your ips.",
              "ips:read_write": "Allows access to all endpoints related to your ips.",
              "linodes:read_only": "Allows access to GET Linodes on your account.",
              "linodes:read_write": "Allow access to all endpoints related to your Linodes.",
              "lke:read_only": "Allows access to GET LKE Clusters on your account.",
              "lke:read_write": "Allows access to all endpoints related to LKE Clusters on your account.",
              "longview:read_only": "Allows access to GET your Longview Clients.",
              "longview:read_write": "Allows access to all endpoints related to your Longview Clients.",
              "monitor:read-write": "Allows access to all Monitor (Akamai Cloud Pulse) endpoints.",
              "monitor:read_only": "Allows access to Monitor (Akamai Cloud Pulse) data.",
              "nodebalancers:read_only": "Allows access to GET NodeBalancers on your account.",
              "nodebalancers:read_write": "Allows access to all NodeBalancer endpoints.",
              "object_storage:read_only": "Allows access to GET information related to your Object Storage.",
              "object_storage:read_write": "Allows access to all Object Storage endpoints.",
              "stackscripts:read_only": "Allows access to GET your StackScripts.",
              "stackscripts:read_write": "Allows access to all endpoints related to your StackScripts.",
              "volumes:read_only": "Allows access to GET your Volumes.",
              "volumes:read_write": "Allows access to all endpoints related to your Volumes.",
              "vpc:read_write": "Allows access to all endpoints related to VPC and Subnet creation, updating, and deletion."
            },
            "tokenUrl": "https://login.linode.com/oauth/token"
          }
        },
        "type": "oauth2"
      },
      "personalAccessToken": {
        "scheme": "bearer",
        "type": "http"
      }
    }
  },
  "externalDocs": {
    "description": "See documentation for Akamai's Linode API",
    "url": "https://techdocs.akamai.com/linode-api/reference"
  },
  "info": {
    "description": "\"[Read the API documentation](https://techdocs.akamai.com/linode-api/reference/api).\"",
    "license": {
      "name": "Apache 2.0",
      "url": "https://www.apache.org/licenses/LICENSE-2.0.html"
    },
    "title": "Images",
    "version": "4.229.1"
  },
  "openapi": "3.0.1",
  "paths": {
    "/{apiVersion}/images/sharegroups/{sharegroupId}/images/{imageId}": {
      "put": {
        "description": "__Beta__ Updates the details of an image shared within a share group. Run this operation to edit the `label` and `description` of a particular shared image.\n\n- Run the [List share groups](https://techdocs.akamai.com/linode-api/reference/get-sharegroups) operation to get the `id` you should use as the `(sharegroupId)` path parameter that identifies an existing share group. To get the `imageID`, run the [List shared images by group](https://techdocs.akamai.com/linode-api/reference/get-sharegroup-images) operation.\n\n- You can update either of the fields, but when you provide a new `label`, make sure that it's not an empty string.\n\n> 📘\n>\n> This operation is in Beta and available from the `v4beta` URL.\n\n\n**Permissions and scopes**\n\nTo call this operation, you need the following:\n\n- **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth).\n\n  - Scopes: `images:read_write`\n\n\n**CLI**\n\n```shell\nlinode-cli image-sharegroups image-update 123 1234 --label \"new_label\" --description \"A new description.\"\n```\n\n[Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)",
        "externalDocs": {
          "description": "See documentation for this operation in Akamai's Linode API",
          "url": "https://techdocs.akamai.com/linode-api/reference/put-sharegroup-imageshare"
        },
        "operationId": "put-sharegroup-imageshare",
        "requestBody": {
          "content": {
            "application/json": {
              "example": {
                "description": "Official Debian Linux image for server deployment",
                "label": "Linux Debian"
              },
              "schema": {
                "additionalProperties": false,
                "description": "The shared image's details you want to update.",
                "properties": {
                  "description": {
                    "description": "A detailed description of this image share.",
                    "example": "Official Debian Linux image for server deployment",
                    "type": "string"
                  },
                  "label": {
                    "description": "The shared image's descriptive name.",
                    "example": "Linux Debian",
                    "type": "string"
                  }
                },
                "type": "object",
                "x-akamai": {
                  "file-path": "schemas/put-sharegroup-imageshare.yaml"
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "example": {
                  "capabilities": [
                    "cloud-init",
                    "distributed-sites"
                  ],
                  "created": "2025-08-04T10:07:59",
                  "created_by": null,
                  "deprecated": true,
                  "description": "Official Debian Linux image for server deployment",
                  "eol": "2026-03-31T13:33:52.986Z",
                  "expiry": "2026-03-31T13:33:52.986Z",
                  "id": "shared/1",
                  "image_sharing": {
                    "shared_by": {
                      "sharegroup_id": 3,
                      "sharegroup_label": "DevOps Base Images",
                      "sharegroup_uuid": "8d64b99e-92f7-4c7b-a616-8f622fffb94c",
                      "source_image_id": "private/15",
                      "source_image_label": "Source Image label"
                    },
                    "shared_with": null
                  },
                  "is_public": true,
                  "is_shared": "none",
                  "label": "Linux Debian",
                  "regions": [
                    {
                      "region": "us-iad",
                      "status": "available"
                    }
                  ],
                  "size": 256,
                  "status": "available",
                  "tags": [
                    "repair-image",
                    "fix-1"
                  ],
                  "total_size": 256,
                  "type": "shared",
                  "updated": null,
                  "vendor": "string"
                },
                "schema": {
                  "additionalProperties": false,
                  "description": "The shared image's details.",
                  "properties": {
                    "capabilities": {
                      "description": "__Read-only__ A list of the possible capabilities of this image.",
                      "example": [
                        "cloud-init",
                        "distributed-sites"
                      ],
                      "items": {
                        "type": "string"
                      },
                      "readOnly": true,
                      "type": "array",
                      "x-linode-cli-display": 7
                    },
                    "created": {
                      "description": "__Read-only__ When this image was shared.",
                      "example": "2025-08-04T10:07:59",
                      "readOnly": true,
                      "type": "string"
                    },
                    "created_by": {
                      "description": "__Read-only__ The shared image creator's username.",
                      "example": null,
                      "nullable": true,
                      "readOnly": true,
                      "type": "string"
                    },
                    "deprecated": {
                      "description": "__Read-only__ A `true` value indicates a deprecated image. Only public images can be deprecated.",
                      "readOnly": true,
                      "type": "boolean"
                    },
                    "description": {
                      "description": "The shared image's detailed description.",
                      "example": "Official Debian Linux image for server deployment",
                      "type": "string",
                      "x-linode-cli-display": 3
                    },
                    "eol": {
                      "description": "__Read-only__ The time of the public image's planned removal from service. `null` for private images.",
                      "nullable": true,
                      "readOnly": true,
                      "type": "string"
                    },
                    "expiry": {
                      "description": "__Read-only__ Only images created automatically from a deleted compute instance (`type=automatic`) expire, `null` for private images.",
                      "nullable": true,
                      "readOnly": true,
                      "type": "string"
                    },
                    "id": {
                      "description": "__Read-only__ The shared image’s unique slug identifier.",
                      "example": "shared/1",
                      "readOnly": true,
                      "type": "string",
                      "x-linode-cli-display": 1
                    },
                    "image_sharing": {
                      "additionalProperties": false,
                      "description": "__Read-only__ The image's sharing details, including the share group and source image data.",
                      "properties": {
                        "shared_by": {
                          "additionalProperties": false,
                          "properties": {
                            "sharegroup_id": {
                              "description": "__Read-only__ The share group's numeric identifier, used primarily as path parameters in URLs.",
                              "example": 3,
                              "readOnly": true,
                              "type": "integer"
                            },
                            "sharegroup_label": {
                              "description": "The share group's descriptive name.",
                              "example": "DevOps Base Images",
                              "type": "string"
                            },
                            "sharegroup_uuid": {
                              "description": "__Read-only__ The share group's unique identifier used for membership token management.",
                              "example": "8d64b99e-92f7-4c7b-a616-8f622fffb94c",
                              "format": "uuid",
                              "readOnly": true,
                              "type": "string"
                            },
                            "source_image_id": {
                              "description": "__Read-only__ The source image's slug identifier.",
                              "example": "private/15",
                              "readOnly": true,
                              "type": "string"
                            },
                            "source_image_label": {
                              "description": "__Read-only__ The source image's label.",
                              "example": "Source Image Label",
                              "readOnly": true,
                              "type": "string"
                            }
                          },
                          "required": [
                            "sharegroup_id",
                            "sharegroup_uuid",
                            "sharegroup_label",
                            "source_image_id",
                            "source_image_label"
                          ],
                          "type": "object"
                        },
                        "shared_with": {
                          "description": "The share group's and source image details.",
                          "example": null,
                          "nullable": true,
                          "type": "object"
                        }
                      },
                      "readOnly": true,
                      "type": "object"
                    },
                    "is_public": {
                      "description": "__Read-only__ A `true` value if the image is a public distribution image. A `false` value indicates private, account-specific images.",
                      "example": true,
                      "readOnly": true,
                      "type": "boolean",
                      "x-linode-cli-display": 8
                    },
                    "is_shared": {
                      "description": "__Read-only__ Indicates whether this image is shared with other accounts. The available values are:\n- `true`: The private image is shared.\n- `false`: The private image is not shared.\n- `none`: The image is not owned by you, but has been shared with your account via an image share group.",
                      "example": false,
                      "oneOf": [
                        {
                          "title": "Boolean",
                          "type": "boolean"
                        },
                        {
                          "enum": [
                            "none"
                          ],
                          "title": "String",
                          "type": "string"
                        }
                      ],
                      "readOnly": true,
                      "x-linode-cli-display": 9
                    },
                    "label": {
                      "description": "The shared image's name.",
                      "example": "Linux Debian",
                      "type": "string",
                      "x-linode-cli-display": 2
                    },
                    "regions": {
                      "description": "__Read-only__ Details on the regions where this image is stored. See [Regions and images](https://techdocs.akamai.com/cloud-computing/docs/images#regions-and-images) for full details on support for `regions`.",
                      "items": {
                        "additionalProperties": false,
                        "properties": {
                          "region": {
                            "description": "The unique identifier for the core compute region where this image is stored.",
                            "example": "us-iad",
                            "type": "string"
                          },
                          "status": {
                            "description": "The status of the image in this `region`. Possible values are `available`, `creating`, `pending`, `pending deletion`, `pending replication`, or `replicating`.",
                            "enum": [
                              "available",
                              "creating",
                              "pending",
                              "pending deletion",
                              "pending replication",
                              "replicating"
                            ],
                            "example": "available",
                            "type": "string"
                          }
                        },
                        "type": "object"
                      },
                      "readOnly": true,
                      "type": "array"
                    },
                    "size": {
                      "description": "__Read-only__ The minimum size in MB this image needs to deploy.",
                      "example": 256,
                      "readOnly": true,
                      "type": "integer",
                      "x-linode-cli-display": 4
                    },
                    "status": {
                      "description": "__Read-only__ The current status of the image. Possible values are `available`, `creating`, and `pending_upload`.",
                      "enum": [
                        "creating",
                        "pending_upload",
                        "available"
                      ],
                      "example": "available",
                      "readOnly": true,
                      "type": "string",
                      "x-linode-cli-display": 6
                    },
                    "tags": {
                      "description": "__Read-only__ The shared image's organizational tags. A tag can be from 3 to 100 characters long, and each image can include up to 500 tags.",
                      "example": [
                        "repair-image",
                        "fix-1"
                      ],
                      "items": {
                        "maxLength": 100,
                        "minLength": 3,
                        "type": "string"
                      },
                      "maxItems": 500,
                      "minItems": 0,
                      "readOnly": true,
                      "type": "array",
                      "x-linode-cli-display": 10
                    },
                    "total_size": {
                      "description": "__Read-only__ The total size in bytes of all instances of this image, in all `regions`.",
                      "example": 256,
                      "readOnly": true,
                      "type": "integer",
                      "x-linode-cli-display": 5
                    },
                    "type": {
                      "description": "__Read-only__ Indicates how the image was created. The available values are:\n- `manual`: Manually captured from a Linode's disk.\n- `automatic`: Automatically captured when the corresponding Linode was deleted.\n- `shared`: A private image assigned to an image share group, allowing other authorized accounts to view and deploy it.",
                      "enum": [
                        "manual",
                        "automatic",
                        "shared"
                      ],
                      "example": "shared",
                      "readOnly": true,
                      "type": "string"
                    },
                    "updated": {
                      "description": "__Read-only__ When this shared image was last updated.",
                      "example": null,
                      "nullable": true,
                      "readOnly": true,
                      "type": "string"
                    },
                    "vendor": {
                      "description": "__Read-only__ The upstream distribution vendor, `null` for private and shared images.",
                      "nullable": true,
                      "readOnly": true,
                      "type": "string"
                    }
                  },
                  "required": [
                    "id",
                    "tags",
                    "type",
                    "description",
                    "label",
                    "created",
                    "updated",
                    "size",
                    "status",
                    "capabilities",
                    "is_public",
                    "is_shared",
                    "deprecated",
                    "regions",
                    "total_size",
                    "image_sharing",
                    "created_by",
                    "expiry",
                    "eol",
                    "vendor"
                  ],
                  "type": "object",
                  "x-akamai": {
                    "file-path": "schemas/imageshare.yaml"
                  }
                },
                "x-linode-cli-subtables": [
                  "regions"
                ]
              }
            },
            "description": "The shared image's updated details."
          },
          "default": {
            "content": {
              "application/json": {
                "example": {
                  "errors": [
                    {
                      "reason": "Invalid JSON"
                    }
                  ]
                },
                "schema": {
                  "additionalProperties": false,
                  "properties": {
                    "errors": {
                      "description": "Any warnings associated with a response.",
                      "items": {
                        "additionalProperties": false,
                        "description": "An object for describing a single error that occurred during the processing of a request.",
                        "properties": {
                          "field": {
                            "description": "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.",
                            "example": "fieldname",
                            "type": "string"
                          },
                          "reason": {
                            "description": "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](https://techdocs.akamai.com/linode-api/reference/post-ticket) or perform some other action before you can complete the request successfully.",
                            "example": "fieldname must be a valid value",
                            "type": "string"
                          }
                        },
                        "type": "object",
                        "x-akamai": {
                          "file-path": "schemas/error-object.yaml"
                        }
                      },
                      "type": "array"
                    }
                  },
                  "type": "object"
                }
              }
            },
            "description": "See [Errors](https://techdocs.akamai.com/linode-api/reference/errors) for the range of possible error response codes."
          }
        },
        "security": [
          {
            "personalAccessToken": []
          },
          {
            "oauth": [
              "images:read_write"
            ]
          }
        ],
        "summary": "Update a shared image",
        "tags": [
          "Image sharing"
        ],
        "x-akamai": {
          "status": "BETA",
          "tabs": [
            {
              "syntax": "linode-cli image-sharegroups image-update 123 1234 --label \"new_label\" --description \"A new description.\"",
              "title": "CLI",
              "url": "https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli"
            }
          ]
        },
        "x-linode-cli-action": "image-update",
        "x-linode-grant": "read_write"
      },
      "parameters": [
        {
          "description": "__Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta.",
          "in": "path",
          "name": "apiVersion",
          "required": true,
          "schema": {
            "enum": [
              "v4",
              "v4beta"
            ],
            "example": "v4",
            "type": "string"
          },
          "x-akamai": {
            "file-path": "parameters/api-version-path.yaml"
          }
        },
        {
          "description": "The share group's unique identifier assigned after creating it. Not to be confused with the group's `uuid`.",
          "in": "path",
          "name": "sharegroupId",
          "required": true,
          "schema": {
            "example": 54321,
            "type": "integer"
          },
          "x-akamai": {
            "file-path": "parameters/sharegroup-id-path.yaml"
          }
        },
        {
          "description": "Slug identifier assigned to the shared image upon sharing.",
          "in": "path",
          "name": "imageId",
          "required": true,
          "schema": {
            "example": "shared/7",
            "type": "string"
          },
          "x-akamai": {
            "file-path": "parameters/image-id-path-w-shared-slug.yaml"
          }
        }
      ],
      "x-akamai": {
        "file-path": "paths/images-sharegroups-id-images-id.yaml",
        "path-info": "/{apiVersion}/images/sharegroups/{sharegroupId}/images/{imageId}"
      },
      "x-linode-cli-command": "image-sharegroups"
    }
  },
  "servers": [
    {
      "url": "https://api.linode.com"
    }
  ],
  "tags": [
    {
      "description": "Use these operations to create and mange groups of users that can access your stored images.",
      "name": "Image sharing"
    }
  ],
  "x-akamai": {
    "auth-type": "OAUTH",
    "file-path": "images.yaml"
  },
  "x-readme": {
    "explorer-enabled": false,
    "samples-languages": [
      "curl",
      "python",
      "node"
    ]
  }
}
````

# Sibling pages

* [Create a share group](https://techdocs.akamai.com/linode-api/reference/post-sharegroups.md)
* [List share groups](https://techdocs.akamai.com/linode-api/reference/get-sharegroups.md)
* [Create a token](https://techdocs.akamai.com/linode-api/reference/post-sharegroup-tokens.md)
* [List a user's tokens](https://techdocs.akamai.com/linode-api/reference/get-user-tokens.md)
* [Get a token's share group](https://techdocs.akamai.com/linode-api/reference/get-sharegroup-by-token.md)
* [List images by token](https://techdocs.akamai.com/linode-api/reference/get-sharegroup-images-by-token.md)
* [Get a share group](https://techdocs.akamai.com/linode-api/reference/get-sharegroup.md)
* [Update a share group](https://techdocs.akamai.com/linode-api/reference/put-sharegroup.md)
* [Delete a share group](https://techdocs.akamai.com/linode-api/reference/delete-sharegroup.md)
* [Add images to a share group](https://techdocs.akamai.com/linode-api/reference/post-sharegroup-images.md)
* [List shared images by group](https://techdocs.akamai.com/linode-api/reference/get-sharegroup-images.md)
* [Revoke access to a shared image](https://techdocs.akamai.com/linode-api/reference/delete-sharegroup-imageshare.md)
* [Add members to a share group](https://techdocs.akamai.com/linode-api/reference/post-sharegroup-members.md)
* [List members by share group](https://techdocs.akamai.com/linode-api/reference/get-sharegroup-members.md)
* [Get a membership token](https://techdocs.akamai.com/linode-api/reference/get-sharegroup-member-token.md)
* [Update a membership token](https://techdocs.akamai.com/linode-api/reference/put-sharegroup-member-token.md)
* [Revoke a membership token](https://techdocs.akamai.com/linode-api/reference/delete-sharegroup-member-token.md)
* [List share groups by image](https://techdocs.akamai.com/linode-api/reference/get-images-sharegroups-image.md)
* [Get a token](https://techdocs.akamai.com/linode-api/reference/get-sharegroup-token.md)
* [Update a token](https://techdocs.akamai.com/linode-api/reference/put-sharegroup-token.md)
* [Delete a token](https://techdocs.akamai.com/linode-api/reference/delete-sharegroup-token.md)