Method: imageFamilyViews.get

Returns the latest image that is part of an image family, is not deprecated and is rolled out in the specified zone.

HTTP request

GET https://compute.googleapis.com/compute/v1/projects/{project}/zones/{zone}/imageFamilyViews/{family}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
project

string

Project ID for this request.
zone

string

The name of the zone for this request.
family

string

Name of the image family to search for.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

JSON representation 
{
  "image": {
    "kind": string,
    "id": string,
    "creationTimestamp": string,
    "name": string,
    "description": string,
    "sourceType": enum,
    "rawDisk": {
      "source": string,
      "sha1Checksum": string,
      "containerType": enum
    },
    "deprecated": {
      "state": enum,
      "replacement": string,
      "deprecated": string,
      "obsolete": string,
      "deleted": string
    },
    "status": enum,
    "archiveSizeBytes": string,
    "diskSizeGb": string,
    "sourceDisk": string,
    "sourceDiskId": string,
    "licenses": [
      string
    ],
    "family": string,
    "imageEncryptionKey": {
      "sha256": string,
      "kmsKeyServiceAccount": string,

      
      "rawKey": string,
      "rsaEncryptedKey": string,
      "kmsKeyName": string
      
    },
    "sourceDiskEncryptionKey": {
      "sha256": string,
      "kmsKeyServiceAccount": string,

      
      "rawKey": string,
      "rsaEncryptedKey": string,
      "kmsKeyName": string
      
    },
    "selfLink": string,
    "labels": {
      string: string,
      ...
    },
    "labelFingerprint": string,
    "guestOsFeatures": [
      {
        "type": enum
      }
    ],
    "licenseCodes": [
      string
    ],
    "sourceImage": string,
    "sourceImageId": string,
    "sourceImageEncryptionKey": {
      "sha256": string,
      "kmsKeyServiceAccount": string,

      
      "rawKey": string,
      "rsaEncryptedKey": string,
      "kmsKeyName": string
      
    },
    "sourceSnapshot": string,
    "sourceSnapshotId": string,
    "sourceSnapshotEncryptionKey": {
      "sha256": string,
      "kmsKeyServiceAccount": string,

      
      "rawKey": string,
      "rsaEncryptedKey": string,
      "kmsKeyName": string
      
    },
    "storageLocations": [
      string
    ],
    "shieldedInstanceInitialState": {
      "pk": {
        "content": string,
        "fileType": enum
      },
      "keks": [
        {
          "content": string,
          "fileType": enum
        }
      ],
      "dbs": [
        {
          "content": string,
          "fileType": enum
        }
      ],
      "dbxs": [
        {
          "content": string,
          "fileType": enum
        }
      ]
    },
    "satisfiesPzs": boolean,
    "architecture": enum,
    "enableConfidentialCompute": boolean,
    "satisfiesPzi": boolean
  }
}
Fields
image

object

The latest image that is part of the specified image family in the requested location, and that is not deprecated.
image.kind

string

[Output Only] Type of the resource. Always compute#image for images.
image.id

string (uint64 format)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.
image.creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.
image.name

string

Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
image.description

string

An optional description of this resource. Provide this property when you create the resource.
image.sourceType

enum

The type of the image used to create this disk. The default and only valid value is RAW.
image.rawDisk

object

The parameters of the raw disk image.
image.rawDisk.source

string

The full Google Cloud Storage URL where the raw disk image archive is stored. The following are valid formats for the URL:

In order to create an image, you must provide the full or partial URL of one of the following:

  • The rawDisk.source URL
  • The sourceDisk URL
  • The sourceImage URL
  • The sourceSnapshot URL

image.rawDisk.sha1Checksum
(deprecated)

string

[Deprecated] This field is deprecated. An optional SHA1 checksum of the disk image before unpackaging provided by the client when the disk image is created.
image.rawDisk.containerType

enum

The format used to encode and transmit the block device, which should be TAR. This is just a container and transmission format and not a runtime format. Provided by the client when the disk image is created.
image.deprecated

object

The deprecation status associated with this image.
image.deprecated.state

enum

The deprecation state of this resource. This can be ACTIVE, DEPRECATED, OBSOLETE, or DELETED. Operations which communicate the end of life date for an image, can use ACTIVE. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error.
image.deprecated.replacement

string

The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
image.deprecated.deprecated

string

An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DEPRECATED. This is only informational and the status will not change unless the client explicitly changes it.
image.deprecated.obsolete

string

An optional RFC3339 timestamp on or after which the state of this resource is intended to change to OBSOLETE. This is only informational and the status will not change unless the client explicitly changes it.
image.deprecated.deleted

string

An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DELETED. This is only informational and the status will not change unless the client explicitly changes it.
image.status

enum

[Output Only] The status of the image. An image can be used to create other resources, such as instances, only after the image has been successfully created and the status is set to READY. Possible values are FAILED, PENDING, or READY.
image.archiveSizeBytes

string (int64 format)

