Apache BookKeeper Monitoring API

Health checks and metrics endpoints.

Operations 2

GET /heartbeat Apache BookKeeper Get Heartbeat Status #
GET /metrics Apache BookKeeper Get Metrics #

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/apache-bookkeeper-monitoring-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.

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

OpenAPI Specification

apache-bookkeeper-monitoring-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Apache BookKeeper Admin Auto Recovery Monitoring API
  description: The Apache BookKeeper HTTP Admin API provides REST endpoints for managing and monitoring BookKeeper clusters, bookies, ledgers, and auto-recovery operations. It enables programmatic cluster administration, ledger inspection, bookie health monitoring, and garbage collection management.
  version: 4.16.0
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  contact:
    name: Apache BookKeeper Community
    url: https://bookkeeper.apache.org/
  x-generated-from: documentation
  x-last-validated: '2026-04-19'
servers:
- url: http://localhost:8080
  description: Default local BookKeeper bookie HTTP admin endpoint
tags:
- name: Monitoring
  description: Health checks and metrics endpoints.
paths:
  /heartbeat:
    get:
      operationId: getHeartbeat
      summary: Apache BookKeeper Get Heartbeat Status
      description: Get heartbeat status for a specific bookie to verify it is alive and responding.
      tags:
      - Monitoring
      responses:
        '200':
          description: Bookie is alive and responding.
          content:
            text/plain:
              schema:
                type: string
                example: OK
              examples:
                GetHeartbeat200Example:
                  summary: Default getHeartbeat 200 response
                  x-microcks-default: true
                  value: OK
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /metrics:
    get:
      operationId: getMetrics
      summary: Apache BookKeeper Get Metrics
      description: Retrieve all metrics from the BookKeeper stats provider in Prometheus text format.
      tags:
      - Monitoring
      responses:
        '200':
          description: Metrics in Prometheus text format.
          content:
            text/plain:
              schema:
                type: string
                example: 'bookie_WRITE_BYTES 0.0

                  bookie_READ_BYTES 0.0

                  '
              examples:
                GetMetrics200Example:
                  summary: Default getMetrics 200 response
                  x-microcks-default: true
                  value: 'bookie_WRITE_BYTES 0.0

                    bookie_READ_BYTES 0.0

                    '
        '403':
          description: Permission denied.
        '404':
          description: Not found.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK