Apache James HealthCheck API

System health monitoring

Operations 1

GET /healthcheck Apache james Apache James WebAdmin Check Health #

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-james-healthcheck-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-james-healthcheck-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Apache James WebAdmin REST Domains Health Check API
  description: REST API for managing the Apache James mail server including domains, users, mailboxes, mail queues, mail repositories, quotas, and async tasks.
  version: 3.9.0
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
  contact:
    email: server-dev@james.apache.org
servers:
- url: http://localhost:8000
  description: Apache James WebAdmin server
security:
- bearerAuth: []
tags:
- name: HealthCheck
  description: System health monitoring
paths:
  /healthcheck:
    get:
      operationId: checkHealth
      summary: Apache james Apache James WebAdmin Check Health
      description: Check the health status of all system components.
      tags:
      - HealthCheck
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      responses:
        '200':
          description: All components healthy
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthCheckResult'
              examples:
                checkHealth200Example:
                  summary: Default checkHealth 200 response
                  x-microcks-default: true
                  value:
                    status: healthy
                    checks: []
        '503':
          description: One or more components unhealthy
components:
  schemas:
    ComponentCheck:
      type: object
      description: Health check result for a single component
      properties:
        componentName:
          type: string
          description: Component name
          example: Cassandra backend
        escapedComponentName:
          type: string
          description: URL-encoded component name
          example: Cassandra%20backend
        status:
          type: string
          description: Component health status
          enum:
          - healthy
          - degraded
          - unhealthy
          example: healthy
        cause:
          type: string
          description: Reason for unhealthy status (if applicable)
          example: Connection timeout
    HealthCheckResult:
      type: object
      description: Health check results for all components
      properties:
        status:
          type: string
          description: Overall health status
          enum:
          - healthy
          - degraded
          - unhealthy
          example: healthy
        checks:
          type: array
          description: Individual component checks
          items:
            $ref: '#/components/schemas/ComponentCheck'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer