# HealthConfig


[API catalog](/reference/api/) · [Docker Engine overview](/reference/api/engine/version/v1.57/) · [Product manual](https://docs.docker.com/engine/) · [OpenAPI specification](/reference/api/engine/version/v1.57.yaml)

API version: 1.57





Schema constraints and annotations:

```json
{
  "description": "A test to perform to check that the container is healthy.\nHealthcheck commands should be side-effect free.\n",
  "properties": {
    "Interval": {
      "description": "The time to wait between checks in nanoseconds. It should be 0 or at\nleast 1000000 (1 ms). 0 means inherit.\n",
      "format": "int64",
      "type": "integer"
    },
    "Retries": {
      "description": "The number of consecutive failures needed to consider a container as\nunhealthy. 0 means inherit.\n",
      "type": "integer"
    },
    "StartInterval": {
      "description": "The time to wait between checks in nanoseconds during the start period.\nIt should be 0 or at least 1000000 (1 ms). 0 means inherit.\n",
      "format": "int64",
      "type": "integer"
    },
    "StartPeriod": {
      "description": "Start period for the container to initialize before starting\nhealth-retries countdown in nanoseconds. It should be 0 or at least\n1000000 (1 ms). 0 means inherit.\n",
      "format": "int64",
      "type": "integer"
    },
    "Test": {
      "description": "The test to perform. Possible values are:\n\n- `[]` inherit healthcheck from image or parent image\n- `[\"NONE\"]` disable healthcheck\n- `[\"CMD\", args...]` exec arguments directly\n- `[\"CMD-SHELL\", command]` run command with system's default shell\n\nA non-zero exit code indicates a failed healthcheck:\n- `0` healthy\n- `1` unhealthy\n- `2` reserved (treated as unhealthy)\n- other values: error running probe\n",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "Timeout": {
      "description": "The time to wait before considering the check to have hung. It should\nbe 0 or at least 1000000 (1 ms). 0 means inherit.\n\nIf the health check command does not complete within this timeout,\nthe check is considered failed and the health check process is\nforcibly terminated without a graceful shutdown.\n",
      "format": "int64",
      "type": "integer"
    }
  },
  "type": "object"
}
```



