Apache James · JSON Structure

Webadmin Rest Api Component Check Structure

Health check result for a single component

Type: object Properties: 4
EmailIMAPJavaJMAPMail ServerOpen SourceSMTP

ComponentCheck is a JSON Structure definition published by Apache James, describing 4 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

componentName escapedComponentName status cause

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "type": "object",
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/apache-james/refs/heads/main/json-structure/webadmin-rest-api-component-check-structure.json",
  "name": "ComponentCheck",
  "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"
    }
  }
}