Spring Boot · Example Payload

Spring Boot Actuator Get Health Example

Get application health status

Auto ConfigurationEmbedded ServerFrameworkJavaMicroservicesREST APISpringWeb Development

Spring Boot Actuator Get Health Example is an example object payload from Spring Boot, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationmethodpathdescriptionrequestresponse

Example Payload

{
  "operation": "getHealth",
  "method": "GET",
  "path": "/actuator/health",
  "description": "Get application health status",
  "request": {
    "headers": {
      "Accept": "application/json"
    }
  },
  "response": {
    "status": 200,
    "headers": {
      "Content-Type": "application/json"
    },
    "body": {
      "status": "UP",
      "components": {
        "db": {
          "status": "UP",
          "details": {
            "database": "PostgreSQL",
            "validationQuery": "isValid()"
          }
        },
        "diskSpace": {
          "status": "UP",
          "details": {
            "total": 499963174912,
            "free": 214748364800,
            "threshold": 10485760,
            "path": ".",
            "exists": true
          }
        },
        "ping": {
          "status": "UP"
        },
        "redis": {
          "status": "UP",
          "details": {
            "version": "7.0.11"
          }
        }
      }
    }
  }
}