Lunar

Lunar Doctor API

Gateway diagnostic reporting

Documentation GitHub OpenAPI

Operations 1

GET /doctor Retrieve gateway diagnostic report #

Specifications

⚙

OpenAPI

https://raw.githubusercontent.com/api-evangelist/lunar/refs/heads/main/openapi/lunar-doctor-api-openapi.yml

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/lunar-doctor-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: Lunar API Consumption Gateway Admin Doctor API
  description: Administrative REST API for the Lunar API Consumption Gateway (lunar-engine). This API is exposed on the ENGINE_ADMIN_PORT and provides endpoints for managing flows, policies, configuration, discovery state, and gateway health. The gateway also acts as a proxy for outbound HTTP/HTTPS API traffic on port 8000, controlled via x-lunar-scheme, x-lunar-host, and x-lunar-consumer-tag headers. This spec covers the management/admin plane.
  version: 1.0.0
  contact:
    name: Lunar Support
    url: https://docs.lunar.dev/
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
servers:
- url: http://localhost:{adminPort}
  description: Lunar Engine Admin API (local)
  variables:
    adminPort:
      default: '8081'
      description: Admin port set via ENGINE_ADMIN_PORT environment variable
tags:
- name: Doctor
  description: Gateway diagnostic reporting
paths:
  /doctor:
    get:
      operationId: getDoctorReport
      summary: Retrieve gateway diagnostic report
      description: Runs the Doctor diagnostic checks and returns a JSON report covering gateway health, connected services, hub communication status, flows/policies state, and telemetry writer status.
      tags:
      - Doctor
      responses:
        '200':
          description: Doctor report returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DoctorReport'
        '422':
          description: Doctor not initialized or failed to encode report
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '405':
          description: Method not allowed
components:
  schemas:
    DoctorReport:
      type: object
      description: Diagnostic report from the Doctor service. Contains gateway health information including streams/policies status, hub connectivity, and telemetry writer health.
      additionalProperties: true
    ErrorResponse:
      type: object
      description: Error response with message and optional error detail
      properties:
        msg:
          type: string
          description: Human-readable error message
        error:
          type: string
          description: Underlying error string
      required:
      - msg
externalDocs:
  description: Lunar API Gateway Documentation
  url: https://docs.lunar.dev/api-gateway/get-started/welcome-to-lunar/