images

Overview

Name	images
Type	Resource
Id	linode.images.images

Fields

Name	Datatype	Description
id	string	The unique ID of this Image.
description	string	A detailed description of this Image.
created	string	When this Image was created.
created_by	string	The name of the User who created this Image, or "linode" for public Images.
deprecated	boolean	Whether or not this Image is deprecated. Will only be true for deprecated public Images.
eol	string	The date of the public Image's planned end of life. None for private Images.
expiry	string	Only Images created automatically from a deleted Linode (type=automatic) will expire.
is_public	boolean	True if the Image is a public distribution image. False if Image is private Account-specific Image.
label	string	A short description of the Image.
size	integer	The minimum size this Image needs to deploy. Size is in MB.
status	string	The current status of this Image. Only Images in an "available" status can be deployed. Images in a "creating" status are being created from a Linode Disk, and will become "available" shortly. Images in a "pending_upload" status are waiting for data to be uploaded, and become "available" after the upload and processing are complete. The "+order_by" and "+order" operators are not available for filtering on this key.
type	string	How the Image was created. "Manual" Images can be created at any time. "Automatic" Images are created automatically from a deleted Linode.
updated	string	When this Image was last updated.
vendor	string	The upstream distribution vendor. None for private Images.

Methods

Name	Accessible by	Required Params	Description
getImage	SELECT	imageId	Get information about a single Image. Public Images have IDs that begin with "linode/". These distribution images are generally available to all users. Private Images have IDs that begin with "private/". These Images are Account-specific and only accessible to Users with appropriate Grants. * To view a public Image, call this endpoint with or without authentication. To view a private Image, call this endpoint with authentication.
getImages	SELECT		Returns a paginated list of Images. Public Images have IDs that begin with "linode/". These distribution images are generally available to all users. Private Images have IDs that begin with "private/". These Images are Account-specific and only accessible to Users with appropriate Grants. * To view only public Images, call this endpoint with or without authentication. To view private Images as well, call this endpoint with authentication.
createImage	INSERT	data__disk_id	Captures a private gold-master Image from a Linode Disk.
deleteImage	DELETE	imageId	Deletes a private Image you have permission to read_write. Deleting an Image is a destructive action and cannot be undone.
_getImage	EXEC	imageId	Get information about a single Image. Public Images have IDs that begin with "linode/". These distribution images are generally available to all users. Private Images have IDs that begin with "private/". These Images are Account-specific and only accessible to Users with appropriate Grants. * To view a public Image, call this endpoint with or without authentication. To view a private Image, call this endpoint with authentication.
_getImages	EXEC		Returns a paginated list of Images. Public Images have IDs that begin with "linode/". These distribution images are generally available to all users. Private Images have IDs that begin with "private/". These Images are Account-specific and only accessible to Users with appropriate Grants. * To view only public Images, call this endpoint with or without authentication. To view private Images as well, call this endpoint with authentication.
post_images_upload	EXEC	data__label, data__region	Initiates an Image upload. This endpoint creates a new private Image object and returns it along with the URL to which image data can be uploaded. - Image data must be uploaded within 24 hours of creation or the upload will be cancelled and the image deleted. - Image uploads should be made as an HTTP PUT request to the URL returned in the upload_to response parameter, with a Content-type: application/octet-stream header included in the request. For example: curl -v \ -H "Content-Type: application/octet-stream" \ --upload-file example.img.gz \ $UPLOAD_URL \ --progress-bar \ --output /dev/null - Uploaded image data should be compressed in gzip (.gz) format. The uncompressed disk should be in raw disk image (.img) format. A maximum compressed file size of 5GB is supported for upload at this time. Note: To initiate and complete an Image upload in a single step, see our guide on how to Upload an Image using Cloud Manager or the Linode CLI image-upload plugin.
updateImage	EXEC	imageId	Updates a private Image that you have permission to read_write.