HealthStatus

B2BB2CCommerceCustomer ExperienceEcommerceOmnichannelRetail

Properties

Name	Type	Description
status	string	Overall health status
checks	array

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/HealthStatus",
  "title": "HealthStatus",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "UP",
        "DOWN",
        "DEGRADED"
      ],
      "description": "Overall health status"
    },
    "checks": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "Check name"
          },
          "status": {
            "type": "string",
            "enum": [
              "UP",
              "DOWN"
            ],
            "description": "Check status"
          },
          "details": {
            "type": "object",
            "additionalProperties": {
              "type": "string"
            },
            "description": "Additional check details"
          }
        }
      }
    }
  }
}