Skip to content

List the images this platform offers

  • Method: GET
  • Path: /v1/orgs/{org}/compute/images
  • Operation ID: listImages
  • Tag: Compute

Send Authorization: Bearer <credential>. The credential is either an API key (vsk_…) created for an organization, or an OIDC access token obtained by signing in to VirtScale.

Name Type Required Description
org string (uuid) Yes The organization’s id.
Name Type Required Description
region string Yes Required: the catalogue is per region.
Field Type Required Enum Description
items array of ImageOut Yes
items.id string Yes The image id. Pass this as image when creating an instance.
items.min_disk_gb integer Yes
items.min_ram_mb integer Yes
items.name string Yes
items.os_distro string, nullable Yes
items.os_version string, nullable Yes
next_cursor string, nullable No

Every error response is application/problem+json (schema Problem).

Status Meaning
400 The request is malformed or failed validation.
401 The credential is missing or invalid.
404 The resource does not exist.
default Any other status is possible; the code field identifies the error.
curl "https://api.virtscale.nl/v1/orgs/$ORG_ID/compute/images?region=$REGION" \
  -H "Authorization: Bearer $VIRTSCALE_API_KEY"