> For the complete documentation index, see [llms.txt](https://docs.vagon.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.vagon.io/teams/reference/software.md).

# Software

## List Softwares and Base Images

> 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" |\
> \| \`client\_code\` | Integer | Response code (200 for success) |\
> \| \`message\` | String | Response message |\
> \| \`timestamp\` | String | Response timestamp (ISO 8601) |\
> \
> \### \*\*Response Example\*\*\
> \
> \`\`\` json\
> {\
>   "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"\
>     }\
>   ],\
>   "client\_code": 200,\
>   "message": "OK",\
>   "timestamp": "2026-02-05T10:00:00Z"\
> }\
> \
>  \`\`\`\
> \
> \### \*\*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

````json
{"openapi":"3.0.0","info":{"title":"Vagon Computers API","version":"1.0.12"},"servers":[{"url":"https://api.vagon.io/organization-management/v1"}],"paths":{"/software":{"get":{"summary":"List Softwares and Base Images","responses":{"200":{"description":"List of software and base images","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SoftwareListResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error400Response"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error404Response"}}}},"4710":{"description":"Permission required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error4710Response"}}}}},"tags":["Software"],"description":"Lists all available softwares and base images.\n\nThis endpoint shows which softwares can be pre-installed when creating machines and which base images can be used as the operating system foundation.\n\n### Headers\n\n| Name | Type |\n| --- | --- |\n| Authorization\\* | HMAC {key}:{signature}:{nonce}:{timestamp} |\n| Content-Type | application/json |\n\n### **Response Fields**\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `software` | Array | Array of available software objects |\n| `software[].id` | Integer | Software ID (use in `software_ids` array when creating machine) |\n| `software[].name` | String | Software name |\n| `software[].size` | Integer | Software size in bytes |\n| `base_images` | Array | Array of available base image objects |\n| `base_images[].id` | Integer | Base image ID (use in `base_image_id` when creating machine) |\n| `base_images[].name` | String | Base image name (e.g., \"Windows 11 Pro - Clean\") |\n| `base_images[].size` | Integer | Base image size in bytes |\n| `base_images[].type` | String | Always \"base_image\" |\n| `client_code` | Integer | Response code (200 for success) |\n| `message` | String | Response message |\n| `timestamp` | String | Response timestamp (ISO 8601) |\n\n### **Response Example**\n\n``` json\n{\n  \"software\": [\n    {\n      \"id\": 1,\n      \"name\": \"Adobe Photoshop\",\n      \"size\": 5583457484\n    },\n    {\n      \"id\": 2,\n      \"name\": \"Blender\",\n      \"size\": 1932735283\n    }\n  ],\n  \"base_images\": [\n    {\n      \"id\": 1,\n      \"name\": \"Windows 11 Pro - Clean\",\n      \"size\": 48318382080,\n      \"type\": \"base_image\"\n    },\n    {\n      \"id\": 2,\n      \"name\": \"Windows 11 - Design Suite\",\n      \"size\": 91268055040,\n      \"type\": \"base_image\"\n    }\n  ],\n  \"client_code\": 200,\n  \"message\": \"OK\",\n  \"timestamp\": \"2026-02-05T10:00:00Z\"\n}\n\n ```\n\n### **Usage**\n\n- **Software IDs**: Use `software[].id` values in the `software_ids` array parameter when calling `POST /machines`\n    \n- **Base Image ID**: Use `base_images[].id` in the `base_image_id` parameter when calling `POST /machines`\n    \n- **Default Base Image**: If `base_image_id` is not specified (null), the latest base image is automatically used\n    \n- **Size Considerations**: When selecting software and base images, ensure the total size (with 5% buffer) fits within the plan's disk size"}}},"components":{"schemas":{"SoftwareListResponse":{"allOf":[{"$ref":"#/components/schemas/BaseResponse"},{"type":"object","properties":{"software":{"type":"array","description":"List of available software packages","items":{"$ref":"#/components/schemas/Software"}},"base_images":{"type":"array","description":"List of available base images","items":{"$ref":"#/components/schemas/BaseImage"}}}}]},"BaseResponse":{"type":"object","properties":{"client_code":{"type":"integer"},"message":{"type":"string"},"timestamp":{"type":"string","format":"date-time"}}},"Software":{"type":"object","description":"Software package that can be pre-installed on images","properties":{"id":{"type":"integer","description":"Software ID"},"name":{"type":"string","description":"Software name"},"size":{"type":"number","format":"float","description":"Software size in GB"}}},"BaseImage":{"type":"object","description":"Base image that can be used to create new images","properties":{"id":{"type":"integer","description":"Base image ID"},"name":{"type":"string","description":"Base image name"},"size":{"type":"integer","description":"Base image size in GB"},"type":{"type":"string","description":"Type identifier"}}},"Error400Response":{"allOf":[{"$ref":"#/components/schemas/ErrorResponse"}]},"ErrorResponse":{"type":"object","properties":{"client_code":{"type":"integer"},"message":{"type":"string"},"timestamp":{"type":"string","format":"date-time"}}},"Error404Response":{"allOf":[{"$ref":"#/components/schemas/ErrorResponse"}]},"Error4710Response":{"allOf":[{"$ref":"#/components/schemas/ErrorResponse"}]}}}}
````