sharegroup_images

Creates, updates, deletes, gets or lists a sharegroup_images resource.

Overview

Name	sharegroup_images
Type	Resource
Id	linode.images.sharegroup_images

Fields

The following fields are returned by SELECT queries:

list_by_token

A paginated list of shared images in a share group.

Name	Datatype	Description
id	string	Read-only The shared image's unique idenfifier. (example: shared/1)
capabilities	array	Read-only A list of the possible capabilities of this image.
created	string (date-time)	Read-only When this image share was created. (example: 2025-08-04T10:07:59)
created_by	string	Read-only The shared image creator's username.
deprecated	boolean	Read-only A true value indicates a deprecated image. Only public images can be deprecated.
description	string	The shared image's detailed description. (example: Official Debian Linux image for server deployment)
eol	string (date-time)	Read-only The time of the public image's planned removal from service. null for private images.
expiry	string (date-time)	Read-only Only images created automatically from a deleted compute instance (type=automatic) expire, null for private images.
image_sharing	object	Read-only Sharing information for the image, including who it was shared by and with.
is_public	boolean	Read-only A true value if the image is a public distribution image. A false value indicates private, account-specific images.
is_shared	string	Read-only A true value for shared private images. none for images shared within a group. (true, false, none) (example: none)
label	string	Filterable The shared image's name. (example: Linux Debian)
regions	array	Filterable, Read-only Details on the regions where this image is stored. See Regions and images for full details on support for regions.
size	integer	Read-only The minimum size in MB this image needs to deploy.
status	string	Read-only The current status of the image. Possible values are available, creating, and pending_upload. (creating, pending_upload, available) (example: available)
tags	array	Filterable, 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.
total_size	integer	Read-only The total size in bytes of all instances of this image, in all regions.
type	string	Filterable, Read-only Indicates how the image was created. It's always shared for images in a shared group. An automatic image is created automatically from a deleted compute instance. Other users within share groups can access a shared image. (manual, automatic, shared) (example: shared)
updated	string (date-time)	Read-only When this image share was last updated.
vendor	string	Read-only The upstream distribution vendor, null for private and shared images.

list

Returns a paginated list of shared images within a given group.

Name	Datatype	Description
id	string	Read-only The shared image's unique idenfifier. (example: shared/1)
capabilities	array	Read-only A list of the possible capabilities of this image.
created	string (date-time)	Read-only When this image share was created. (example: 2025-08-04T10:07:59)
created_by	string	Read-only The shared image creator's username.
deprecated	boolean	Read-only A true value indicates a deprecated image. Only public images can be deprecated.
description	string	The shared image's detailed description. (example: Official Debian Linux image for server deployment)
eol	string (date-time)	Read-only The time of the public image's planned removal from service. null for private images.
expiry	string (date-time)	Read-only Only images created automatically from a deleted compute instance (type=automatic) expire, null for private images.
image_sharing	object	Read-only Sharing information for the image, including who it was shared by and with.
is_public	boolean	Read-only A true value if the image is a public distribution image. A false value indicates private, account-specific images.
is_shared	string	Read-only A true value for shared private images. none for images shared within a group. (true, false, none) (example: none)
label	string	Filterable The shared image's name. (example: Linux Debian)
regions	array	Filterable, Read-only Details on the regions where this image is stored. See Regions and images for full details on support for regions.
size	integer	Read-only The minimum size in MB this image needs to deploy.
status	string	Read-only The current status of the image. Possible values are available, creating, and pending_upload. (creating, pending_upload, available) (example: available)
tags	array	Filterable, 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.
total_size	integer	Read-only The total size in bytes of all instances of this image, in all regions.
type	string	Filterable, Read-only Indicates how the image was created. It's always shared for images in a shared group. An automatic image is created automatically from a deleted compute instance. Other users within share groups can access a shared image. (manual, automatic, shared) (example: shared)
updated	string (date-time)	Read-only When this image share was last updated.
vendor	string	Read-only The upstream distribution vendor, null for private and shared images.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_by_token	select	tokenUuid		Lists all the shared images a member can access within a share group, using a membership token. To get the token_uuid, run the Get a token operation. Learn more... Learn more...
list	select	sharegroupId		Get the details about images shared in a particular group you own. - Run the List share groups operation to get the id you should use as the (sharegroupId) path parameter that identifies an existing share group. Learn more... Learn more...
create	insert	sharegroupId, images		Adds images to an existing group where you can share them with other members. - Run the List share groups operation to get the id you should use as the (sharegroupId) path parameter that identifies an existing share group. - Run the Get an image operation to see the existing images' id values. If needed, Create an image or Upload an image. - You can set a label and description for each image, visible to all group members. If omitted, the shared image keeps the original image's details. Note that when you Update the original image, it has no effect on a shared image's details within any groups. Learn more... Learn more...
update	replace	sharegroupId, imageId		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. Learn more... Learn more...
delete	delete	sharegroupId, imageId		Revokes access to a shared image within an owned group for all members. - 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. - To add a private image back to a share group, run the Add images to a share group. Learn more... Learn more...

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
imageId	string	Slug identifier assigned to the shared image upon sharing.
sharegroupId	string	The share group's unique identifier assigned after creating it. Not to be confused with the group's uuid.
tokenUuid	string (uuid)	A unique identifier for the token, used to reference it after creation.

