IBM WebSphere Compliance API

openapi: 3.2.0
info:
  title: WebSphere Automation REST Compliance API
  description: API for WebSphere Automation capabilities including vulnerability management, automated patching, health monitoring, and compliance tracking. Accessible through the Swagger UI on OpenShift Container Platform deployments. Provides centralized management of WebSphere Application Server and Liberty environments with automated security vulnerability remediation.
  version: 1.0.0
  license:
    name: IBM International License Agreement
    url: https://www.ibm.com/legal/terms
  contact:
    name: IBM Support
    url: https://www.ibm.com/mysupport
servers:
- url: https://automation-api.example.com/v1
  description: WebSphere Automation API Server
security:
- bearerAuth: []
tags:
- name: Compliance
  description: Compliance and configuration drift detection
paths:
  /compliance/reports:
    get:
      operationId: listComplianceReports
      summary: List Compliance Reports
      description: Returns a list of compliance reports.
      tags:
      - Compliance
      responses:
        '200':
          description: List of compliance reports
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ComplianceReport'
              examples:
                Listcompliancereports200Example:
                  summary: Default listComplianceReports 200 response
                  x-microcks-default: true
                  value:
                  - id: abc123
                    name: Example Title
                    generatedDate: '2026-01-15T10:30:00Z'
                    overallCompliance: 42.5
                    servers:
                    - serverId: '500123'
                      serverName: example_value
                      complianceScore: 42.5
                      findings: {}
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /compliance/reports/{reportId}:
    get:
      operationId: getComplianceReport
      summary: Get Compliance Report Details
      description: Returns a specific compliance report.
      tags:
      - Compliance
      parameters:
      - name: reportId
        in: path
        required: true
        schema:
          type: string
        example: '500123'
      responses:
        '200':
          description: Compliance report details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComplianceReport'
              examples:
                Getcompliancereport200Example:
                  summary: Default getComplianceReport 200 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    name: Example Title
                    generatedDate: '2026-01-15T10:30:00Z'
                    overallCompliance: 42.5
                    servers:
                    - serverId: '500123'
                      serverName: example_value
                      complianceScore: 42.5
                      findings:
                      - {}
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    Error:
      type: object
      properties:
        code:
          type: string
          example: example_value
        message:
          type: string
          example: example_value
      required:
      - code
      - message
    ComplianceReport:
      type: object
      properties:
        id:
          type: string
          example: abc123
        name:
          type: string
          example: Example Title
        generatedDate:
          type: string
          format: date-time
          example: '2026-01-15T10:30:00Z'
        overallCompliance:
          type: number
          description: Overall compliance percentage
          example: 42.5
        servers:
          type: array
          items:
            type: object
            properties:
              serverId:
                type: string
              serverName:
                type: string
              complianceScore:
                type: number
              findings:
                type: array
                items:
                  type: object
                  properties:
                    rule:
                      type: string
                    status:
                      type: string
                      enum:
                      - compliant
                      - non-compliant
                    description:
                      type: string
          example: []
  responses:
    Unauthorized:
      description: Authentication required
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT Bearer token authentication
externalDocs:
  description: WebSphere Automation Documentation
  url: https://www.ibm.com/docs/en/ws-automation