Search or ask Docker

NetworkDisconnectRequest

NetworkDisconnectRequest schema in Docker Engine API 1.57.

View Markdown

Schema

Type: object

NetworkDisconnectRequest represents the data to be used to disconnect a container from a network.
Container · required

Type: string

The ID or name of the container to disconnect from the network.
All schema constraints and annotations
{
  "description": "The ID or name of the container to disconnect from the network.",
  "example": "3613f73ba0e4",
  "type": "string",
  "x-nullable": false
}
Force

Type: boolean

Force the container to disconnect from the network.
All schema constraints and annotations
{
  "default": false,
  "description": "Force the container to disconnect from the network.",
  "example": false,
  "type": "boolean",
  "x-nullable": false,
  "x-omitempty": false
}
All schema constraints and annotations
{
  "description": "NetworkDisconnectRequest represents the data to be used to disconnect a container from a network.\n",
  "properties": {
    "Container": {
      "description": "The ID or name of the container to disconnect from the network.",
      "example": "3613f73ba0e4",
      "type": "string",
      "x-nullable": false
    },
    "Force": {
      "default": false,
      "description": "Force the container to disconnect from the network.",
      "example": false,
      "type": "boolean",
      "x-nullable": false,
      "x-omitempty": false
    }
  },
  "required": [
    "Container"
  ],
  "type": "object",
  "x-go-name": "DisconnectRequest"
}