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

# List images

> List images visible to the requesting account: public platform
images plus any images the account owns. Private platform images
are staging and visible only to the platform account.

One row per tag. A build drops out of this listing once a *newer*
build holds its name — superseded history, which stays bootable by
id and by `name:version`. Anything still importing or errored stays
listed whatever its age, and so does a version staged with
`current: false` that is newer than the current one. Pass
`all_versions=true` for a tag's whole history.




## OpenAPI

````yaml /api-reference/specs/compute.yaml get /v1/images
openapi: 3.0.3
info:
  title: Basaltic Compute API
  version: 1.0.0
  description: |
    Virtual machine instances, and the images, flavors, SSH keypairs and
    instance pools they are built from. Covers the whole instance lifecycle:
    start, stop, reboot, resize and reinstall.
  contact:
    name: Basaltic Support
    email: ping@basaltic.sh
  license:
    name: Proprietary
    url: https://basaltic.sh/terms
servers:
  - url: https://compute.{region}.basaltic.sh
    description: Regional API endpoint
    variables:
      region:
        default: sa-saopaulo-1
        description: Region code
security:
  - SignatureAuth: []
paths:
  /v1/images:
    get:
      tags:
        - Images
      summary: List images
      description: |
        List images visible to the requesting account: public platform
        images plus any images the account owns. Private platform images
        are staging and visible only to the platform account.

        One row per tag. A build drops out of this listing once a *newer*
        build holds its name — superseded history, which stays bootable by
        id and by `name:version`. Anything still importing or errored stays
        listed whatever its age, and so does a version staged with
        `current: false` that is newer than the current one. Pass
        `all_versions=true` for a tag's whole history.
      operationId: listImages
      parameters:
        - $ref: '#/components/parameters/Limit'
        - $ref: '#/components/parameters/Marker'
        - name: os
          in: query
          schema:
            type: string
            example: ubuntu
        - name: architecture
          in: query
          schema:
            type: string
            example: amd64
        - name: visibility
          in: query
          schema:
            type: string
            enum:
              - public
              - private
            example: public
        - name: name
          in: query
          description: Substring match on name
          schema:
            type: string
            example: ubuntu-24.04
        - name: status
          in: query
          schema:
            type: string
            enum:
              - pending
              - importing
              - active
              - error
              - hidden
            example: active
        - name: all_versions
          in: query
          description: >-
            Include builds a newer version has superseded. Off by default, when
            each tag contributes only the build worth launching.
          schema:
            type: boolean
            default: false
            example: true
      responses:
        '200':
          description: One page of images, ordered by name
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImageListResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
      security:
        - SignatureAuth: []
