{ "opencollection": "1.0.0", "info": { "name": "Docker Engine Config Network API", "version": "1.54" }, "items": [ { "info": { "name": "Network", "type": "folder" }, "items": [ { "info": { "name": "List networks", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/networks", "params": [ { "name": "filters", "value": "", "type": "query", "description": "JSON encoded value of the filters (a `map[string][]string`) to process\non the networks list.\n\nAvailable filters:\n\n- `dangling=` When set to `true` (or `1`), returns all\n networks that are not in use by a container. When set to `false`\n (or `0`), only networks that are in use by one or more\n containers are returned.\n- `driver=` Matches a network's driver.\n- `id=` Matches all or part of a network ID.\n- `label=` or `label==` of a network label.\n- `name=` Matches all or part of a network name.\n- `scope=[\"swarm\"|\"global\"|\"local\"]` Filters networks by scope (`swarm`, `global`, or `local`).\n- `type=[\"custom\"|\"builtin\"]` Filters networks by type. The `custom` keyword returns all user-defined networks.\n" } ] }, "docs": "Returns a list of networks. For details on the format, see the\n[network inspect endpoint](#operation/NetworkInspect).\n\nNote that it uses a different, smaller representation of a network than\ninspecting a single network. For example, the list of containers attached\nto the network is not propagated in API versions 1.28 and up.\n" }, { "info": { "name": "Inspect a network", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/networks/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Network ID or name" }, { "name": "verbose", "value": "", "type": "query", "description": "Detailed inspect output for troubleshooting" }, { "name": "scope", "value": "", "type": "query", "description": "Filter the network by scope (swarm, global, or local)" } ] }, "docs": "Inspect a network" }, { "info": { "name": "Remove a network", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/networks/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Network ID or name" } ] }, "docs": "Remove a network" }, { "info": { "name": "Create a network", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/networks/create" }, "docs": "Create a network" }, { "info": { "name": "Connect a container to a network", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/networks/:id/connect", "params": [ { "name": "id", "value": "", "type": "path", "description": "Network ID or name" } ] }, "docs": "The network must be either a local-scoped network or a swarm-scoped network with the `attachable` option set. A network cannot be re-attached to a running container" }, { "info": { "name": "Disconnect a container from a network", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/networks/:id/disconnect", "params": [ { "name": "id", "value": "", "type": "path", "description": "Network ID or name" } ] }, "docs": "Disconnect a container from a network" }, { "info": { "name": "Delete unused networks", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/networks/prune", "params": [ { "name": "filters", "value": "", "type": "query", "description": "Filters to process on the prune list, encoded as JSON (a `map[string][]string`).\n\nAvailable filters:\n- `until=` Prune networks created before this timestamp. The `` can be Unix timestamps, date formatted timestamps, or Go duration strings (e.g. `10m`, `1h30m`) computed relative to the daemon machine’s time.\n- `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune networks with (or without, in case `label!=...` is used) the specified labels.\n" } ] }, "docs": "Delete unused networks" } ] } ], "bundled": true }