Size of the image tar.gz archive stored in Google Cloud Storage (in bytes).
image.diskSizeGb

string (int64 format)

Size of the image when restored onto a persistent disk (in GB).
image.sourceDisk

string

URL of the source disk used to create this image. For example, the following are valid values:

In order to create an image, you must provide the full or partial URL of one of the following:

  • The rawDisk.source URL
  • The sourceDisk URL
  • The sourceImage URL
  • The sourceSnapshot URL

image.sourceDiskId

string

[Output Only] The ID value of the disk used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given disk name.
image.licenses[]

string

Any applicable license URI.
image.family

string

The name of the image family to which this image belongs. The image family name can be from a publicly managed image family provided by Compute Engine, or from a custom image family you create. For example, centos-stream-9 is a publicly available image family. For more information, see Image family best practices.

When creating disks, you can specify an image family instead of a specific image name. The image family always returns its latest image that is not deprecated. The name of the image family must comply with RFC1035.
image.imageEncryptionKey

object

Encrypts the image using a customer-supplied encryption key.

After you encrypt an image with a customer-supplied key, you must provide the same key if you use the image later (e.g. to create a disk from the image).

Customer-supplied encryption keys do not protect access to metadata of the disk.

If you do not provide an encryption key when creating the image, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the image later.
image.imageEncryptionKey.rawKey

string

Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: 

"rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="

image.imageEncryptionKey.rsaEncryptedKey

string

Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: 

"rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
The key must meet the following requirements before you can provide it to Compute Engine:
  1. The key is wrapped using a RSA public key certificate provided by Google.
  2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding.
Gets the RSA public key certificate provided by Google at: 
 https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
image.imageEncryptionKey.kmsKeyName

string

The name of the encryption key that is stored in Google Cloud KMS. For example: 

"kmsKeyName": "projects/ kms_project_id/locations/ region/keyRings/ key_region/cryptoKeys/key
The fully-qualifed key name may be returned for resource GET requests. For example: 
"kmsKeyName": "projects/ kms_project_id/locations/ region/keyRings/ key_region/cryptoKeys/key /cryptoKeyVersions/1
image.imageEncryptionKey.sha256

string

