Search or ask Docker

RestartPolicy

RestartPolicy schema in Docker Engine API 1.57.

View Markdown

Schema

Type: object

The behavior to apply when the container exits. The default is not to restart.

An ever increasing delay (double the previous delay, starting at 100ms) is added before each restart to prevent flooding the server.

MaximumRetryCount

Type: integer

If on-failure is used, the number of times to retry before giving up.
All schema constraints and annotations
{
  "description": "If `on-failure` is used, the number of times to retry before giving up.\n",
  "type": "integer"
}
Name

Type: string

  • Empty string means not to restart
  • no Do not automatically restart
  • always Always restart
  • unless-stopped Restart always except when the user has manually stopped the container
  • on-failure Restart only when the container exit code is non-zero
All schema constraints and annotations
{
  "description": "- Empty string means not to restart\n- `no` Do not automatically restart\n- `always` Always restart\n- `unless-stopped` Restart always except when the user has manually stopped the container\n- `on-failure` Restart only when the container exit code is non-zero\n",
  "enum": [
    "",
    "no",
    "always",
    "unless-stopped",
    "on-failure"
  ],
  "type": "string"
}
All schema constraints and annotations
{
  "description": "The behavior to apply when the container exits. The default is not to\nrestart.\n\nAn ever increasing delay (double the previous delay, starting at 100ms) is\nadded before each restart to prevent flooding the server.\n",
  "properties": {
    "MaximumRetryCount": {
      "description": "If `on-failure` is used, the number of times to retry before giving up.\n",
      "type": "integer"
    },
    "Name": {
      "description": "- Empty string means not to restart\n- `no` Do not automatically restart\n- `always` Always restart\n- `unless-stopped` Restart always except when the user has manually stopped the container\n- `on-failure` Restart only when the container exit code is non-zero\n",
      "enum": [
        "",
        "no",
        "always",
        "unless-stopped",
        "on-failure"
      ],
      "type": "string"
    }
  },
  "type": "object"
}