> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cloudblast.io/llms.txt
> Use this file to discover all available pages before exploring further.

# List Sandbox Images

> The images you can create a sandbox from. The image decides the OS, the size (vCPUs, memory and disk) and the location. Sizes are fixed per image.

`allowed` is false for an image that is larger than your account level allows. `in_stock` is false for an image that is out of stock right now. `limits` says how many sandboxes you have and how many you may have. `lifecycle` gives the defaults a new sandbox gets and the range you may choose from. Prices are per hour in `currency`, billed per minute.

While sandboxes are switched off on the platform, the answer is `{ "data": [], "limits": null }`.



## OpenAPI

````yaml GET /sandboxes/images
openapi: 3.0.3
info:
  title: CloudBlast API
  description: >-
    The CloudBlast V2 API provides a modern RESTful interface for managing your
    cloud infrastructure programmatically. All responses follow a consistent `{
    "data": ... }` or `{ "error": ... }` format.
  version: 2.0.0
servers:
  - url: https://console.cloudblast.io/api/v2
    description: Production
security:
  - bearerAuth: []
paths:
  /sandboxes/images:
    get:
      tags:
        - Sandboxes
      summary: List sandbox images
      description: >-
        The images you can create a sandbox from. The image decides the OS, the
        size (vCPUs, memory and disk) and the location. Sizes are fixed per
        image.


        `allowed` is false for an image that is larger than your account level
        allows. `in_stock` is false for an image that is out of stock right now.
        `limits` says how many sandboxes you have and how many you may have.
        `lifecycle` gives the defaults a new sandbox gets and the range you may
        choose from. Prices are per hour in `currency`, billed per minute.


        While sandboxes are switched off on the platform, the answer is `{
        "data": [], "limits": null }`.
      operationId: listSandboxImages
      responses:
        '200':
          description: Images, your limits and the lifecycle defaults
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/SandboxImage'
                  limits:
                    $ref: '#/components/schemas/SandboxLimits'
                  currency:
                    type: string
                    description: Currency of every price.
                    example: EUR
                  lifecycle:
                    $ref: '#/components/schemas/SandboxLifecycle'
        '401':
          $ref: '#/components/responses/Unauthenticated'
components:
  schemas:
    SandboxImage:
      type: object
      properties:
        id:
          type: integer
          description: Pass as `image_id` to create a sandbox.
          example: 3
        name:
          type: string
          example: Ubuntu 24.04 Desktop
        slug:
          type: string
          example: ubuntu-24.04-desktop
        os:
          type: string
          enum:
            - linux
            - windows
          example: linux
        desktop:
          type: boolean
          description: >-
            True for a desktop image, which you can drive with computer use.
            False for a system without a desktop.
          example: true
        vcpu:
          type: integer
          example: 2
        memory_mb:
          type: integer
          example: 4096
        disk_gb:
          type: integer
          example: 20
        location:
          $ref: '#/components/schemas/SandboxLocation'
        hourly_price:
          type: number
          description: Price per hour while it runs, in `currency`. Billed per minute.
          example: 0.03
        stopped_hourly_price:
          type: number
          description: 'Price per hour while it is stopped: its disk only.'
          example: 0.002
        allowed:
          type: boolean
          description: >-
            False when the image is larger than your account level allows
            (`limits.cpu`, `limits.memory_mb`).
          example: true
        in_stock:
          type: boolean
          description: >-
            False when the image is out of stock right now and a sandbox of it
            cannot be created. Try again later, or pick an image in another
            location.
          example: true
    SandboxLimits:
      type: object
      nullable: true
      description: What your account level allows. `null` while sandboxes are switched off.
      properties:
        used:
          type: integer
          description: >-
            Slots your sandboxes take now: every one that exists, stopped ones
            included. Failed ones take none.
          example: 1
        max:
          type: integer
          description: Sandboxes your account level allows at the same time.
          example: 2
        cpu:
          type: integer
          description: The most vCPUs a sandbox may have.
          example: 2
        memory_mb:
          type: integer
          description: The most memory a sandbox may have, in MB.
          example: 4096
    SandboxLifecycle:
      type: object
      description: >-
        What a new sandbox gets unless you choose otherwise, and what you may
        choose.
      properties:
        auto_stop_minutes:
          type: integer
          description: >-
            Default minutes without activity before a sandbox is stopped. 0
            means never.
          example: 15
        auto_destroy_minutes:
          type: integer
          description: >-
            Default minutes a stopped sandbox is kept before it is destroyed. -1
            means never.
          example: -1
        min_auto_stop_minutes:
          type: integer
          description: The smallest `auto_stop_minutes` you may choose, other than 0.
          example: 5
        max_minutes:
          type: integer
          description: 'The largest value either setting may have: 30 days.'
          example: 43200
    SandboxLocation:
      type: object
      nullable: true
      description: The region a sandbox or an image runs in. `null` when it is not known.
      properties:
        id:
          type: integer
          example: 1
        name:
          type: string
          example: Frankfurt, Germany
        short_code:
          type: string
          example: fra
        icon:
          type: string
          nullable: true
          description: URL of the location's icon.
          example: https://console.cloudblast.io/storage/locations/de.svg
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              description: Machine-readable error code
            message:
              type: string
              description: Human-readable error message
          required:
            - code
            - message
  responses:
    Unauthenticated:
      description: Authentication failed
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: UNAUTHENTICATED
              message: >-
                Missing or invalid Authorization header. Use: Authorization:
                Bearer <token>
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        API token from your CloudBlast account settings. Pass as `Authorization:
        Bearer <token>`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.