Images

View Image

get
https://api.linode.com/v4/images/{imageId}

Get information about a single Image.

Path Parameters

imageId
Required
string

ID of the Image to look up.

Request Samples

curl https://api.linode.com/v4/images/linode/debian9

Response Samples

{
  "id": 1234,
  "created": "2018-01-01T00:01:01",
  "label": "My gold-master image",
  "type": "manual",
  "description": "The detailed description of my Image.",
  "created_by": "somename",
  "deprecated": "",
  "is_public": "",
  "size": 2500,
  "expiry": "2018-08-01T00:01:01",
  "vendor": ""
}

Responses

200: A single Image object.

id
string

The unique ID of this Image.

created
string <date-time>

When this Image was created.

label
Filterable
string

A short description of the Image. Labels cannot contain special characters.

type
string
Enum: "manual""automatic"

How the Image was created. "Manual" Images can be created at any time. "Automatic" images are created automatically from a deleted Linode.

description
string

A detailed description of this Image.

created_by
string

The name of the User who created this Image.

deprecated
Filterable
boolean

Whether or not this Image is deprecated. Will only be True for deprecated public Images.

is_public
Filterable
boolean

True if the Image is public.

size
Filterable
integer

The minimum size this Image needs to deploy. Size is in MB.

expiry
string <date-time>

Only Images created automatically (from a deleted Linode; type=automatic) will expire.

vendor
Filterable
Nullable
string

The upstream distribution vendor. None for private Images.

default: Error

errors
array of objects
reason
string

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.

field
string

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.

Update Image

put
https://api.linode.com/v4/images/{imageId}

Updates a private Image that you have permission to read_write.

Authorizations

Personal Access Token
OAuth: ( images:read_write)

Path Parameters

imageId
Required
string

ID of the Image to look up.

Request Body Schema

description
string

A detailed description of this Image.

label
Filterable
string

A short description of the Image. Labels cannot contain special characters.

Request Samples

curl -H "Content-Type: application/json" \
    -H "Authorization: Bearer $TOKEN" \
    -X PUT -d '{
      "label": "My gold-master image",
      "description": "The detailed description of my Image."
    }' \
    https://api.linode.com/v4/images/private/67848373

Response Samples

{
  "id": 1234,
  "label": "My gold-master image",
  "type": "manual",
  "description": "The detailed description of my Image.",
  "created": "2018-01-01T00:01:01",
  "created_by": "somename",
  "deprecated": "",
  "is_public": "",
  "size": 2500,
  "expiry": "2018-08-01T00:01:01",
  "vendor": ""
}

Responses

200: The updated image.

id
string

The unique ID of this Image.

label
Filterable
string

A short description of the Image. Labels cannot contain special characters.

type
string
Enum: "manual""automatic"

How the Image was created. "Manual" Images can be created at any time. "Automatic" images are created automatically from a deleted Linode.

description
string

A detailed description of this Image.

created
string <date-time>

When this Image was created.

created_by
string

The name of the User who created this Image.

deprecated
Filterable
boolean

Whether or not this Image is deprecated. Will only be True for deprecated public Images.

is_public
Filterable
boolean

True if the Image is public.

size
Filterable
integer

The minimum size this Image needs to deploy. Size is in MB.

expiry
string <date-time>

Only Images created automatically (from a deleted Linode; type=automatic) will expire.

vendor
Filterable
Nullable
string

The upstream distribution vendor. None for private Images.

default: Error

errors
array of objects
reason
string

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.

field
string

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.

Delete Image

delete
https://api.linode.com/v4/images/{imageId}

Deletes a private Image you have permission to read_write.

Deleting an Image is a destructive action and cannot be undone.

Authorizations

Personal Access Token
OAuth: ( images:read_write)

Path Parameters

imageId
Required
string

ID of the Image to look up.

Request Samples

curl -H "Authorization: Bearer $TOKEN" \
    -X DELETE \
    https://api.linode.com/v4/images/private/67848373

Response Samples

{}

Responses

200: Delete successful

default: Error

errors
array of objects
reason
string

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.

field
string

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.