Skip to main content

Image_Get_Response

region_namestring

Region the images are available in: CANADA-1, NORWAY-1, or US-1.

Example: US-1
typestring

Operating system type of the images.

Example: Ubuntu
logostring

URL to a logo representing the image type.

Example: https://api.nexgencloud.com:8080/hyperstack-os-logos/ubuntu.svg
images object[]

OS images available for VM deployment.

  • Array [
    • idinteger

    Unique numeric identifier for the image.

    Example: 1402
    namestring

    Name of the image.

    Example: Ubuntu Server 22.04 LTS R535 CUDA 12.2 with Docker
    region_namestring

    Region the image is available in: CANADA-1, NORWAY-1, or US-1.

    Example: US-1
    typestring

    Operating system type of the image.

    Example: Ubuntu
    versionstring

    Operating system version of the image.

    Example: Server 22.04 LTS R535 CUDA 12.2 with Docker
    sizeinteger

    Size of the image in bytes.

    Example: 107374182400
    display_sizestring

    Human-readable size of the image.

    Example: 100 GiB
    descriptionstring

    Description of the image.

    Example:
    labels object[]

    Labels applied to the image.

  • Array [
    • idinteger

    Unique numeric identifier for the label.

    labelstring

    The label name.

  • ]
    • is_publicboolean

    Whether the image is public or private.

    Example: true
    flavor_restrictions object

    Flavor compatibility restrictions for the image.

    has_flavor_restrictionsboolean

    Whether the image has any flavor restrictions.

    restriction_typestring

    Type of flavor restriction applied to the image. hard blocks deployment on incompatible flavors; soft allows deployment with a performance warning; null means no restrictions.

    compatible_flavors object[]

    Flavors compatible with the image.

  • Array [
    • flavor_idinteger

    Identifier of the compatible flavor.

    flavor_namestring

    Name of the compatible flavor.

    link_typestring

    Type of compatibility link. hard blocks deployment on this flavor; soft allows deployment with a performance warning.

    constraints object

    JSON constraints object

    object
    reasonstring

    Human-readable reason the operation was rejected.

  • ]
  • ]
    • Image_Get_Response
    {
      "region_name": "US-1",
      "type": "Ubuntu",
      "logo": "https://api.nexgencloud.com:8080/hyperstack-os-logos/ubuntu.svg",
      "images": [
        {
          "id": 1402,
          "name": "Ubuntu Server 22.04 LTS R535 CUDA 12.2 with Docker",
          "region_name": "US-1",
          "type": "Ubuntu",
          "version": "Server 22.04 LTS R535 CUDA 12.2 with Docker",
          "size": 107374182400,
          "display_size": "100 GiB",
          "description": "",
          "labels": [
            {
              "id": 0,
              "label": "string"
            }
          ],
          "is_public": true,
          "flavor_restrictions": {
            "has_flavor_restrictions": true,
            "restriction_type": "string",
            "compatible_flavors": [
              {
                "flavor_id": 0,
                "flavor_name": "string",
                "link_type": "string",
                "constraints": {},
                "reason": "string"
              }
            ]
          }
        }
      ]
    }