components:
  parameters:
    Limit:
      name: limit
      in: query
      description: >-
        Maximum number of items to return. A value above the maximum is clamped
        to it rather than rejected, so a page shorter than the one you asked for
        is normal — page until `meta.has_more` is false, not until a page looks
        short.
      required: false
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 20
      example: 20
    Marker:
      name: marker
      in: query
      description: >-
        Opaque pagination cursor. Echo back the `meta.marker` value from the
        previous page to fetch the next one; do not construct or parse it. The
        token's internal form varies by endpoint (a resource ID, a timestamp, …)
        and is not guaranteed stable across releases.
      required: false
      schema:
        type: string
      example: 550e8400-e29b-41d4-a716-446655440000
  schemas:
    ImageListResponse:
      type: object
      properties:
        images:
          type: array
          items:
            $ref: '#/components/schemas/images_Image'
        meta:
          $ref: '#/components/schemas/PaginationMeta'
      required:
        - images
    images_Image:
      type: object
      properties:
        id:
          type: string
          format: uuid
          example: 550e8400-e29b-41d4-a716-446655440000
        crn:
          type: string
          example: >-
            crn:compute:sa-saopaulo-1:my-account:image/550e8400-e29b-41d4-a716-446655440000
        region_id:
          type: string
          description: >-
            Region the catalog row is served from. Stamped by the service; the
            row itself doesn't carry one.
          example: sa-saopaulo-1
        name:
          type: string
          example: ubuntu-24.04
        description:
          type: string
          example: Ubuntu 24.04 LTS (Noble Numbat)
        visibility:
          type: string
          enum:
            - public
            - private
          example: public
        os:
          type: string
          example: ubuntu
        os_version:
          type: string
          example: '24.04'
        architecture:
          type: string
          example: amd64
        format:
          type: string
          enum:
            - qcow2
            - raw
            - vmdk
            - vhd
            - vhdx
            - vdi
          example: qcow2
        version:
          type: string
          description: |
            The build's identity within its name. Unique there: a name is a
            movable tag, so it can't also be what tells two builds apart.
            Stamped as a UTC timestamp when the uploader didn't choose one.
          example: '20260807'
        is_current:
          type: boolean
          description: |
            Whether this is the version resolve-by-name returns for its
            (name, architecture) — i.e. the name's current tag target.
          example: true
        eol_date:
          type: string
          format: date
          description: |
            The day this image's OS release stops receiving free security
            updates for a default install. Absent when nobody has recorded
            one — which means unknown, not "supported indefinitely".

            Platform images are withdrawn from the catalog a grace period
            after this date. They stay bootable by id until then, and the
            date is published well ahead of it so you can plan the move.
          example: '2026-08-31'
        size_bytes:
          type: integer
          format: int64
          example: 2361393152
        min_disk_gb:
          type: integer
          minimum: 0
          maximum: 16384
          example: 10
        min_ram_mb:
          type: integer
          minimum: 0
          example: 1024
        status:
          type: string
          enum:
            - pending
            - importing
            - active
            - error
            - hidden
          example: active
        import_error:
          type: string
          description: >
            For a qcow2 upload that failed conversion (status=error), the
            reason. Absent otherwise.
          example: 'qemu-img: Could not open ''rbd:...'': Image not in qcow2 format'
        tags:
          $ref: '#/components/schemas/Tags'
        attributes:
          type: object
          additionalProperties:
            type: string
        created_at:
          type: string
          format: date-time
          example: '2026-01-15T09:30:00Z'
        updated_at:
          type: string
          format: date-time
          example: '2026-01-15T09:30:00Z'
      required:
        - id
        - crn
        - region_id
        - name
        - version
        - visibility
        - architecture
        - format
        - status
        - created_at
        - updated_at
    PaginationMeta:
      type: object
      properties:
        total:
          type: integer
          description: Total number of items
          example: 150
        limit:
          type: integer
          description: Number of items per page
          example: 20
        marker:
          type: string
          description: >-
            Opaque cursor for the next page. Pass it back as the `marker` query
            parameter; treat it as a token, not a value to parse.
          example: 550e8400-e29b-41d4-a716-446655440000
        has_more:
          type: boolean
          description: Whether there are more items
          example: true
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
            - request_id
          properties:
            code:
              type: string
              description: Error code identifying the type of error
              example: INVALID_INPUT
            message:
              type: string
              description: Human-readable error message
              example: Invalid request parameters
            request_id:
              type: string
              format: uuid
              description: Request ID for debugging
              example: 550e8400-e29b-41d4-a716-446655440000
    Tags:
      type: object
      additionalProperties:
        type: string
      example:
        environment: production
        team: backend
  responses:
    Unauthorized:
      description: Authentication required or token invalid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: UNAUTHORIZED
              message: Authentication required
              request_id: 550e8400-e29b-41d4-a716-446655440000
    Forbidden:
      description: Insufficient permissions
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: ACCESS_DENIED
              message: You don't have permission to perform this action
              request_id: 550e8400-e29b-41d4-a716-446655440000
    InternalServerError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: INTERNAL_ERROR
              message: An internal error occurred
              request_id: 550e8400-e29b-41d4-a716-446655440000
  securitySchemes:
    SignatureAuth:
      type: apiKey
      in: header
      name: Authorization
      description: >
        Request signing with an access key issued to a service account. An

        HMAC-SHA256 over a canonical form of the request, close to AWS SigV4.

        The `basaltic` CLI signs for you.


        Send `Authorization`, `X-Date` (UTC, `YYYYMMDDTHHMMSSZ`) and `X-Nonce`

        (random per request); add `X-Content-Sha256` to bind a body, and

        `X-Amz-Security-Token` when using temporary credentials.


        ```

        Authorization: BASALTIC-HMAC-SHA256
        Credential=<access_key_id>/<date>/<region>/basaltic/basaltic_request,
        SignedHeaders=host;x-date;x-nonce, Signature=<hex>

        ```


        `<region>` is the region code you are calling, or `global` for the
        global

        services. A signature is valid for 5 minutes from `X-Date`, and mutating

        requests are replay-guarded on the nonce.


        **Full signing procedure, including a working implementation:**

        https://docs.basaltic.sh/authentication


        ## Rate limits

        There is no global request budget. A limit applies only where an

        operation documents a `429`, and that operation says what it counts.

        Those responses carry `X-RateLimit-Limit`, `X-RateLimit-Remaining`,

        `X-RateLimit-Reset` and, on a `429`, `Retry-After` — read them rather

        than hard-coding a number. Retrying before `Retry-After` is refused and

        extends the window. Everything else is bounded by quota, not by request

        rate.

````