NAME
API::Docker::Type::Network - One entry of the 200 response to GET /networks
VERSION
version 0.004
DESCRIPTION
Generated from the Network definition of spec/v1.51.yaml, which the swagger leaves undescribed. paths: says what it is: one entry of the 200 response to GET /networks and the body of the 200 response to GET /networks/{id}.
name
Name of the network.
id
ID that uniquely identifies a network on a single machine.
created
Date and time at which the network was created in RFC 3339 format with nano-seconds.
scope
The level at which the network exists (e.g. swarm for cluster-wide or local for machine level).
driver
The name of the driver used to create the network (e.g. bridge, overlay).
enable_ipv4
Whether the network was created with IPv4 enabled. Serialised as EnableIPv4 -- spelled out, because deriving it from the Perl name would produce EnableIpv4.
enable_ipv6
Whether the network was created with IPv6 enabled. Serialised as EnableIPv6 -- spelled out, because deriving it from the Perl name would produce EnableIpv6.
ipam
Undocumented upstream. The network's address management -- which IPAM driver, that driver's options, and the pools it allocates from. Measured against Podman 5.8.4 (API 1.44), the default bridge answers {"Driver": "default", "Options": {"driver": "host-local"}, "Config": [{"Subnet": "10.88.0.0/16", "Gateway": "10.88.0.1"}]}. See API::Docker::Type::IPAM. Serialised as IPAM -- spelled out, because deriving it from the Perl name would produce Ipam.
internal
Whether the network is created to only allow internal networking connectivity. The daemon defaults it to false.
attachable
Whether a global / swarm scope network is manually attachable by regular containers from workers in swarm mode. The daemon defaults it to false.
ingress
Whether the network is providing the routing-mesh for the swarm cluster. The daemon defaults it to false.
config_from
The config-only network source to provide the configuration for this network. See API::Docker::Type::ConfigReference.
config_only
Whether the network is a config-only network. Config-only networks are placeholder networks for network configurations to be used by other networks. Config-only networks cannot be used directly to run containers or services. The daemon defaults it to false.
containers
Contains endpoints attached to the network. See API::Docker::Type::NetworkContainer. The keys are the caller's data and are never translated.
options
Network-specific options uses when creating the network. The keys are the caller's data and are never translated.
labels
User-defined key/value metadata. The keys are the caller's data and are never translated.
peers
List of peer nodes for an overlay network. This field is only present for overlay networks, and omitted for other network types. See API::Docker::Type::PeerInfo.
SUPPORT
Issues
Please report bugs and feature requests on GitHub at https://github.com/Getty/p5-api-docker/issues.
CONTRIBUTING
Contributions are welcome! Please fork the repository and submit a pull request.
AUTHOR
Torsten Raudssus <getty@cpan.org>
COPYRIGHT AND LICENSE
This software is copyright (c) 2026 by Torsten Raudssus <torsten@raudssus.de> https://raudssus.de/.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.