Software

List Softwares and Base Images

get

Lists all available softwares and base images.

This endpoint shows which softwares can be pre-installed when creating machines and which base images can be used as the operating system foundation.

Headers

Name
Type

Authorization*

HMAC {key}:{signature}:{nonce}:{timestamp}

Content-Type

application/json

Response Fields

Field
Type
Description

software

Array

Array of available software objects

software[].id

Integer

Software ID (use in software_ids array when creating machine)

software[].name

String

Software name

software[].size

Integer

Software size in bytes

base_images

Array

Array of available base image objects

base_images[].id

Integer

Base image ID (use in base_image_id when creating machine)

base_images[].name

String

Base image name (e.g., "Windows 11 Pro - Clean")

base_images[].size

Integer

Base image size in bytes

base_images[].type

String

Always "base_image"

Response Example

{
  "software": [
    {
      "id": 1,
      "name": "Adobe Photoshop",
      "size": 5583457484
    },
    {
      "id": 2,
      "name": "Blender",
      "size": 1932735283
    }
  ],
  "base_images": [
    {
      "id": 1,
      "name": "Windows 11 Pro - Clean",
      "size": 48318382080,
      "type": "base_image"
    },
    {
      "id": 2,
      "name": "Windows 11 - Design Suite",
      "size": 91268055040,
      "type": "base_image"
    }
  ]
}

Usage

  • Software IDs: Use software[].id values in the software_ids array parameter when calling POST /machines

  • Base Image ID: Use base_images[].id in the base_image_id parameter when calling POST /machines

  • Default Base Image: If base_image_id is not specified (null), the latest base image is automatically used

  • Size Considerations: When selecting software and base images, ensure the total size (with 5% buffer) fits within the plan's disk size

Responses
get
/organization-management/v1/software

Last updated