> ## 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 key rotation history

> Lists on-demand and automatic attempts, newest first. Key creation is version 1 and is not a rotation. Follow meta.marker for more records.

<Info>
  Requires the IAM action **`kms:ListKeyRotations`**. See [KMS permissions](/kms/permissions) for the full list, what each one covers, and an example policy.
</Info>


## OpenAPI

````yaml /api-reference/specs/kms.yaml get /v1/keys/{key_id}/rotations
openapi: 3.0.3
info:
  title: Basaltic KMS API
  version: 1.0.0
  description: |
    Customer-managed encryption keys. Encrypt and decrypt directly, or let
    another service — secrets, storage, images — wrap its data keys with one
    of yours.
  contact:
    name: Basaltic Support
    email: ping@basaltic.sh
  license:
    name: Proprietary
    url: https://basaltic.sh/terms
servers:
  - url: https://kms.{region}.basaltic.sh
    description: Regional API endpoint
    variables:
      region:
        default: sa-saopaulo-1
        description: Region code
security:
  - BearerAuth: []
paths:
  /v1/keys/{key_id}/rotations:
    parameters:
      - name: key_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
    get:
      tags:
        - KMS
      summary: List key rotation history
      description: >-
        Lists on-demand and automatic attempts, newest first. Key creation is
        version 1 and is not a rotation. Follow meta.marker for more records.
      operationId: listKeyRotations
      parameters:
        - name: limit
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 500
            default: 50
        - name: marker
          in: query
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KeyRotationListResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: Key or rotation not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: Key state, usage, or active rotation prevents this operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          $ref: '#/components/responses/InternalServerError'
      security:
        - BearerAuth: []
components:
  schemas:
    KeyRotationListResponse:
      type: object
      required:
        - rotations
        - meta
      properties:
        rotations:
          type: array
          items:
            $ref: '#/components/schemas/KeyRotation'
        meta:
          $ref: '#/components/schemas/PaginationMeta'
    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
            params:
              type: object
              additionalProperties: true
              description: >-
                Optional non-sensitive values for interpolation of localized
                errors, keyed by error code. Never present for server errors.
              example:
                instances: 2
                pools: 0
            request_id:
              type: string
              format: uuid
              description: Request ID for debugging
              example: 550e8400-e29b-41d4-a716-446655440000
    KeyRotation:
      type: object
      required:
        - id
        - key_id
        - trigger
        - status
        - previous_version
        - key_version
        - requested_at
        - started_at
        - completed_at
        - error_code
      properties:
        id:
          type: string
          format: uuid
        key_id:
          type: string
          format: uuid
        trigger:
          type: string
          enum:
            - on_demand
            - automatic
        status:
          type: string
          enum:
            - pending
            - in_progress
            - reconciliation_required
            - succeeded
            - failed
          description: >-
            Pending work is durable. Reconciliation_required means the backend
            outcome is unknown; no second rotation is sent and further requests
            are blocked until resolved. Failed means the request was cancelled
            before dispatch.
        previous_version:
          type: integer
          minimum: 1
          nullable: true
        key_version:
          type: integer
          minimum: 2
          nullable: true
          description: New material version, populated only on success.
        requested_at:
          type: string
          format: date-time
        started_at:
          type: string
          format: date-time
          nullable: true
        completed_at:
          type: string
          format: date-time
          nullable: true
        error_code:
          type: string
          nullable: true
          description: >-
            Machine-readable cancellation or reconciliation reason. Null on
            success.
    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
  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
    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:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: |
        An OAuth 2.0 bearer token, sent as `Authorization: Bearer <token>`.
        This is the recommended way to authenticate.

        Get one by exchanging a service account's access key pair at
        `POST /v1/oauth/token` with `grant_type=client_credentials`. It is the
        standard client-credentials grant, so any OAuth-aware library will
        obtain and refresh it for you.

        ```
        curl -s -u "$KEY_ID:$SECRET" -d grant_type=client_credentials \
          https://iam.basaltic.sh/v1/oauth/token
        ```

        Tokens last an hour by default. The same access key pair is separately
        your AWS SigV4 credential for the S3-compatible object endpoint, which
        speaks nothing else.

````

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