{ "opencollection": "1.0.0", "info": { "name": "supports a RESTful API for the Libpod library artifacts networks (compat) API", "version": "5.0.0" }, "items": [ { "info": { "name": "networks (compat)", "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 on the network list. Currently available filters:\n - `name=[name]` Matches network name (accepts regex).\n - `id=[id]` Matches for full or partial ID.\n - `driver=[driver]` Only bridge is supported.\n - `label=[key]` or `label=[key=value]` Matches networks based on the presence of a label alone or a label and a value.\n" } ] }, "docs": "Display summary of network configurations" }, { "info": { "name": "Inspect a network", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/networks/:name", "params": [ { "name": "name", "value": "", "type": "path", "description": "the name of the network" }, { "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": "Display low level configuration network" }, { "info": { "name": "Remove a network", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/networks/:name", "params": [ { "name": "name", "value": "", "type": "path", "description": "the name of the network" }, { "name": "force", "value": "", "type": "query", "description": "Remove containers associated with the network." }, { "name": "timeout", "value": "", "type": "query", "description": "Seconds to wait for container removal when force is set." } ] }, "docs": "Remove a network" }, { "info": { "name": "Connect container to network", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/networks/:name/connect", "params": [ { "name": "name", "value": "", "type": "path", "description": "the name of the network" } ] }, "docs": "Connect a container to a network" }, { "info": { "name": "Disconnect container from network", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/networks/:name/disconnect", "params": [ { "name": "name", "value": "", "type": "path", "description": "the name of the network" } ] }, "docs": "Disconnect a container from a network" }, { "info": { "name": "Create network", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/networks/create" }, "docs": "Create a network configuration" }, { "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).\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": "Remove networks that do not have containers" } ] } ], "bundled": true }