Apache James · JSON Structure

Webadmin Rest Api Health Check Result Structure

Health check results for all components

Type: object Properties: 2
EmailIMAPJavaJMAPMail ServerOpen SourceSMTP

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

Properties

status checks

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-health-check-result-structure.json",
  "name": "HealthCheckResult",
  "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"
      }
    }
  }
}