> ## 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 objects

> List objects in the bucket. Supports prefix/delimiter for
"folder" semantics and keyset pagination via `marker`.




## OpenAPI

````yaml /api-reference/specs/storage.yaml get /v1/buckets/{bucket}/objects
openapi: 3.0.3
info:
  title: Basaltic Storage API
  version: 1.0.0
  description: |
    Block volumes with their snapshots and snapshot policies, plus bucket
    management for object storage. The S3 wire protocol itself is served
    separately at `objects.{region}.basaltic.cloud`.
  contact:
    name: Basaltic Support
    email: ping@basaltic.sh
  license:
    name: Proprietary
    url: https://basaltic.sh/terms
servers:
  - url: https://storage.{region}.basaltic.sh
    description: Regional API endpoint
    variables:
      region:
        default: sa-saopaulo-1
        description: Region code
security:
  - SignatureAuth: []
paths:
  /v1/buckets/{bucket}/objects:
    parameters:
      - name: bucket
        in: path
        required: true
        schema:
          type: string
          example: my-app-assets
    get:
      tags:
        - Buckets
      summary: List objects
      description: |
        List objects in the bucket. Supports prefix/delimiter for
        "folder" semantics and keyset pagination via `marker`.
      operationId: listObjects
      parameters:
        - name: prefix
          in: query
          schema:
            type: string
            example: images/
        - name: delimiter
          in: query
          schema:
            type: string
            example: /
        - name: marker
          in: query
          schema:
            type: string
            example: images/logo.png
        - name: max_keys
          in: query
          schema:
            type: integer
            default: 1000
            minimum: 1
            maximum: 1000
            example: 1000
      responses:
        '200':
          description: Object listing.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectListResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          description: Caller lacks the required IAM permission.
        '404':
          description: No such bucket.
      security:
        - SignatureAuth: []
components:
  schemas:
    ObjectListResponse:
      type: object
      properties:
        objects:
          type: array
          items:
            $ref: '#/components/schemas/ObjectEntry'
        common_prefixes:
          type: array
          items:
            type: string
            example: images/
        is_truncated:
          type: boolean
          example: false
        meta:
          $ref: '#/components/schemas/PaginationMeta'
    ObjectEntry:
      type: object
      required:
        - key
        - size
        - etag
        - last_modified
      properties:
        key:
          type: string
          example: images/logo.png
        size:
          type: integer
          format: int64
          example: 20480
        etag:
          type: string
          example: '"9b2cf535f27731c974343645a3985328"'
        content_type:
          type: string
          example: image/png
        last_modified:
          type: string
          format: date-time
          example: '2026-01-15T09:30:00Z'
    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
  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
  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.

````