Apache James · Schema

ComponentCheck

Health check result for a single component

EmailIMAPJavaJMAPMail ServerOpen SourceSMTP

Properties

Name	Type	Description
componentName	string	Component name
escapedComponentName	string	URL-encoded component name
status	string	Component health status
cause	string	Reason for unhealthy status (if applicable)

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/apache-james/refs/heads/main/json-schema/webadmin-rest-api-component-check-schema.json",
  "title": "ComponentCheck",
  "description": "Health check result for a single component",
  "type": "object",
  "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"
    }
  }
}