Skip to content

Search is only available in production builds. Try building and previewing the site to test it out locally.

ImageService

platform.v1.ImageService

ImageService manages the unified Image resource: SYSTEM (catalog/base) and MACHINE (created from an instance). Launch-from-image feeds the create flow by passing the image id as CreateInstance.image.

  • Request: CreateImageFromInstanceRequest
  • Response: Operation
  • REST mapping: POST /v1/images:from-instance
  • Request: ImagesListRequest
  • Response: ImagesListResponse
  • REST mapping: GET /v1/images
  • Request: GetImageRequest
  • Response: Image
  • REST mapping: GET /v1/images/{id}
  • Request: DeleteImageRequest
  • Response: Operation
  • REST mapping: DELETE /v1/images/{id}
  • Request: UpdateImageRequest
  • Response: Image
  • REST mapping: PATCH /v1/images/{id}

CreateImageFromInstance captures a source instance into a launchable MACHINE image (AWS “create image”; never “AMI”).

FieldType#Notes
instance_idstring1
namestring2
descriptionstring3
FieldType#Notes
idstring1
FieldType#Notes
idstring1
FieldType#Notes
idstring1ubuntu-24.04 (SYSTEM) or img_… (MACHINE)
namestring2
osstring3
versionstring4
typeImageType5Phase 2 unified-image fields (populated for MACHINE images; SYSTEM images leave provider-scoped fields empty).
descriptionstring6
appstring7
orgstring8
regionstring9
providerstring10
statusstring11pending | available | failed
visibilitystring12private | public
platformstring13linux | windows
architecturestring14x86_64 | arm64
root_device_typestring15
source_instancestring16
created_atstring18
updated_atstring19
machine_image_idstring20platform machine image this custom image was captured from

ImagesListRequest filters by type; IMAGE_TYPE_UNSPECIFIED returns all.

FieldType#Notes
typeImageType1
FieldType#Notes
imagesImage1

Operation is returned by every mutating RPC. Clients poll GetOperation or subscribe to the SSE stream to observe progress.

FieldType#Notes
idstring1opaque, type-prefixed: op_…
actionstring2permission string, e.g. compute.instance.create
resource_idstring3
resource_typestring4e.g. compute.instance
stateOperationState5
messagestring6
progressint3270..100
appstring8
FieldType#Notes
idstring1
descriptionstring2