SELECT examples

list_by_token

Lists all the shared images a member can access within a share group, using a membership token. To get the token_uuid, run the Get a token operation.

Learn more...

Learn more...

SELECT
id,
capabilities,
created,
created_by,
deprecated,
description,
eol,
expiry,
image_sharing,
is_public,
is_shared,
label,
regions,
size,
status,
tags,
total_size,
type,
updated,
vendor
FROM linode.images.sharegroup_images
WHERE tokenUuid = '{{ tokenUuid }}' -- required
;

list

Get the details about images shared in a particular group you own.

- Run the List share groups operation to get the id you should use as the (sharegroupId) path parameter that identifies an existing share group.

Learn more...

Learn more...

SELECT
id,
capabilities,
created,
created_by,
deprecated,
description,
eol,
expiry,
image_sharing,
is_public,
is_shared,
label,
regions,
size,
status,
tags,
total_size,
type,
updated,
vendor
FROM linode.images.sharegroup_images
WHERE sharegroupId = '{{ sharegroupId }}' -- required
;

INSERT examples

create

Adds images to an existing group where you can share them with other members.

- Run the List share groups operation to get the id you should use as the (sharegroupId) path parameter that identifies an existing share group.

- Run the Get an image operation to see the existing images' id values. If needed, Create an image or Upload an image.

- You can set a label and description for each image, visible to all group members. If omitted, the shared image keeps the original image's details. Note that when you Update the original image, it has no effect on a shared image's details within any groups.

Learn more...

Learn more...

INSERT INTO linode.images.sharegroup_images (
images,
sharegroupId
)
SELECT 
'{{ images }}' /* required */,
'{{ sharegroupId }}'
RETURNING
id,
capabilities,
created,
created_by,
deprecated,
description,
eol,
expiry,
image_sharing,
is_public,
is_shared,
label,
regions,
size,
status,
tags,
total_size,
type,
updated,
vendor
;

Manifest

# Description fields are for documentation purposes
- name: sharegroup_images
props:
  - name: sharegroupId
    value: "{{ sharegroupId }}"
    description: Required parameter for the sharegroup_images resource.
  - name: images
    value:
      - description: "{{ description }}"
        id: "{{ id }}"
        label: "{{ label }}"

REPLACE examples

update

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.

Learn more...

Learn more...

REPLACE linode.images.sharegroup_images
SET 
description = '{{ description }}',
label = '{{ label }}'
WHERE 
sharegroupId = '{{ sharegroupId }}' --required
AND imageId = '{{ imageId }}' --required
RETURNING
id,
capabilities,
created,
created_by,
deprecated,
description,
eol,
expiry,
image_sharing,
is_public,
is_shared,
label,
regions,
size,
status,
tags,
total_size,
type,
updated,
vendor;

DELETE examples

delete

Revokes access to a shared image within an owned group for all members.

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

- To add a private image back to a share group, run the Add images to a share group.

Learn more...

Learn more...

DELETE FROM linode.images.sharegroup_images
WHERE sharegroupId = '{{ sharegroupId }}' --required
AND imageId = '{{ imageId }}' --required
;