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



## OpenAPI

````yaml /api-reference/specs/secrets.yaml get /v1/secrets/{secret_id}/versions
openapi: 3.0.3
info:
  title: Basaltic Secrets API
  version: 1.0.0
  description: |
    Versioned application secrets with KMS-backed envelope encryption.

    Secrets are regional. The value of every version is encrypted at
    rest under a KMS key — only opaque ciphertext is persisted. By
    default a secret uses the platform-managed key; pass kms_key_id on
    CreateSecret to bind it to one of your own KMS keys instead (the key
    is fixed for the secret's life, and every version is encrypted under
    it). Each PutSecretValue allocates a new monotonically-increasing
    version number and flips is_current on the previous row; older
    versions remain readable by explicit version query.

    Soft delete: DeleteSecret moves the secret into a recovery window
    (default 7 days, configurable 1-30). RestoreSecret exits the
    window. The hard-purge sweeper removes the row + every version
    once now() >= scheduled_purge_at.

    Values move on the wire as base64 to survive arbitrary binary
    payloads (max 64 KiB to mirror AWS Secrets Manager).
  contact:
    name: Basaltic Support
    email: ping@basaltic.sh
  license:
    name: Proprietary
    url: https://basaltic.sh/terms
servers:
  - url: https://secrets.{region}.basaltic.sh
    description: Regional API endpoint
    variables:
      region:
        default: sa-saopaulo-1
        description: Region code
security:
  - SignatureAuth: []
tags:
  - name: Secrets
    description: Secret metadata + value lifecycle
paths:
  /v1/secrets/{secret_id}/versions:
    parameters:
      - $ref: '#/components/parameters/SecretId'
    get:
      tags:
        - Secrets
      summary: List versions
      operationId: listVersions
      parameters:
        - name: marker
          in: query
          schema:
            type: string
            example: eyJ2ZXJzaW9uIjozfQ==
        - name: limit
          in: query
          description: >-
            Maximum items to return. A larger value is clamped to the maximum
            rather than rejected, so page until `meta.has_more` is false.
          schema:
            type: integer
            default: 50
            minimum: 1
            maximum: 200
            example: 50
      responses:
        '200':
          description: Paginated list of versions (highest version first).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VersionListResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  parameters:
    SecretId:
      name: secret_id
      in: path
      required: true
      schema:
        type: string
        format: uuid
        example: a1b2c3d4-5e6f-4a7b-8c9d-0e1f2a3b4c5d
  schemas:
    VersionListResponse:
      type: object
      required:
        - versions
      properties:
        versions:
          type: array
          items:
            $ref: '#/components/schemas/SecretVersion'
        meta:
          $ref: '#/components/schemas/PaginationMeta'
    SecretVersion:
      type: object
      required:
        - id
        - version
        - is_current
        - created_at
      properties:
        id:
          type: string
          format: uuid
          example: 9d8c7b6a-5e4f-4a3b-8c2d-1e0f9a8b7c6d
        version:
          type: integer
          example: 3
        is_current:
          type: boolean
          example: true
        created_by:
          type: string
          description: >-
            CRN of the principal that created this version (e.g.
            crn:iam:::user/<id>, crn:iam:::service-account/<id>).
          example: crn:iam:::user/5f3a2b1c-8d7e-4f6a-9b0c-1d2e3f4a5b6c
        created_at:
          type: string
          format: date-time
          example: '2026-01-18T11:45: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:
    BadRequest:
      description: Invalid request parameters
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: INVALID_INPUT
              message: Invalid request parameters
              request_id: 550e8400-e29b-41d4-a716-446655440000
    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
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: NOT_FOUND
              message: Resource not found
              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.

````