NAME
API::Docker::Type::EndpointSettings - Configuration for a network endpoint
VERSION
version 0.004
DESCRIPTION
Generated from the EndpointSettings definition of spec/v1.51.yaml.
ipam_config
EndpointIPAMConfig represents an endpoint's IPAM configuration. See API::Docker::Type::EndpointIPAMConfig. Serialised as IPAMConfig -- spelled out, because deriving it from the Perl name would produce IpamConfig.
links
Undocumented upstream. Container links for this endpoint. The swagger describes the same field name under "links" in API::Docker::Type::HostConfig as a list of links in the form container_name:alias; the example given here is the bare ["container_1", "container_2"].
mac_address
MAC address for the endpoint on this network. The network driver might ignore this parameter.
aliases
Undocumented upstream. The network aliases of this endpoint. "dns_names" names them as one of the four things an endpoint's DNS names are built from -- the container name, its network aliases, its short ID and its hostname. The swagger's example is ["server_x", "server_y"].
driver_opts
DriverOpts is a mapping of driver options and values. These options are passed directly to the driver and are driver specific. The keys are the caller's data and are never translated.
gw_priority
This property determines which endpoint will provide the default gateway for a container. The endpoint with the highest priority will be used. If multiple endpoints have the same priority, endpoints are lexicographically sorted based on their network name, and the one that sorts first is picked.
network_id
Unique ID of the network. Serialised as NetworkID -- spelled out, because deriving it from the Perl name would produce NetworkId.
endpoint_id
Unique ID for the service endpoint in a Sandbox. Serialised as EndpointID -- spelled out, because deriving it from the Perl name would produce EndpointId.
gateway
Gateway address for this network.
ip_address
IPv4 address. Serialised as IPAddress -- spelled out, because deriving it from the Perl name would produce IpAddress.
ip_prefix_len
Mask length of the IPv4 address. Serialised as IPPrefixLen -- spelled out, because deriving it from the Perl name would produce IpPrefixLen.
ipv6_gateway
IPv6 gateway address. Serialised as IPv6Gateway -- spelled out, because deriving it from the Perl name would produce Ipv6Gateway.
global_ipv6_address
Global IPv6 address. Serialised as GlobalIPv6Address -- spelled out, because deriving it from the Perl name would produce GlobalIpv6Address.
global_ipv6_prefix_len
Mask length of the global IPv6 address. Serialised as GlobalIPv6PrefixLen -- spelled out, because deriving it from the Perl name would produce GlobalIpv6PrefixLen.
dns_names
List of all DNS names an endpoint has on a specific network. This list is based on the container name, network aliases, container short ID, and hostname.
These DNS names are non-fully qualified but can contain several dots. You can get fully qualified DNS names by appending .<network-name>. For instance, if container name is my.ctr and the network is named testnet, DNSNames will contain my.ctr and the FQDN will be my.ctr.testnet. Serialised as DNSNames -- spelled out, because deriving it from the Perl name would produce DnsNames.
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.