Britive Secret Rotation API

openapi: 3.2.0
info:
  title: Secret Manager Secret Rotation API
  version: v1
  description: API documentation for Secret Manager, Policy Administration, Notifications, Approval service, etc.
servers:
- url: https://{tenantURL}
  description: The primary server
  variables:
    tenantURL:
      default: test.britive-app.com
      description: The host of the server
security:
- bearerAuth: []
tags:
- name: Secret Rotation
paths:
  /api/v1/secretmanager/vault/{vaultId}/secrets/{secretId}/rotate/history:
    get:
      tags:
      - Secret Rotation
      summary: List Secret Rotation History
      description: Lists all rotation history for a secret, ordered by date (newest first).
      operationId: listSecretRotationHistory
      parameters:
      - name: vaultId
        in: path
        description: Vault identifier
        required: true
        schema:
          type: string
        example: a6ed82f6-32b5-46d8-a3a3-c36cc574abd9
      - name: secretId
        in: path
        description: Secret identifier
        required: true
        schema:
          type: string
        example: secret-123
      - name: size
        in: query
        description: Page size for pagination
        required: false
        schema:
          type: integer
          format: int32
          default: 10
        example: '10'
      - name: lastKey
        in: query
        description: Last evaluated key for pagination
        required: false
        schema:
          type: string
      responses:
        '200':
          description: List of rotation history entries
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SecretRotationHistoryDTO'
        '404':
          description: Secret not found
  /api/v1/secretmanager/vault/{vaultId}/secrets/{secretId}/rotate/history/{timeId}:
    get:
      tags:
      - Secret Rotation
      summary: Get Secret Rotation History for Time ID
      description: Returns rotation history for a specific Time ID.
      operationId: getSecretRotationHistoryByTimeId
      parameters:
      - name: vaultId
        in: path
        description: Vault identifier
        required: true
        schema:
          type: string
        example: a6ed82f6-32b5-46d8-a3a3-c36cc574abd9
      - name: secretId
        in: path
        description: Secret identifier
        required: true
        schema:
          type: string
        example: secret-123
      - name: timeId
        in: path
        description: Time ID of the rotation history entry
        required: true
        schema:
          type: integer
          format: int64
        example: '1'
      responses:
        '200':
          description: Rotation history entry
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretRotationHistoryDTO'
        '404':
          description: Rotation history entry not found
components:
  schemas:
    SecretRotationHistoryDTO:
      type: object
      properties:
        timeId:
          type: integer
          format: int64
        rotationStartedAt:
          type: string
        vaultId:
          type: string
        secretId:
          type: string
        secretNature:
          type: string
        rotationCompletedAt:
          type: string
        rotatedBy:
          type: string
        rotationType:
          type: string
        rotationStatus:
          type: string
        summary:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
x-api-evangelist:
  assembled_from: https://docs.britive.com/apidocs/ (one OpenAPI fragment per operation page, .md variant)
  assembled_on: '2026-08-08'
  fragments: 71
  note: Britive publishes this contract only as per-operation fragments inside its Document360 API reference. This file is the faithful union of those fragments; the verbatim assembly is in openapi/_original/.