Images
Images List
https://api.linode.com/v4/images
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.
Query Parameters
The page of a collection to return.
The number of items to return per page.
Request Samples
- Shell
- CLI
curl https://api.linode.com/v4/images
curl -H "Authorization: Bearer $TOKEN" \
https://api.linode.com/v4/images
Response Samples
- 200
- default
{
"data": [
{
"id": "",
"created": "2021-08-14T22:44:02",
"status": "available",
"label": "Debian 11",
"type": "manual",
"updated": "2021-08-14T22:44:02",
"expiry": "",
"description": "Example Image description.",
"created_by": "linode",
"deprecated": "",
"is_public": true,
"size": 2500,
"eol": "2026-07-01T04:00:00",
"vendor": "Debian",
"capabilities": [
"cloud-init"
]
}
],
"page": 1,
"pages": 1,
"results": 1
}Responses
200: A paginated list of Images.
The unique ID of this Image.
When this Image was created.
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.
A short description of the Image.
How the Image was created.
"Manual" Images can be created at any time.
"Automatic" Images are created automatically from a deleted Linode.
When this Image was last updated.
Only Images created automatically from a deleted Linode (type=automatic) will expire.
A detailed description of this Image.
The name of the User who created this Image, or "linode" for public Images.
Whether or not this Image is deprecated. Will only be true for deprecated public Images.
True if the Image is a public distribution image. False if Image is private Account-specific Image.
The minimum size this Image needs to deploy. Size is in MB.
The date of the public Image's planned end of life. None for private Images.
The upstream distribution vendor. None for private Images.
A list containing the following possible capabilities of this Image:
cloud-init: This Image supports cloud-init with Metadata. Only applies to public Images.
The current page.
The total number of pages.
The total number of results.
default: Error
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 or perform some other action before you can complete the request successfully.
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.
Image Create
https://api.linode.com/v4/images
Captures a private gold-master Image from a Linode Disk.
Request Body Schema
The ID of the Linode Disk that this Image will be created from.
A detailed description of this Image.
A short title of this Image. Defaults to the label of the Disk it is being created from if not provided.
Request Samples
- Shell
- CLI
curl -H "Content-Type: application/json" \
-H "Authorization: Bearer $TOKEN" \
-X POST -d '{
"disk_id": 123,
"label": "this_is_a_label",
"description": "A longer description of the image"
}' \
https://api.linode.com/v4/images
Response Samples
- 200
- default
{
"status": "available",
"created": "2021-08-14T22:44:02",
"updated": "2021-08-14T22:44:02",
"expiry": "",
"id": 1234,
"label": "Debian 11",
"description": "Example Image description.",
"type": "manual",
"created_by": "linode",
"deprecated": "",
"is_public": true,
"size": 2500,
"eol": "2026-07-01T04:00:00",
"vendor": "Debian",
"capabilities": []
}Responses
200: New private Image created successfully.
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.
When this Image was created.
When this Image was last updated.
Only Images created automatically from a deleted Linode (type=automatic) will expire.
The unique ID of this Image.
A short description of the Image.
A detailed description of this Image.
How the Image was created.
"Manual" Images can be created at any time.
"Automatic" Images are created automatically from a deleted Linode.
The name of the User who created this Image, or "linode" for public Images.
Whether or not this Image is deprecated. Will only be true for deprecated public Images.
True if the Image is a public distribution image. False if Image is private Account-specific Image.
The minimum size this Image needs to deploy. Size is in MB.
The date of the public Image's planned end of life. None for private Images.
The upstream distribution vendor. None for private Images.
A list containing the following possible capabilities of this Image:
cloud-init: This Image supports cloud-init with Metadata. Only applies to public Images.
default: Error
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 or perform some other action before you can complete the request successfully.
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.