SAP Commerce Cloud Monitoring API

openapi: 3.1.0
info:
  title: SAP Commerce Cloud Admin Addresses Monitoring API
  description: Administrative API for SAP Commerce Cloud providing system configuration, maintenance, monitoring, and health check capabilities. Enables programmatic access to system administration functions including cache management, CronJob execution, and system health monitoring.
  version: '1.0'
  contact:
    name: SAP Support
    url: https://support.sap.com/
  termsOfService: https://www.sap.com/about/legal/terms-of-use.html
servers:
- url: https://{tenant}.{region}.commercecloud.sap
  description: SAP Commerce Cloud Production
  variables:
    tenant:
      description: Tenant identifier
      default: my-tenant
    region:
      description: Deployment region
      default: us
security:
- oauth2: []
tags:
- name: Monitoring
  description: System monitoring and metrics
paths:
  /monitoring/metrics:
    get:
      operationId: getSystemMetrics
      summary: SAP Commerce Cloud Get system metrics
      description: Retrieve system performance metrics including JVM stats, database connection pool, and request statistics.
      tags:
      - Monitoring
      responses:
        '200':
          description: System metrics
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SystemMetrics'
components:
  schemas:
    SystemMetrics:
      type: object
      properties:
        jvm:
          type: object
          properties:
            heapUsed:
              type: integer
              description: Heap memory used in bytes
            heapMax:
              type: integer
              description: Maximum heap memory in bytes
            threads:
              type: integer
              description: Active thread count
            uptime:
              type: integer
              description: JVM uptime in milliseconds
        database:
          type: object
          properties:
            activeConnections:
              type: integer
              description: Active database connections
            maxConnections:
              type: integer
              description: Maximum pool connections
            idleConnections:
              type: integer
              description: Idle connections
        requests:
          type: object
          properties:
            totalCount:
              type: integer
              description: Total request count
            averageResponseTime:
              type: number
              format: double
              description: Average response time in milliseconds
            errorRate:
              type: number
              format: double
              description: Error rate percentage
  securitySchemes:
    oauth2:
      type: oauth2
      description: OAuth 2.0 authentication for SAP Commerce Cloud Admin API
      flows:
        clientCredentials:
          tokenUrl: https://{tenant}.{region}.commercecloud.sap/authorizationserver/oauth/token
          scopes:
            admin: Administrative access
externalDocs:
  description: SAP Commerce Cloud Administration Documentation
  url: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/