ForgeRock Monitoring API

openapi: 3.1.0
info:
  title: ForgeRock Access Management Access Requests Monitoring API
  description: REST API for ForgeRock Access Management (AM) providing authentication, authorization, session management, and policy evaluation. Supports OAuth 2.0 and OpenID Connect flows, authentication trees/journeys, policy-based authorization decisions, and realm management.
  version: 7.3.0
  contact:
    name: ForgeRock
    url: https://www.forgerock.com
  license:
    name: Proprietary
    url: https://www.forgerock.com/terms
  x-provider: forgerock
  x-api: access-management
servers:
- url: https://{deployment}/am
  description: ForgeRock Access Management server
  variables:
    deployment:
      default: am.example.com
      description: The AM deployment hostname
security:
- ssoToken: []
- bearerAuth: []
tags:
- name: Monitoring
  description: Health check and monitoring endpoints
paths:
  /openig/api/system/monitoring:
    get:
      operationId: getMonitoringSummary
      summary: ForgeRock Get monitoring summary
      description: Retrieve a monitoring summary of the IG instance, including request counts, response times, and status code distributions.
      tags:
      - Monitoring
      responses:
        '200':
          description: Monitoring summary
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MonitoringSummary'
  /openig/api/system/monitoring/{endpointId}:
    get:
      operationId: getEndpointMonitoring
      summary: ForgeRock Get endpoint monitoring
      description: Retrieve monitoring data for a specific endpoint or route, including request counts and response time percentiles.
      tags:
      - Monitoring
      parameters:
      - name: endpointId
        in: path
        required: true
        description: The endpoint or route identifier to monitor
        schema:
          type: string
      responses:
        '200':
          description: Endpoint monitoring data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EndpointMonitoring'
        '404':
          description: Endpoint not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /openig/api/system/health:
    get:
      operationId: getHealthStatus
      summary: ForgeRock Check IG health
      description: Returns the health status of the IG instance. Used for load balancer health checks and monitoring.
      tags:
      - Monitoring
      responses:
        '200':
          description: IG is healthy
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                    - ACTIVE
                  version:
                    type: string
                    description: IG version
        '503':
          description: IG is not healthy
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                    - MAINTENANCE
                    - FAILED
components:
  schemas:
    MonitoringSummary:
      type: object
      description: IG monitoring summary
      properties:
        totalRequestCount:
          type: integer
          description: Total number of requests processed
        totalResponseCount:
          type: integer
          description: Total number of responses sent
        averageResponseTime:
          type: number
          format: double
          description: Average response time in milliseconds
        statusCodeCounts:
          type: object
          description: Response counts by HTTP status code
          additionalProperties:
            type: integer
    EndpointMonitoring:
      type: object
      description: Monitoring data for a specific endpoint
      properties:
        requestCount:
          type: integer
        responseCount:
          type: integer
        averageResponseTime:
          type: number
          format: double
        percentiles:
          type: object
          properties:
            p50:
              type: number
              format: double
            p95:
              type: number
              format: double
            p99:
              type: number
              format: double
        statusCodeCounts:
          type: object
          additionalProperties:
            type: integer
    ErrorResponse:
      type: object
      description: Standard error response
      properties:
        code:
          type: integer
        reason:
          type: string
        message:
          type: string
  securitySchemes:
    ssoToken:
      type: apiKey
      in: header
      name: iPlanetDirectoryPro
      description: AM SSO token obtained from authentication
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: OAuth 2.0 access token