ForgeRock

ForgeRock Health API

Health and status monitoring

Documentation GitHub OpenAPI

Operations 2

GET /alive Health check #

GET /healthy Detailed health check #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/forgerock-health-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: ForgeRock Directory Services Health API
  description: HTTP Directory Access Protocol (HDAP) REST API for ForgeRock Directory Services (DS). Provides JSON-based access to directory data, translating HTTP operations into LDAP operations and mapping JSON resources to LDAP entries. Supports CRUD operations, search, and password management for directory entries.
  version: 7.4.0
  contact:
    name: ForgeRock
    url: https://www.forgerock.com
  license:
    name: Proprietary
    url: https://www.forgerock.com/terms
  x-provider: forgerock
  x-api: directory-services
servers:
- url: https://{deployment}/ds
  description: ForgeRock Directory Services HDAP endpoint
  variables:
    deployment:
      default: ds.example.com
      description: The DS deployment hostname
security:
- bearerAuth: []
- basicAuth: []
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:
    bearerAuth:
      type: http
      scheme: bearer
      description: OAuth 2.0 access token
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic authentication (for directory bind)