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 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 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.

    • Scopes: images:read_write

CLI

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

Learn more

Path Params
string
enum
required

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

Allowed:
integer
required

The share group's unique identifier assigned after creating it. Not to be confused with the group's uuid.

string
required

Slug identifier assigned to the shared image upon sharing.

Body Params

The shared image's details you want to update.

string

A detailed description of this image share.

string

The shared image's descriptive name.

Responses

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