v1

latestSwagger 2.02026-07-175684145.0 KB

Network

List networks

get/networks

Response

Summary networks that matches the query

Namestring

Name is the requested name of the network

Idstring

ID uniquely identifies a network on a single machine

Scopestring

Scope describes the level at which the network exists (e.g. global for cluster-wide or local for machine level)

Driverstring

Driver is the Driver name used to create the network (e.g. bridge, overlay)

EnableIPv6boolean

EnableIPv6 represents whether to enable IPv6

Internalboolean

Internal represents if the network is used internal only

Containersobject

Containers contains endpoints belonging to the network

IndexConfigsobject

Optionsobject nullable

Options holds the network specific options to use for when creating the network

Labelsobject nullable

Labels holds metadata specific to the network being created

Example response

{
  "Options": {
    "com.example.some-options": "some-option",
    "com.example.some-other-options": "some-other-option"
  },
  "Labels": {
    "com.example.some-label": "some-label",
    "com.example.some-other-label": "some-other-label"
  }
}