Skip to main content
PATCH
Update an image's metadata
Primary IAM action: compute:UpdateImage. Updating a platform image requires a principal acting in the platform account with compute:UpdateImage; other accounts receive 403. See COMPUTE permissions for policy examples.

Authorizations

Authorization
string
header
required

An OAuth 2.0 bearer token, sent as Authorization: Bearer <token>. This is the recommended way to authenticate.

Get one by exchanging a service account's access key pair at POST /v1/oauth/token with grant_type=client_credentials. It is the standard client-credentials grant, so any OAuth-aware library will obtain and refresh it for you.

Tokens last an hour by default. The same access key pair is separately your AWS SigV4 credential for the S3-compatible object endpoint, which speaks nothing else.

Path Parameters

image_id
string<uuid>
required

Image ID

Body

application/json
description
string
Example:

"Ubuntu 24.04 LTS (Noble Numbat)"

current
boolean

Switch the resolve-by-name pointer for this image's name. true promotes this version to current (the switch / rollback action) and demotes whatever else was current for the same (name, architecture); false clears the pointer. Only active images can be made current.

Example:

true

eol_date
string<date> | null

Set the release's end-of-life date. An explicit null clears it; omitting the field leaves it unchanged. Clearing matters because the catalog withdraws platform images on this date — one recorded by mistake has to be removable.

Example:

"2026-08-31"

tags
object
Example:
attributes
object

Response

Updated image

image
object
required