Search or ask Docker

Health

Health schema in Docker Engine API 1.57.

View Markdown

Schema

Type: object

Health stores information about the container's healthcheck results.
FailingStreak

Type: integer

FailingStreak is the number of consecutive failures
All schema constraints and annotations
{
  "description": "FailingStreak is the number of consecutive failures",
  "example": 0,
  "type": "integer"
}
Log

Type: array

Log contains the last few results (oldest first)
Array item

Schema: HealthcheckResult

All schema constraints and annotations
{
  "description": "Log contains the last few results (oldest first)\n",
  "items": {
    "$ref": "#/components/schemas/HealthcheckResult"
  },
  "type": "array"
}
Status

Type: string

Status is one of none, starting, healthy or unhealthy

  • "none" Indicates there is no healthcheck
  • "starting" Starting indicates that the container is not yet ready
  • "healthy" Healthy indicates that the container is running correctly
  • "unhealthy" Unhealthy indicates that the container has a problem
All schema constraints and annotations
{
  "description": "Status is one of `none`, `starting`, `healthy` or `unhealthy`\n\n- \"none\"      Indicates there is no healthcheck\n- \"starting\"  Starting indicates that the container is not yet ready\n- \"healthy\"   Healthy indicates that the container is running correctly\n- \"unhealthy\" Unhealthy indicates that the container has a problem\n",
  "enum": [
    "none",
    "starting",
    "healthy",
    "unhealthy"
  ],
  "example": "healthy",
  "type": "string"
}
All schema constraints and annotations
{
  "description": "Health stores information about the container's healthcheck results.\n",
  "properties": {
    "FailingStreak": {
      "description": "FailingStreak is the number of consecutive failures",
      "example": 0,
      "type": "integer"
    },
    "Log": {
      "description": "Log contains the last few results (oldest first)\n",
      "items": {
        "$ref": "#/components/schemas/HealthcheckResult"
      },
      "type": "array"
    },
    "Status": {
      "description": "Status is one of `none`, `starting`, `healthy` or `unhealthy`\n\n- \"none\"      Indicates there is no healthcheck\n- \"starting\"  Starting indicates that the container is not yet ready\n- \"healthy\"   Healthy indicates that the container is running correctly\n- \"unhealthy\" Unhealthy indicates that the container has a problem\n",
      "enum": [
        "none",
        "starting",
        "healthy",
        "unhealthy"
      ],
      "example": "healthy",
      "type": "string"
    }
  },
  "type": "object",
  "x-nullable": true
}