[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
image.imageEncryptionKey.kmsKeyServiceAccount

string

The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. For example: 

"kmsKeyServiceAccount": "name@ projectId.iam.gserviceaccount.com/

image.sourceDiskEncryptionKey

object

The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.
image.sourceDiskEncryptionKey.rawKey

string

Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: 

"rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="

image.sourceDiskEncryptionKey.rsaEncryptedKey

string

Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: 

"rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
The key must meet the following requirements before you can provide it to Compute Engine:
  1. The key is wrapped using a RSA public key certificate provided by Google.
  2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding.
Gets the RSA public key certificate provided by Google at: 
 https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
image.sourceDiskEncryptionKey.kmsKeyName

string

The name of the encryption key that is stored in Google Cloud KMS. For example: 

"kmsKeyName": "projects/ kms_project_id/locations/ region/keyRings/ key_region/cryptoKeys/key
The fully-qualifed key name may be returned for resource GET requests. For example: 
"kmsKeyName": "projects/ kms_project_id/locations/ region/keyRings/ key_region/cryptoKeys/key /cryptoKeyVersions/1
image.sourceDiskEncryptionKey.sha256

string

[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
image.sourceDiskEncryptionKey.kmsKeyServiceAccount

string

The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. For example: 

"kmsKeyServiceAccount": "name@ projectId.iam.gserviceaccount.com/

image.selfLink

string

[Output Only] Server-defined URL for the resource.
image.labels

map (key: string, value: string)

Labels to apply to this image. These can be later modified by the setLabels method.
image.labelFingerprint

string (bytes format)

A fingerprint for the labels being applied to this image, which is essentially a hash of the labels used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet.

To see the latest fingerprint, make a get() request to retrieve an image.

A base64-encoded string.
image.guestOsFeatures[]

object

A list of features to enable on the guest operating system. Applicable only for bootable images. To see a list of available options, see the guestOSfeatures[].type parameter.
image.guestOsFeatures[].type

enum

The ID of a supported feature. To add multiple values, use commas to separate values. Set to one or more of the following values:

  • VIRTIO_SCSI_MULTIQUEUE
  • WINDOWS
  • MULTI_IP_SUBNET
  • UEFI_COMPATIBLE
  • GVNIC
  • SEV_CAPABLE
  • SUSPEND_RESUME_COMPATIBLE
  • SEV_LIVE_MIGRATABLE_V2
  • SEV_SNP_CAPABLE
  • TDX_CAPABLE
  • IDPF
For more information, see Enabling guest operating system features.
image.licenseCodes[]

string (int64 format)

Integer license codes indicating which licenses are attached to this image.
image.sourceImage

string

URL of the source image used to create this image. The following are valid formats for the URL:

In order to create an image, you must provide the full or partial URL of one of the following:

  • The rawDisk.source URL
  • The sourceDisk URL
  • The sourceImage URL
  • The sourceSnapshot URL

image.sourceImageId

string

[Output Only] The ID value of the image used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given image name.
image.sourceImageEncryptionKey

object

The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
image.sourceImageEncryptionKey.rawKey

string

Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: 

"rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="

image.sourceImageEncryptionKey.rsaEncryptedKey

string

Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: 

"rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
The key must meet the following requirements before you can provide it to Compute Engine:
  1. The key is wrapped using a RSA public key certificate provided by Google.
  2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding.
Gets the RSA public key certificate provided by Google at: 
 https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
image.sourceImageEncryptionKey.kmsKeyName

string

The name of the encryption key that is stored in Google Cloud KMS. For example: 

"kmsKeyName": "projects/ kms_project_id/locations/ region/keyRings/ key_region/cryptoKeys/key
The fully-qualifed key name may be returned for resource GET requests. For example: 
"kmsKeyName": "projects/ kms_project_id/locations/ region/keyRings/ key_region/cryptoKeys/key /cryptoKeyVersions/1
image.sourceImageEncryptionKey.sha256

string

[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
image.sourceImageEncryptionKey.kmsKeyServiceAccount

string

The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. For example: 

"kmsKeyServiceAccount": "name@ projectId.iam.gserviceaccount.com/

image.sourceSnapshot

string

URL of the source snapshot used to create this image. The following are valid formats for the URL:

In order to create an image, you must provide the full or partial URL of one of the following:

  • The rawDisk.source URL
  • The sourceDisk URL
  • The sourceImage URL
  • The sourceSnapshot URL

image.sourceSnapshotId

string

[Output Only] The ID value of the snapshot used to create this image. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given snapshot name.
image.sourceSnapshotEncryptionKey

object

The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key.
image.sourceSnapshotEncryptionKey.rawKey

string

Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: 

"rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="

image.sourceSnapshotEncryptionKey.rsaEncryptedKey

string

Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: 

"rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
The key must meet the following requirements before you can provide it to Compute Engine:
  1. The key is wrapped using a RSA public key certificate provided by Google.
  2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding.
Gets the RSA public key certificate provided by Google at: 
 https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
image.sourceSnapshotEncryptionKey.kmsKeyName

string

The name of the encryption key that is stored in Google Cloud KMS. For example: 

"kmsKeyName": "projects/ kms_project_id/locations/ region/keyRings/ key_region/cryptoKeys/key
The fully-qualifed key name may be returned for resource GET requests. For example: 
"kmsKeyName": "projects/ kms_project_id/locations/ region/keyRings/ key_region/cryptoKeys/key /cryptoKeyVersions/1
image.sourceSnapshotEncryptionKey.sha256

string

[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
image.sourceSnapshotEncryptionKey.kmsKeyServiceAccount

string

The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. For example: 

"kmsKeyServiceAccount": "name@ projectId.iam.gserviceaccount.com/

image.storageLocations[]

string

Cloud Storage bucket storage location of the image (regional or multi-regional).
image.shieldedInstanceInitialState

object

Set the secure boot keys of shielded instance.
image.shieldedInstanceInitialState.pk

object

The Platform Key (PK).
image.shieldedInstanceInitialState.pk.content

string (bytes format)

The raw content in the secure keys file.

A base64-encoded string.
image.shieldedInstanceInitialState.pk.fileType

enum

The file type of source file.
image.shieldedInstanceInitialState.keks[]

object

The Key Exchange Key (KEK).
image.shieldedInstanceInitialState.keks[].content

string (bytes format)

The raw content in the secure keys file.

A base64-encoded string.
image.shieldedInstanceInitialState.keks[].fileType

enum

The file type of source file.
image.shieldedInstanceInitialState.dbs[]

object

The Key Database (db).
image.shieldedInstanceInitialState.dbs[].content

string (bytes format)

The raw content in the secure keys file.

A base64-encoded string.
image.shieldedInstanceInitialState.dbs[].fileType

enum

The file type of source file.
image.shieldedInstanceInitialState.dbxs[]

object

The forbidden key database (dbx).
image.shieldedInstanceInitialState.dbxs[].content

string (bytes format)

The raw content in the secure keys file.

A base64-encoded string.
image.shieldedInstanceInitialState.dbxs[].fileType

enum

The file type of source file.
image.satisfiesPzs

boolean

[Output Only] Reserved for future use.
image.architecture

enum

The architecture of the image. Valid values are ARM64 or X86_64.
image.enableConfidentialCompute

boolean

Whether this image is created from a confidential compute mode disk. [Output Only]: This field is not set by user, but from source disk.
image.satisfiesPzi

boolean

Output only. Reserved for future use.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/compute.readonly
  • https://www.googleapis.com/auth/compute
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

In addition to any permissions specified on the fields above, authorization requires one or more of the following IAM permissions:

  • compute.imageFamilyViews.get

To find predefined roles that contain those permissions, see Compute Engine IAM Roles.