ForgeRock Health API

openapi: 3.1.0
info:
  title: ForgeRock Access Management Access Requests Health 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: Health
  description: Health and status monitoring
paths:
  /alive:
    get:
      operationId: healthCheck
      summary: Health check
      description: Returns the health status of the DS instance. Used by load balancers and monitoring systems.
      tags:
      - Health
      responses:
        '200':
          description: DS is healthy
          content:
            text/plain:
              schema:
                type: string
                examples:
                - Server is ALIVE
        '503':
          description: DS is not healthy
  /healthy:
    get:
      operationId: detailedHealthCheck
      summary: Detailed health check
      description: Returns detailed health status of the DS instance including replication state.
      tags:
      - Health
      responses:
        '200':
          description: DS is healthy and replicated
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  replicationStatus:
                    type: string
        '503':
          description: DS is unhealthy or degraded
components:
  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