Apache Guacamole History API

openapi: 3.0.3
info:
  title: Apache Guacamole REST Active Connections History API
  version: 1.6.0
  description: REST API for managing Apache Guacamole remote desktop gateway including connections, users, user groups, permissions, and active sessions.
  contact:
    email: user@guacamole.apache.org
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- url: http://localhost:8080/guacamole
  description: Apache Guacamole Server
tags:
- name: History
  description: Connection history and audit logs
paths:
  /api/session/data/{dataSource}/history/connections:
    get:
      operationId: listConnectionHistory
      summary: Apache Guacamole List Connection History
      description: List connection history records for audit and reporting.
      tags:
      - History
      parameters:
      - name: dataSource
        in: path
        required: true
        description: The data source identifier
        schema:
          type: string
      - name: Guacamole-Token
        in: header
        required: true
        description: Authentication token
        schema:
          type: string
      responses:
        '200':
          description: Connection history retrieved successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ConnectionHistoryEntry'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    ConnectionHistoryEntry:
      type: object
      description: Historical record of a completed or active connection
      properties:
        identifier:
          type: string
          description: History entry identifier
          example: hist-500123
        connectionIdentifier:
          type: string
          description: Associated connection ID
          example: '1'
        connectionName:
          type: string
          description: Name of the connection
          example: My RDP Server
        username:
          type: string
          description: Username who made the connection
          example: jsmith
        startDate:
          type: integer
          format: int64
          description: Connection start time in milliseconds
          example: 1718153645993
        endDate:
          type: integer
          format: int64
          description: Connection end time in milliseconds (null if still active)
          example: 1718157245993
  securitySchemes:
    GuacamoleToken:
      type: apiKey
      in: header
      name: Guacamole-Token
      description: Authentication token obtained from POST /api/tokens