podman-desktop/api/interfaces/EndpointSettings.html

<!doctype html>
<html lang="en" dir="ltr" class="docs-wrapper plugin-docs plugin-id-api docs-version-current docs-doc-page docs-doc-id-interfaces/EndpointSettings" data-has-hydrated="false">
<head>
<meta charset="UTF-8">
<meta name="generator" content="Docusaurus v3.4.0">
<title data-rh="true">Interface: EndpointSettings | Podman Desktop</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://podman-desktop.io/img/banner_podman-desktop.png"><meta data-rh="true" name="twitter:image" content="https://podman-desktop.io/img/banner_podman-desktop.png"><meta data-rh="true" property="og:url" content="https://podman-desktop.io/api/interfaces/EndpointSettings"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-api-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-api-current"><meta data-rh="true" property="og:title" content="Interface: EndpointSettings | Podman Desktop"><meta data-rh="true" name="description" content="Properties"><meta data-rh="true" property="og:description" content="Properties"><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://podman-desktop.io/api/interfaces/EndpointSettings"><link data-rh="true" rel="alternate" href="https://podman-desktop.io/api/interfaces/EndpointSettings" hreflang="en"><link data-rh="true" rel="alternate" href="https://podman-desktop.io/api/interfaces/EndpointSettings" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://MR01ANKQ9S-dsn.algolia.net" crossorigin="anonymous"><link rel="alternate" type="application/rss+xml" href="/blog/rss.xml" title="Podman Desktop RSS Feed">
<link rel="alternate" type="application/atom+xml" href="/blog/atom.xml" title="Podman Desktop Atom Feed">
<link rel="alternate" type="application/json" href="/blog/feed.json" title="Podman Desktop JSON Feed">


<link rel="search" type="application/opensearchdescription+xml" title="Podman Desktop" href="/opensearch.xml">

<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<script async src="//gc.zgo.at/count.js" data-goatcounter="https://podman-desktop-website.goatcounter.com/count"></script><link rel="stylesheet" href="/assets/css/styles.4fbe8cda.css">
<script src="/assets/js/runtime~main.2a8f596f.js" defer="defer"></script>
<script src="/assets/js/main.77f5bda2.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();null!==e?t(e):window.matchMedia("(prefers-color-scheme: dark)").matches?t("dark"):window.matchMedia("(prefers-color-scheme: light)").matches?t("light"):t("dark")}(),function(){try{const c=new URLSearchParams(window.location.search).entries();for(var[t,e]of c)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><div role="region" aria-label="Skip to main content"><a class="skipToContent_oPtH" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/"><div class="navbar__logo"><img src="/img/logo.svg" alt="Podman Desktop Logo" class="themedComponent_siVc themedComponent--light_hHel" height="56"><img src="/img/logo.svg" alt="Podman Desktop Logo" class="themedComponent_siVc themedComponent--dark_yETr" height="56"></div><b class="navbar__title text--truncate">podman desktop</b></a><a class="navbar__item navbar__link" href="/docs/intro">Documentation</a><a class="navbar__item navbar__link" href="/core-values">Core Values</a><a class="navbar__item navbar__link" href="/features">Features</a><a class="navbar__item navbar__link" href="/downloads">Downloads</a><a class="navbar__item navbar__link" href="/extend">Extend</a><a class="navbar__item navbar__link" href="/blog">Blog</a></div><div class="navbar__items navbar__items--right"><a href="https://github.com/containers/podman-desktop" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link header-github-link"></a><div class="toggle_ki11 colorModeToggle_Hewu"><button class="clean-btn toggleButton_MMFG toggleButtonDisabled_Uw7m" type="button" disabled="" title="Switch between dark and light mode (currently dark mode)" aria-label="Switch between dark and light mode (currently dark mode)" aria-live="polite"><svg viewBox="0 0 24 24" width="24" height="24" class="lightToggleIcon_lgto"><path fill="currentColor" d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" class="darkToggleIcon_U96C"><path fill="currentColor" d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4
<h2 class="anchor anchorWithStickyNavbar_JmGV" id="properties">Properties<a class="hash-link" aria-label="Direct link to Properties" title="Direct link to Properties" href="/api/interfaces/EndpointSettings#properties"></a></h2>
<h3 class="anchor anchorWithStickyNavbar_JmGV" id="aliases">Aliases?<a class="hash-link" aria-label="Direct link to Aliases?" title="Direct link to Aliases?" href="/api/interfaces/EndpointSettings#aliases"></a></h3>
<blockquote>
<p><code>optional</code> <strong>Aliases</strong>: <code>string</code>[]</p>
</blockquote>
<h4 class="anchor anchorWithStickyNavbar_JmGV" id="defined-in">Defined in<a class="hash-link" aria-label="Direct link to Defined in" title="Direct link to Defined in" href="/api/interfaces/EndpointSettings#defined-in"></a></h4>
<p><a href="https://github.com/containers/podman-desktop/blob/d4209c24d1ba77e42019cba4835fc357c2c1a1e6/packages/extension-api/src/extension-api.d.ts#L2777" target="_blank" rel="noopener noreferrer">packages/extension-api/src/extension-api.d.ts:2777</a></p>
<hr>
<h3 class="anchor anchorWithStickyNavbar_JmGV" id="dnsnames">DNSNames?<a class="hash-link" aria-label="Direct link to DNSNames?" title="Direct link to DNSNames?" href="/api/interfaces/EndpointSettings#dnsnames"></a></h3>
<blockquote>
<p><code>optional</code> <strong>DNSNames</strong>: <code>string</code>[]</p>
</blockquote>
<p>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.</p>
<p>These DNS names are non-fully qualified but can contain several dots. You can get fully qualified DNS names by
appending <code>.&lt;network-name&gt;</code>. For instance, if container name is <code>my.ctr</code> and the network is named
<code>testnet</code>, <code>DNSNames</code> will contain <code>my.ctr</code> and the FQDN will be <code>my.ctr.testnet</code>.</p>
<h4 class="anchor anchorWithStickyNavbar_JmGV" id="defined-in-1">Defined in<a class="hash-link" aria-label="Direct link to Defined in" title="Direct link to Defined in" href="/api/interfaces/EndpointSettings#defined-in-1"></a></h4>
<p><a href="https://github.com/containers/podman-desktop/blob/d4209c24d1ba77e42019cba4835fc357c2c1a1e6/packages/extension-api/src/extension-api.d.ts#L2832" target="_blank" rel="noopener noreferrer">packages/extension-api/src/extension-api.d.ts:2832</a></p>
<hr>
<h3 class="anchor anchorWithStickyNavbar_JmGV" id="driveropts">DriverOpts?<a class="hash-link" aria-label="Direct link to DriverOpts?" title="Direct link to DriverOpts?" href="/api/interfaces/EndpointSettings#driveropts"></a></h3>
<blockquote>
<p><code>optional</code> <strong>DriverOpts</strong>: <code>object</code></p>
</blockquote>
<p>DriverOpts is a mapping of driver options and values. These options are passed directly to the driver and are driver specific.</p>
<h4 class="anchor anchorWithStickyNavbar_JmGV" id="index-signature">Index Signature<a class="hash-link" aria-label="Direct link to Index Signature" title="Direct link to Index Signature" href="/api/interfaces/EndpointSettings#index-signature"></a></h4>
<p>[<code>key</code>: <code>string</code>]: <code>string</code></p>
<h4 class="anchor anchorWithStickyNavbar_JmGV" id="defined-in-2">Defined in<a class="hash-link" aria-label="Direct link to Defined in" title="Direct link to Defined in" href="/api/interfaces/EndpointSettings#defined-in-2"></a></h4>
<p><a href="https://github.com/containers/podman-desktop/blob/d4209c24d1ba77e42019cba4835fc357c2c1a1e6/packages/extension-api/src/extension-api.d.ts#L2822" target="_blank" rel="noopener noreferrer">packages/extension-api/src/extension-api.d.ts:2822</a></p>
<hr>
<h3 class="anchor anchorWithStickyNavbar_JmGV" id="endpointid">EndpointID?<a class="hash-link" aria-label="Direct link to EndpointID?" title="Direct link to EndpointID?" href="/api/interfaces/EndpointSettings#endpointid"></a></h3>
<blockquote>
<p><code>optional</code> <strong>EndpointID</strong>: <code>string</code></p>
</blockquote>
<p>Unique ID for the service endpoint in a Sandbox.</p>
<h4 class="anchor anchorWithStickyNavbar_JmGV" id="defined-in-3">Defined in<a class="hash-link" aria-label="Direct link to Defined in" title="Direct link to Defined in" href="/api/interfaces/EndpointSettings#defined-in-3"></a></h4>
<p><a href="https://github.com/containers/podman-desktop/blob/d4209c24d1ba77e42019cba4835fc357c2c1a1e6/packages/extension-api/src/extension-api.d.ts#L2787" target="_blank" rel="noopener noreferrer">packages/extension-api/src/extension-api.d.ts:2787</a></p>
<hr>
<h3 class="anchor anchorWithStickyNavbar_JmGV" id="gateway">Gateway?<a class="hash-link" aria-label="Direct link to Gateway?" title="Direct link to Gateway?" href="/api/interfaces/EndpointSettings#gateway"></a></h3>
<blockquote>
<p><code>optional</code> <strong>Gateway</strong>: <code>string</code></p>
</blockquote>
<p>Gateway address for this network.</p>
<h4 class="anchor anchorWithStickyNavbar_JmGV" id="defined-in-4">Defined in<a class="hash-link" aria-label="Direct link to Defined in" title="Direct link to Defined in" href="/api/interfaces/EndpointSettings#defined-in-4"></a></h4>
<p><a href="https://github.com/containers/podman-desktop/blob/d4209c24d1ba77e42019cba4835fc357c2c1a1e6/packages/extension-api/src/extension-api.d.ts#L2792" target="_blank" rel="noopener noreferrer">packages/extension-api/src/extension-api.d.ts:2792</a></p>
<hr>
<h3 class="anchor anchorWithStickyNavbar_JmGV" id="globalipv6address">GlobalIPv6Address?<a class="hash-link" aria-label="Direct link to GlobalIPv6Address?" title="Direct link to GlobalIPv6Address?" href="/api/interfaces/EndpointSettings#globalipv6address"></a></h3>
<blockquote>
<p><code>optional</code> <strong>GlobalIPv6Address</strong>: <code>string</code></p>
</blockquote>
<p>Global IPv6 address.</p>
<h4 class="anchor anchorWithStickyNavbar_JmGV" id="defined-in-5">Defined in<a class="hash-link" aria-label="Direct link to Defined in" title="Direct link to Defined in" href="/api/interfaces/EndpointSettings#defined-in-5"></a></h4>
<p><a href="https://github.com/containers/podman-desktop/blob/d4209c24d1ba77e42019cba4835fc357c2c1a1e6/packages/extension-api/src/extension-api.d.ts#L2812" target="_blank" rel="noopener noreferrer">packages/extension-api/src/extension-api.d.ts:2812</a></p>
<hr>
<h3 class="anchor anchorWithStickyNavbar_JmGV" id="globalipv6prefixlen">GlobalIPv6PrefixLen?<a class="hash-link" aria-label="Direct link to GlobalIPv6PrefixLen?" title="Direct link to GlobalIPv6PrefixLen?" href="/api/interfaces/EndpointSettings#globalipv6prefixlen"></a></h3>
<blockquote>
<p><code>optional</code> <strong>GlobalIPv6PrefixLen</strong>: <code>number</code></p>
</blockquote>
<p>Mask length of the global IPv6 address.</p>
<h4 class="anchor anchorWithStickyNavbar_JmGV" id="defined-in-6">Defined in<a class="hash-link" aria-label="Direct link to Defined in" title="Direct link to Defined in" href="/api/interfaces/EndpointSettings#defined-in-6"></a></h4>
<p><a href="https://github.com/containers/podman-desktop/blob/d4209c24d1ba77e42019cba4835fc357c2c1a1e6/packages/extension-api/src/extension-api.d.ts#L2817" target="_blank" rel="noopener noreferrer">packages/extension-api/src/extension-api.d.ts:2817</a></p>
<hr>
<h3 class="anchor anchorWithStickyNavbar_JmGV" id="ipamconfig">IPAMConfig?<a class="hash-link" aria-label="Direct link to IPAMConfig?" title="Direct link to IPAMConfig?" href="/api/interfaces/EndpointSettings#ipamconfig"></a></h3>
<blockquote>
<p><code>optional</code> <strong>IPAMConfig</strong>: <a href="/api/interfaces/EndpointIPAMConfig"><code>EndpointIPAMConfig</code></a></p>
</blockquote>
<p>EndpointIPAMConfig represents an endpoint&#x27;s IPAM configuration.</p>
<h4 class="anchor anchorWithStickyNavbar_JmGV" id="defined-in-7">Defined in<a class="hash-link" aria-label="Direct link to Defined in" title="Direct link to Defined in" href="/api/interfaces/EndpointSettings#defined-in-7"></a></h4>
<p><a href="https://github.com/containers/podman-desktop/blob/d4209c24d1ba77e42019cba4835fc357c2c1a1e6/packages/extension-api/src/extension-api.d.ts#L2768" target="_blank" rel="noopener noreferrer">packages/extension-api/src/extension-api.d.ts:2768</a></p>
<hr>
<h3 class="anchor anchorWithStickyNavbar_JmGV" id="ipaddress">IPAddress?<a class="hash-link" aria-label="Direct link to IPAddress?" title="Direct link to IPAddress?" href="/api/interfaces/EndpointSettings#ipaddress"></a></h3>
<blockquote>
<p><code>optional</code> <strong>IPAddress</strong>: <code>string</code></p>
</blockquote>
<p>IPv4 address.</p>
<h4 class="anchor anchorWithStickyNavbar_JmGV" id="defined-in-8">Defined in<a class="hash-link" aria-label="Direct link to Defined in" title="Direct link to Defined in" href="/api/interfaces/EndpointSettings#defined-in-8"></a></h4>
<p><a href="https://github.com/containers/podman-desktop/blob/d4209c24d1ba77e42019cba4835fc357c2c1a1e6/packages/extension-api/src/extension-api.d.ts#L2797" target="_blank" rel="noopener noreferrer">packages/extension-api/src/extension-api.d.ts:2797</a></p>
<hr>
<h3 class="anchor anchorWithStickyNavbar_JmGV" id="ipprefixlen">IPPrefixLen?<a class="hash-link" aria-label="Direct link to IPPrefixLen?" title="Direct link to IPPrefixLen?" href="/api/interfaces/EndpointSettings#ipprefixlen"></a></h3>
<blockquote>
<p><code>optional</code> <strong>IPPrefixLen</strong>: <code>number</code></p>
</blockquote>
<p>Mask length of the IPv4 address.</p>
<h4 class="anchor anchorWithStickyNavbar_JmGV" id="defined-in-9">Defined in<a class="hash-link" aria-label="Direct link to Defined in" title="Direct link to Defined in" href="/api/interfaces/EndpointSettings#defined-in-9"></a></h4>
<p><a href="https://github.com/containers/podman-desktop/blob/d4209c24d1ba77e42019cba4835fc357c2c1a1e6/packages/extension-api/src/extension-api.d.ts#L2802" target="_blank" rel="noopener noreferrer">packages/extension-api/src/extension-api.d.ts:2802</a></p>
<hr>
<h3 class="anchor anchorWithStickyNavbar_JmGV" id="ipv6gateway">IPv6Gateway?<a class="hash-link" aria-label="Direct link to IPv6Gateway?" title="Direct link to IPv6Gateway?" href="/api/interfaces/EndpointSettings#ipv6gateway"></a></h3>
<blockquote>
<p><code>optional</code> <strong>IPv6Gateway</strong>: <code>string</code></p>
</blockquote>
<p>IPv6 gateway address.</p>
<h4 class="anchor anchorWithStickyNavbar_JmGV" id="defined-in-10">Defined in<a class="hash-link" aria-label="Direct link to Defined in" title="Direct link to Defined in" href="/api/interfaces/EndpointSettings#defined-in-10"></a></h4>
<p><a href="https://github.com/containers/podman-desktop/blob/d4209c24d1ba77e42019cba4835fc357c2c1a1e6/packages/extension-api/src/extension-api.d.ts#L2807" target="_blank" rel="noopener noreferrer">packages/extension-api/src/extension-api.d.ts:2807</a></p>
<hr>
<h3 class="anchor anchorWithStickyNavbar_JmGV" id="links">Links?<a class="hash-link" aria-label="Direct link to Links?" title="Direct link to Links?" href="/api/interfaces/EndpointSettings#links"></a></h3>
<blockquote>
<p><code>optional</code> <strong>Links</strong>: <code>string</code>[]</p>
</blockquote>
<h4 class="anchor anchorWithStickyNavbar_JmGV" id="defined-in-11">Defined in<a class="hash-link" aria-label="Direct link to Defined in" title="Direct link to Defined in" href="/api/interfaces/EndpointSettings#defined-in-11"></a></h4>
<p><a href="https://github.com/containers/podman-desktop/blob/d4209c24d1ba77e42019cba4835fc357c2c1a1e6/packages/extension-api/src/extension-api.d.ts#L2770" target="_blank" rel="noopener noreferrer">packages/extension-api/src/extension-api.d.ts:2770</a></p>
<hr>
<h3 class="anchor anchorWithStickyNavbar_JmGV" id="macaddress">MacAddress?<a class="hash-link" aria-label="Direct link to MacAddress?" title="Direct link to MacAddress?" href="/api/interfaces/EndpointSettings#macaddress"></a></h3>
<blockquote>
<p><code>optional</code> <strong>MacAddress</strong>: <code>string</code></p>
</blockquote>
<p>MAC address for the endpoint on this network. The network driver might ignore this parameter.</p>
<h4 class="anchor anchorWithStickyNavbar_JmGV" id="defined-in-12">Defined in<a class="hash-link" aria-label="Direct link to Defined in" title="Direct link to Defined in" href="/api/interfaces/EndpointSettings#defined-in-12"></a></h4>
<p><a href="https://github.com/containers/podman-desktop/blob/d4209c24d1ba77e42019cba4835fc357c2c1a1e6/packages/extension-api/src/extension-api.d.ts#L2775" target="_blank" rel="noopener noreferrer">packages/extension-api/src/extension-api.d.ts:2775</a></p>
<hr>
<h3 class="anchor anchorWithStickyNavbar_JmGV" id="networkid">NetworkID?<a class="hash-link" aria-label="Direct link to NetworkID?" title="Direct link to NetworkID?" href="/api/interfaces/EndpointSettings#networkid"></a></h3>
<blockquote>
<p><code>optional</code> <strong>NetworkID</strong>: <code>string</code></p>
</blockquote>
<p>Unique ID of the network.</p>
<h4 class="anchor anchorWithStickyNavbar_JmGV" id="defined-in-13">Defined in<a class="hash-link" aria-label="Direct link to Defined in" title="Direct link to Defined in" href="/api/interfaces/EndpointSettings#defined-in-13"></a></h4>
<p><a href="https://github.com/containers/podman-desktop/blob/d4209c24d1ba77e42019cba4835fc357c2c1a1e6/packages/extension-api/src/extension-api.d.ts#L2782" target="_blank" rel="noopener noreferrer">packages/extension-api/src/extension-api.d.ts:2782</a></p></div></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/api/interfaces/EndpointIPAMConfig"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">EndpointIPAMConfig</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/api/interfaces/Event"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Event</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_XG6w thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a class="table-of-contents__link toc-highlight" href="/api/interfaces/EndpointSettings#properties">Properties</a><ul><li><a class="table-of-contents__link toc-highlight" href="/api/interfaces/EndpointSettings#aliases">Aliases?</a></li><li><a class="table-of-contents__link toc-highlight" href="/api/interfaces/EndpointSettings#dnsnames">DNSNames?</a></li><li><a class="table-of-contents__link toc-highlight" href="/api/interfaces/EndpointSettings#driveropts">DriverOpts?</a></li><li><a class="table-of-contents__link toc-highlight" href="/api/interfaces/EndpointSettings#endpointid">EndpointID?</a></li><li><a class="table-of-contents__link toc-highlight" href="/api/interfaces/EndpointSettings#gateway">Gateway?</a></li><li><a class="table-of-contents__link toc-highlight" href="/api/interfaces/EndpointSettings#globalipv6address">GlobalIPv6Address?</a></li><li><a class="table-of-contents__link toc-highlight" href="/api/interfaces/EndpointSettings#globalipv6prefixlen">GlobalIPv6PrefixLen?</a></li><li><a class="table-of-contents__link toc-highlight" href="/api/interfaces/EndpointSettings#ipamconfig">IPAMConfig?</a></li><li><a class="table-of-contents__link toc-highlight" href="/api/interfaces/EndpointSettings#ipaddress">IPAddress?</a></li><li><a class="table-of-contents__link toc-highlight" href="/api/interfaces/EndpointSettings#ipprefixlen">IPPrefixLen?</a></li><li><a class="table-of-contents__link toc-highlight" href="/api/interfaces/EndpointSettings#ipv6gateway">IPv6Gateway?</a></li><li><a class="table-of-contents__link toc-highlight" href="/api/interfaces/EndpointSettings#links">Links?</a></li><li><a class="table-of-contents__link toc-highlight" href="/api/interfaces/EndpointSettings#macaddress">MacAddress?</a></li><li><a class="table-of-contents__link toc-highlight" href="/api/interfaces/EndpointSettings#networkid">NetworkID?</a></li></ul></li></ul></div></div></div></div></main></div></div></div><footer class="footer"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Documentation</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/docs/installation">Installing Podman Desktop</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/migrating-from-docker">Migrating from Docker</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/kubernetes">Working with Kubernetes</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/troubleshooting">Troubleshooting</a></li></ul></div><div class="col footer__col"><div class="footer__title">Links</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://github.com/containers/podman-desktop" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPrP"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://discord.com/invite/x
</body>
</html>
-												deploy: f8a3f5c04def1fceac66c2663588b7c37522934f

											
										
										
											2024-03-04 10:44:38 +00:00
+								<!doctype html>
 								<html lang="en" dir="ltr" class="docs-wrapper plugin-docs plugin-id-api docs-version-current docs-doc-page docs-doc-id-interfaces/EndpointSettings" data-has-hydrated="false">
 								<head>
 								<meta charset="UTF-8">
-												deploy: 6b93dc5d129d3e3fd8c5f303d5f460805c4b6b65

											
										
										
											2024-06-05 08:03:38 +00:00
+								<meta name="generator" content="Docusaurus v3.4.0">
-												deploy: f8a3f5c04def1fceac66c2663588b7c37522934f

											
										
										
											2024-03-04 10:44:38 +00:00
+								<title data-rh="true">Interface: EndpointSettings | Podman Desktop</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://podman-desktop.io/img/banner_podman-desktop.png"><meta data-rh="true" name="twitter:image" content="https://podman-desktop.io/img/banner_podman-desktop.png"><meta data-rh="true" property="og:url" content="https://podman-desktop.io/api/interfaces/EndpointSettings"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-api-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-api-current"><meta data-rh="true" property="og:title" content="Interface: EndpointSettings | Podman Desktop"><meta data-rh="true" name="description" content="Properties"><meta data-rh="true" property="og:description" content="Properties"><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://podman-desktop.io/api/interfaces/EndpointSettings"><link data-rh="true" rel="alternate" href="https://podman-desktop.io/api/interfaces/EndpointSettings" hreflang="en"><link data-rh="true" rel="alternate" href="https://podman-desktop.io/api/interfaces/EndpointSettings" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://MR01ANKQ9S-dsn.algolia.net" crossorigin="anonymous"><link rel="alternate" type="application/rss+xml" href="/blog/rss.xml" title="Podman Desktop RSS Feed">
 								<link rel="alternate" type="application/atom+xml" href="/blog/atom.xml" title="Podman Desktop Atom Feed">
 								<link rel="alternate" type="application/json" href="/blog/feed.json" title="Podman Desktop JSON Feed">
 								<link rel="search" type="application/opensearchdescription+xml" title="Podman Desktop" href="/opensearch.xml">
 								<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
-												deploy: 13dbfc54adfe62b26d050909ac74925c5f477805

											
										
										
											2024-06-24 09:24:14 +00:00
+								<script async src="//gc.zgo.at/count.js" data-goatcounter="https://podman-desktop-website.goatcounter.com/count"></script><link rel="stylesheet" href="/assets/css/styles.4fbe8cda.css">
-												deploy: d4209c24d1ba77e42019cba4835fc357c2c1a1e6

											
										
										
											2024-07-25 10:27:17 +00:00
+								<script src="/assets/js/runtime~main.2a8f596f.js" defer="defer"></script>
-												deploy: a009e69f8b7447d4336476c694b41bc61cc67fcc

											
										
										
											2024-07-23 16:04:55 +00:00
+								<script src="/assets/js/main.77f5bda2.js" defer="defer"></script>
-												deploy: f8a3f5c04def1fceac66c2663588b7c37522934f

											
										
										
											2024-03-04 10:44:38 +00:00
+								</head>
 								<body class="navigation-with-keyboard">
-												deploy: a009e69f8b7447d4336476c694b41bc61cc67fcc

											
										
										
											2024-07-23 16:04:55 +00:00
+								<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();null!==e?t(e):window.matchMedia("(prefers-color-scheme: dark)").matches?t("dark"):window.matchMedia("(prefers-color-scheme: light)").matches?t("light"):t("dark")}(),function(){try{const c=new URLSearchParams(window.location.search).entries();for(var[t,e]of c)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><div role="region" aria-label="Skip to main content"><a class="skipToContent_oPtH" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/"><div class="navbar__logo"><img src="/img/logo.svg" alt="Podman Desktop Logo" class="themedComponent_siVc themedComponent--light_hHel" height="56"><img src="/img/logo.svg" alt="Podman Desktop Logo" class="themedComponent_siVc themedComponent--dark_yETr" height="56"></div><b class="navbar__title text--truncate">podman desktop</b></a><a class="navbar__item navbar__link" href="/docs/intro">Documentation</a><a class="navbar__item navbar__link" href="/core-values">Core Values</a><a class="navbar__item navbar__link" href="/features">Features</a><a class="navbar__item navbar__link" href="/downloads">Downloads</a><a class="navbar__item navbar__link" href="/extend">Extend</a><a class="navbar__item navbar__link" href="/blog">Blog</a></div><div class="navbar__items navbar__items--right"><a href="https://github.com/containers/podman-desktop" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link header-github-link"></a><div class="toggle_ki11 colorModeToggle_Hewu"><button class="clean-btn toggleButton_MMFG toggleButtonDisabled_Uw7m" type="button" disabled="" title="Switch between dark and light mode (currently dark mode)" aria-label="Switch between dark and light mode (currently dark mode)" aria-live="polite"><svg viewBox="0 0 24 24" width="24" height="24" class="lightToggleIcon_lgto"><path fill="currentColor" d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" class="darkToggleIcon_U96C"><path fill="currentColor" d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4
-												deploy: 6b93dc5d129d3e3fd8c5f303d5f460805c4b6b65

											
										
										
											2024-06-05 08:03:38 +00:00
+								<h2 class="anchor anchorWithStickyNavbar_JmGV" id="properties">Properties<a class="hash-link" aria-label="Direct link to Properties" title="Direct link to Properties" href="/api/interfaces/EndpointSettings#properties"></a></h2>
 								<h3 class="anchor anchorWithStickyNavbar_JmGV" id="aliases">Aliases?<a class="hash-link" aria-label="Direct link to Aliases?" title="Direct link to Aliases?" href="/api/interfaces/EndpointSettings#aliases"></a></h3>
-												deploy: f8a3f5c04def1fceac66c2663588b7c37522934f

											
										
										
											2024-03-04 10:44:38 +00:00
+								<blockquote>
-												deploy: 913e923c9731ff8cb55c8e36ffdd866e25b6442a

											
										
										
											2024-04-23 13:30:46 +00:00
+								<p><code>optional</code> <strong>Aliases</strong>: <code>string</code>[]</p>
-												deploy: f8a3f5c04def1fceac66c2663588b7c37522934f

											
										
										
											2024-03-04 10:44:38 +00:00
+								</blockquote>
-												deploy: da2b9538f419bf51f749f5a8f8a7138eb9aa59b4

											
										
										
											2024-07-02 14:16:28 +00:00
+								<h4 class="anchor anchorWithStickyNavbar_JmGV" id="defined-in">Defined in<a class="hash-link" aria-label="Direct link to Defined in" title="Direct link to Defined in" href="/api/interfaces/EndpointSettings#defined-in"></a></h4>
-												deploy: d4209c24d1ba77e42019cba4835fc357c2c1a1e6

											
										
										
											2024-07-25 10:27:17 +00:00
+								<p><a href="https://github.com/containers/podman-desktop/blob/d4209c24d1ba77e42019cba4835fc357c2c1a1e6/packages/extension-api/src/extension-api.d.ts#L2777" target="_blank" rel="noopener noreferrer">packages/extension-api/src/extension-api.d.ts:2777</a></p>
-												deploy: f8a3f5c04def1fceac66c2663588b7c37522934f

											
										
										
											2024-03-04 10:44:38 +00:00
+								<hr>
-												deploy: 6b93dc5d129d3e3fd8c5f303d5f460805c4b6b65

											
										
										
											2024-06-05 08:03:38 +00:00
+								<h3 class="anchor anchorWithStickyNavbar_JmGV" id="dnsnames">DNSNames?<a class="hash-link" aria-label="Direct link to DNSNames?" title="Direct link to DNSNames?" href="/api/interfaces/EndpointSettings#dnsnames"></a></h3>
-												deploy: f8a3f5c04def1fceac66c2663588b7c37522934f

											
										
										
											2024-03-04 10:44:38 +00:00
+								<blockquote>
-												deploy: 913e923c9731ff8cb55c8e36ffdd866e25b6442a

											
										
										
											2024-04-23 13:30:46 +00:00
+								<p><code>optional</code> <strong>DNSNames</strong>: <code>string</code>[]</p>
-												deploy: f8a3f5c04def1fceac66c2663588b7c37522934f

											
										
										
											2024-03-04 10:44:38 +00:00
+								</blockquote>
 								<p>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.</p>
 								<p>These DNS names are non-fully qualified but can contain several dots. You can get fully qualified DNS names by
 								appending <code>.&lt;network-name&gt;</code>. For instance, if container name is <code>my.ctr</code> and the network is named
 								<code>testnet</code>, <code>DNSNames</code> will contain <code>my.ctr</code> and the FQDN will be <code>my.ctr.testnet</code>.</p>
-												deploy: da2b9538f419bf51f749f5a8f8a7138eb9aa59b4

											
										
										
											2024-07-02 14:16:28 +00:00
+								<h4 class="anchor anchorWithStickyNavbar_JmGV" id="defined-in-1">Defined in<a class="hash-link" aria-label="Direct link to Defined in" title="Direct link to Defined in" href="/api/interfaces/EndpointSettings#defined-in-1"></a></h4>
-												deploy: d4209c24d1ba77e42019cba4835fc357c2c1a1e6

											
										
										
											2024-07-25 10:27:17 +00:00
+								<p><a href="https://github.com/containers/podman-desktop/blob/d4209c24d1ba77e42019cba4835fc357c2c1a1e6/packages/extension-api/src/extension-api.d.ts#L2832" target="_blank" rel="noopener noreferrer">packages/extension-api/src/extension-api.d.ts:2832</a></p>
-												deploy: f8a3f5c04def1fceac66c2663588b7c37522934f

											
										
										
											2024-03-04 10:44:38 +00:00
+								<hr>
-												deploy: 6b93dc5d129d3e3fd8c5f303d5f460805c4b6b65

											
										
										
											2024-06-05 08:03:38 +00:00
+								<h3 class="anchor anchorWithStickyNavbar_JmGV" id="driveropts">DriverOpts?<a class="hash-link" aria-label="Direct link to DriverOpts?" title="Direct link to DriverOpts?" href="/api/interfaces/EndpointSettings#driveropts"></a></h3>
-												deploy: f8a3f5c04def1fceac66c2663588b7c37522934f

											
										
										
											2024-03-04 10:44:38 +00:00
+								<blockquote>
-												deploy: 913e923c9731ff8cb55c8e36ffdd866e25b6442a

											
										
										
											2024-04-23 13:30:46 +00:00
+								<p><code>optional</code> <strong>DriverOpts</strong>: <code>object</code></p>
-												deploy: f8a3f5c04def1fceac66c2663588b7c37522934f

											
										
										
											2024-03-04 10:44:38 +00:00
+								</blockquote>
 								<p>DriverOpts is a mapping of driver options and values. These options are passed directly to the driver and are driver specific.</p>
-												deploy: da2b9538f419bf51f749f5a8f8a7138eb9aa59b4

											
										
										
											2024-07-02 14:16:28 +00:00
+								<h4 class="anchor anchorWithStickyNavbar_JmGV" id="index-signature">Index Signature<a class="hash-link" aria-label="Direct link to Index Signature" title="Direct link to Index Signature" href="/api/interfaces/EndpointSettings#index-signature"></a></h4>
-												deploy: f8a3f5c04def1fceac66c2663588b7c37522934f

											
										
										
											2024-03-04 10:44:38 +00:00
+								<p>[<code>key</code>: <code>string</code>]: <code>string</code></p>
-												deploy: da2b9538f419bf51f749f5a8f8a7138eb9aa59b4

											
										
										
											2024-07-02 14:16:28 +00:00
+								<h4 class="anchor anchorWithStickyNavbar_JmGV" id="defined-in-2">Defined in<a class="hash-link" aria-label="Direct link to Defined in" title="Direct link to Defined in" href="/api/interfaces/EndpointSettings#defined-in-2"></a></h4>
-												deploy: d4209c24d1ba77e42019cba4835fc357c2c1a1e6

											
										
										
											2024-07-25 10:27:17 +00:00
+								<p><a href="https://github.com/containers/podman-desktop/blob/d4209c24d1ba77e42019cba4835fc357c2c1a1e6/packages/extension-api/src/extension-api.d.ts#L2822" target="_blank" rel="noopener noreferrer">packages/extension-api/src/extension-api.d.ts:2822</a></p>
-												deploy: f8a3f5c04def1fceac66c2663588b7c37522934f

											
										
										
											2024-03-04 10:44:38 +00:00
+								<hr>
-												deploy: 6b93dc5d129d3e3fd8c5f303d5f460805c4b6b65

											
										
										
											2024-06-05 08:03:38 +00:00
+								<h3 class="anchor anchorWithStickyNavbar_JmGV" id="endpointid">EndpointID?<a class="hash-link" aria-label="Direct link to EndpointID?" title="Direct link to EndpointID?" href="/api/interfaces/EndpointSettings#endpointid"></a></h3>
-												deploy: f8a3f5c04def1fceac66c2663588b7c37522934f

											
										
										
											2024-03-04 10:44:38 +00:00
+								<blockquote>
-												deploy: 913e923c9731ff8cb55c8e36ffdd866e25b6442a

											
										
										
											2024-04-23 13:30:46 +00:00
+								<p><code>optional</code> <strong>EndpointID</strong>: <code>string</code></p>
-												deploy: f8a3f5c04def1fceac66c2663588b7c37522934f

											
										
										
											2024-03-04 10:44:38 +00:00
+								</blockquote>
 								<p>Unique ID for the service endpoint in a Sandbox.</p>
-												deploy: da2b9538f419bf51f749f5a8f8a7138eb9aa59b4

											
										
										
											2024-07-02 14:16:28 +00:00
+								<h4 class="anchor anchorWithStickyNavbar_JmGV" id="defined-in-3">Defined in<a class="hash-link" aria-label="Direct link to Defined in" title="Direct link to Defined in" href="/api/interfaces/EndpointSettings#defined-in-3"></a></h4>
-												deploy: d4209c24d1ba77e42019cba4835fc357c2c1a1e6

											
										
										
											2024-07-25 10:27:17 +00:00
+								<p><a href="https://github.com/containers/podman-desktop/blob/d4209c24d1ba77e42019cba4835fc357c2c1a1e6/packages/extension-api/src/extension-api.d.ts#L2787" target="_blank" rel="noopener noreferrer">packages/extension-api/src/extension-api.d.ts:2787</a></p>
-												deploy: f8a3f5c04def1fceac66c2663588b7c37522934f

											
										
										
											2024-03-04 10:44:38 +00:00
+								<hr>
-												deploy: 6b93dc5d129d3e3fd8c5f303d5f460805c4b6b65

											
										
										
											2024-06-05 08:03:38 +00:00
+								<h3 class="anchor anchorWithStickyNavbar_JmGV" id="gateway">Gateway?<a class="hash-link" aria-label="Direct link to Gateway?" title="Direct link to Gateway?" href="/api/interfaces/EndpointSettings#gateway"></a></h3>
-												deploy: f8a3f5c04def1fceac66c2663588b7c37522934f

											
										
										
											2024-03-04 10:44:38 +00:00
+								<blockquote>
-												deploy: 913e923c9731ff8cb55c8e36ffdd866e25b6442a

											
										
										
											2024-04-23 13:30:46 +00:00
+								<p><code>optional</code> <strong>Gateway</strong>: <code>string</code></p>
-												deploy: f8a3f5c04def1fceac66c2663588b7c37522934f

											
										
										
											2024-03-04 10:44:38 +00:00
+								</blockquote>
 								<p>Gateway address for this network.</p>
-												deploy: da2b9538f419bf51f749f5a8f8a7138eb9aa59b4

											
										
										
											2024-07-02 14:16:28 +00:00
+								<h4 class="anchor anchorWithStickyNavbar_JmGV" id="defined-in-4">Defined in<a class="hash-link" aria-label="Direct link to Defined in" title="Direct link to Defined in" href="/api/interfaces/EndpointSettings#defined-in-4"></a></h4>
-												deploy: d4209c24d1ba77e42019cba4835fc357c2c1a1e6

											
										
										
											2024-07-25 10:27:17 +00:00
+								<p><a href="https://github.com/containers/podman-desktop/blob/d4209c24d1ba77e42019cba4835fc357c2c1a1e6/packages/extension-api/src/extension-api.d.ts#L2792" target="_blank" rel="noopener noreferrer">packages/extension-api/src/extension-api.d.ts:2792</a></p>
-												deploy: f8a3f5c04def1fceac66c2663588b7c37522934f

											
										
										
											2024-03-04 10:44:38 +00:00
+								<hr>
-												deploy: 6b93dc5d129d3e3fd8c5f303d5f460805c4b6b65

											
										
										
											2024-06-05 08:03:38 +00:00
+								<h3 class="anchor anchorWithStickyNavbar_JmGV" id="globalipv6address">GlobalIPv6Address?<a class="hash-link" aria-label="Direct link to GlobalIPv6Address?" title="Direct link to GlobalIPv6Address?" href="/api/interfaces/EndpointSettings#globalipv6address"></a></h3>
-												deploy: f8a3f5c04def1fceac66c2663588b7c37522934f

											
										
										
											2024-03-04 10:44:38 +00:00
+								<blockquote>
-												deploy: 913e923c9731ff8cb55c8e36ffdd866e25b6442a

											
										
										
											2024-04-23 13:30:46 +00:00
+								<p><code>optional</code> <strong>GlobalIPv6Address</strong>: <code>string</code></p>
-												deploy: f8a3f5c04def1fceac66c2663588b7c37522934f

											
										
										
											2024-03-04 10:44:38 +00:00
+								</blockquote>
 								<p>Global IPv6 address.</p>
-												deploy: da2b9538f419bf51f749f5a8f8a7138eb9aa59b4

											
										
										
											2024-07-02 14:16:28 +00:00
+								<h4 class="anchor anchorWithStickyNavbar_JmGV" id="defined-in-5">Defined in<a class="hash-link" aria-label="Direct link to Defined in" title="Direct link to Defined in" href="/api/interfaces/EndpointSettings#defined-in-5"></a></h4>
-												deploy: d4209c24d1ba77e42019cba4835fc357c2c1a1e6

											
										
										
											2024-07-25 10:27:17 +00:00
+								<p><a href="https://github.com/containers/podman-desktop/blob/d4209c24d1ba77e42019cba4835fc357c2c1a1e6/packages/extension-api/src/extension-api.d.ts#L2812" target="_blank" rel="noopener noreferrer">packages/extension-api/src/extension-api.d.ts:2812</a></p>
-												deploy: f8a3f5c04def1fceac66c2663588b7c37522934f

											
										
										
											2024-03-04 10:44:38 +00:00
+								<hr>
-												deploy: 6b93dc5d129d3e3fd8c5f303d5f460805c4b6b65

											
										
										
											2024-06-05 08:03:38 +00:00
+								<h3 class="anchor anchorWithStickyNavbar_JmGV" id="globalipv6prefixlen">GlobalIPv6PrefixLen?<a class="hash-link" aria-label="Direct link to GlobalIPv6PrefixLen?" title="Direct link to GlobalIPv6PrefixLen?" href="/api/interfaces/EndpointSettings#globalipv6prefixlen"></a></h3>
-												deploy: f8a3f5c04def1fceac66c2663588b7c37522934f

											
										
										
											2024-03-04 10:44:38 +00:00
+								<blockquote>
-												deploy: 913e923c9731ff8cb55c8e36ffdd866e25b6442a

											
										
										
											2024-04-23 13:30:46 +00:00
+								<p><code>optional</code> <strong>GlobalIPv6PrefixLen</strong>: <code>number</code></p>
-												deploy: f8a3f5c04def1fceac66c2663588b7c37522934f

											
										
										
											2024-03-04 10:44:38 +00:00
+								</blockquote>
 								<p>Mask length of the global IPv6 address.</p>
-												deploy: da2b9538f419bf51f749f5a8f8a7138eb9aa59b4

											
										
										
											2024-07-02 14:16:28 +00:00
+								<h4 class="anchor anchorWithStickyNavbar_JmGV" id="defined-in-6">Defined in<a class="hash-link" aria-label="Direct link to Defined in" title="Direct link to Defined in" href="/api/interfaces/EndpointSettings#defined-in-6"></a></h4>
-												deploy: d4209c24d1ba77e42019cba4835fc357c2c1a1e6

											
										
										
											2024-07-25 10:27:17 +00:00
+								<p><a href="https://github.com/containers/podman-desktop/blob/d4209c24d1ba77e42019cba4835fc357c2c1a1e6/packages/extension-api/src/extension-api.d.ts#L2817" target="_blank" rel="noopener noreferrer">packages/extension-api/src/extension-api.d.ts:2817</a></p>
-												deploy: f8a3f5c04def1fceac66c2663588b7c37522934f

											
										
										
											2024-03-04 10:44:38 +00:00
+								<hr>
-												deploy: 6b93dc5d129d3e3fd8c5f303d5f460805c4b6b65

											
										
										
											2024-06-05 08:03:38 +00:00
+								<h3 class="anchor anchorWithStickyNavbar_JmGV" id="ipamconfig">IPAMConfig?<a class="hash-link" aria-label="Direct link to IPAMConfig?" title="Direct link to IPAMConfig?" href="/api/interfaces/EndpointSettings#ipamconfig"></a></h3>
-												deploy: f8a3f5c04def1fceac66c2663588b7c37522934f

											
										
										
											2024-03-04 10:44:38 +00:00
+								<blockquote>
-												deploy: 913e923c9731ff8cb55c8e36ffdd866e25b6442a

											
										
										
											2024-04-23 13:30:46 +00:00
+								<p><code>optional</code> <strong>IPAMConfig</strong>: <a href="/api/interfaces/EndpointIPAMConfig"><code>EndpointIPAMConfig</code></a></p>
-												deploy: f8a3f5c04def1fceac66c2663588b7c37522934f

											
										
										
											2024-03-04 10:44:38 +00:00
+								</blockquote>
 								<p>EndpointIPAMConfig represents an endpoint&#x27;s IPAM configuration.</p>
-												deploy: da2b9538f419bf51f749f5a8f8a7138eb9aa59b4

											
										
										
											2024-07-02 14:16:28 +00:00
+								<h4 class="anchor anchorWithStickyNavbar_JmGV" id="defined-in-7">Defined in<a class="hash-link" aria-label="Direct link to Defined in" title="Direct link to Defined in" href="/api/interfaces/EndpointSettings#defined-in-7"></a></h4>
-												deploy: d4209c24d1ba77e42019cba4835fc357c2c1a1e6

											
										
										
											2024-07-25 10:27:17 +00:00
+								<p><a href="https://github.com/containers/podman-desktop/blob/d4209c24d1ba77e42019cba4835fc357c2c1a1e6/packages/extension-api/src/extension-api.d.ts#L2768" target="_blank" rel="noopener noreferrer">packages/extension-api/src/extension-api.d.ts:2768</a></p>
-												deploy: f8a3f5c04def1fceac66c2663588b7c37522934f

											
										
										
											2024-03-04 10:44:38 +00:00
+								<hr>
-												deploy: 6b93dc5d129d3e3fd8c5f303d5f460805c4b6b65

											
										
										
											2024-06-05 08:03:38 +00:00
+								<h3 class="anchor anchorWithStickyNavbar_JmGV" id="ipaddress">IPAddress?<a class="hash-link" aria-label="Direct link to IPAddress?" title="Direct link to IPAddress?" href="/api/interfaces/EndpointSettings#ipaddress"></a></h3>
-												deploy: f8a3f5c04def1fceac66c2663588b7c37522934f

											
										
										
											2024-03-04 10:44:38 +00:00
+								<blockquote>
-												deploy: 913e923c9731ff8cb55c8e36ffdd866e25b6442a

											
										
										
											2024-04-23 13:30:46 +00:00
+								<p><code>optional</code> <strong>IPAddress</strong>: <code>string</code></p>
-												deploy: f8a3f5c04def1fceac66c2663588b7c37522934f

											
										
										
											2024-03-04 10:44:38 +00:00
+								</blockquote>
 								<p>IPv4 address.</p>
-												deploy: da2b9538f419bf51f749f5a8f8a7138eb9aa59b4

											
										
										
											2024-07-02 14:16:28 +00:00
+								<h4 class="anchor anchorWithStickyNavbar_JmGV" id="defined-in-8">Defined in<a class="hash-link" aria-label="Direct link to Defined in" title="Direct link to Defined in" href="/api/interfaces/EndpointSettings#defined-in-8"></a></h4>
-												deploy: d4209c24d1ba77e42019cba4835fc357c2c1a1e6

											
										
										
											2024-07-25 10:27:17 +00:00
+								<p><a href="https://github.com/containers/podman-desktop/blob/d4209c24d1ba77e42019cba4835fc357c2c1a1e6/packages/extension-api/src/extension-api.d.ts#L2797" target="_blank" rel="noopener noreferrer">packages/extension-api/src/extension-api.d.ts:2797</a></p>
-												deploy: f8a3f5c04def1fceac66c2663588b7c37522934f

											
										
										
											2024-03-04 10:44:38 +00:00
+								<hr>
-												deploy: 6b93dc5d129d3e3fd8c5f303d5f460805c4b6b65

											
										
										
											2024-06-05 08:03:38 +00:00
+								<h3 class="anchor anchorWithStickyNavbar_JmGV" id="ipprefixlen">IPPrefixLen?<a class="hash-link" aria-label="Direct link to IPPrefixLen?" title="Direct link to IPPrefixLen?" href="/api/interfaces/EndpointSettings#ipprefixlen"></a></h3>
-												deploy: f8a3f5c04def1fceac66c2663588b7c37522934f

											
										
										
											2024-03-04 10:44:38 +00:00
+								<blockquote>
-												deploy: 913e923c9731ff8cb55c8e36ffdd866e25b6442a

											
										
										
											2024-04-23 13:30:46 +00:00
+								<p><code>optional</code> <strong>IPPrefixLen</strong>: <code>number</code></p>
-												deploy: f8a3f5c04def1fceac66c2663588b7c37522934f

											
										
										
											2024-03-04 10:44:38 +00:00
+								</blockquote>
 								<p>Mask length of the IPv4 address.</p>
-												deploy: da2b9538f419bf51f749f5a8f8a7138eb9aa59b4

											
										
										
											2024-07-02 14:16:28 +00:00
+								<h4 class="anchor anchorWithStickyNavbar_JmGV" id="defined-in-9">Defined in<a class="hash-link" aria-label="Direct link to Defined in" title="Direct link to Defined in" href="/api/interfaces/EndpointSettings#defined-in-9"></a></h4>
-												deploy: d4209c24d1ba77e42019cba4835fc357c2c1a1e6

											
										
										
											2024-07-25 10:27:17 +00:00
+								<p><a href="https://github.com/containers/podman-desktop/blob/d4209c24d1ba77e42019cba4835fc357c2c1a1e6/packages/extension-api/src/extension-api.d.ts#L2802" target="_blank" rel="noopener noreferrer">packages/extension-api/src/extension-api.d.ts:2802</a></p>
-												deploy: f8a3f5c04def1fceac66c2663588b7c37522934f

											
										
										
											2024-03-04 10:44:38 +00:00
+								<hr>
-												deploy: 6b93dc5d129d3e3fd8c5f303d5f460805c4b6b65

											
										
										
											2024-06-05 08:03:38 +00:00
+								<h3 class="anchor anchorWithStickyNavbar_JmGV" id="ipv6gateway">IPv6Gateway?<a class="hash-link" aria-label="Direct link to IPv6Gateway?" title="Direct link to IPv6Gateway?" href="/api/interfaces/EndpointSettings#ipv6gateway"></a></h3>
-												deploy: f8a3f5c04def1fceac66c2663588b7c37522934f

											
										
										
											2024-03-04 10:44:38 +00:00
+								<blockquote>
-												deploy: 913e923c9731ff8cb55c8e36ffdd866e25b6442a

											
										
										
											2024-04-23 13:30:46 +00:00
+								<p><code>optional</code> <strong>IPv6Gateway</strong>: <code>string</code></p>
-												deploy: f8a3f5c04def1fceac66c2663588b7c37522934f

											
										
										
											2024-03-04 10:44:38 +00:00
+								</blockquote>
 								<p>IPv6 gateway address.</p>
-												deploy: da2b9538f419bf51f749f5a8f8a7138eb9aa59b4

											
										
										
											2024-07-02 14:16:28 +00:00
+								<h4 class="anchor anchorWithStickyNavbar_JmGV" id="defined-in-10">Defined in<a class="hash-link" aria-label="Direct link to Defined in" title="Direct link to Defined in" href="/api/interfaces/EndpointSettings#defined-in-10"></a></h4>
-												deploy: d4209c24d1ba77e42019cba4835fc357c2c1a1e6

											
										
										
											2024-07-25 10:27:17 +00:00
+								<p><a href="https://github.com/containers/podman-desktop/blob/d4209c24d1ba77e42019cba4835fc357c2c1a1e6/packages/extension-api/src/extension-api.d.ts#L2807" target="_blank" rel="noopener noreferrer">packages/extension-api/src/extension-api.d.ts:2807</a></p>
-												deploy: f8a3f5c04def1fceac66c2663588b7c37522934f

											
										
										
											2024-03-04 10:44:38 +00:00
+								<hr>
-												deploy: 6b93dc5d129d3e3fd8c5f303d5f460805c4b6b65

											
										
										
											2024-06-05 08:03:38 +00:00
+								<h3 class="anchor anchorWithStickyNavbar_JmGV" id="links">Links?<a class="hash-link" aria-label="Direct link to Links?" title="Direct link to Links?" href="/api/interfaces/EndpointSettings#links"></a></h3>
-												deploy: f8a3f5c04def1fceac66c2663588b7c37522934f

											
										
										
											2024-03-04 10:44:38 +00:00
+								<blockquote>
-												deploy: 913e923c9731ff8cb55c8e36ffdd866e25b6442a

											
										
										
											2024-04-23 13:30:46 +00:00
+								<p><code>optional</code> <strong>Links</strong>: <code>string</code>[]</p>
-												deploy: f8a3f5c04def1fceac66c2663588b7c37522934f

											
										
										
											2024-03-04 10:44:38 +00:00
+								</blockquote>
-												deploy: da2b9538f419bf51f749f5a8f8a7138eb9aa59b4

											
										
										
											2024-07-02 14:16:28 +00:00
+								<h4 class="anchor anchorWithStickyNavbar_JmGV" id="defined-in-11">Defined in<a class="hash-link" aria-label="Direct link to Defined in" title="Direct link to Defined in" href="/api/interfaces/EndpointSettings#defined-in-11"></a></h4>
-												deploy: d4209c24d1ba77e42019cba4835fc357c2c1a1e6

											
										
										
											2024-07-25 10:27:17 +00:00
+								<p><a href="https://github.com/containers/podman-desktop/blob/d4209c24d1ba77e42019cba4835fc357c2c1a1e6/packages/extension-api/src/extension-api.d.ts#L2770" target="_blank" rel="noopener noreferrer">packages/extension-api/src/extension-api.d.ts:2770</a></p>
-												deploy: f8a3f5c04def1fceac66c2663588b7c37522934f

											
										
										
											2024-03-04 10:44:38 +00:00
+								<hr>
-												deploy: 6b93dc5d129d3e3fd8c5f303d5f460805c4b6b65

											
										
										
											2024-06-05 08:03:38 +00:00
+								<h3 class="anchor anchorWithStickyNavbar_JmGV" id="macaddress">MacAddress?<a class="hash-link" aria-label="Direct link to MacAddress?" title="Direct link to MacAddress?" href="/api/interfaces/EndpointSettings#macaddress"></a></h3>
-												deploy: f8a3f5c04def1fceac66c2663588b7c37522934f

											
										
										
											2024-03-04 10:44:38 +00:00
+								<blockquote>
-												deploy: 913e923c9731ff8cb55c8e36ffdd866e25b6442a

											
										
										
											2024-04-23 13:30:46 +00:00
+								<p><code>optional</code> <strong>MacAddress</strong>: <code>string</code></p>
-												deploy: f8a3f5c04def1fceac66c2663588b7c37522934f

											
										
										
											2024-03-04 10:44:38 +00:00
+								</blockquote>
 								<p>MAC address for the endpoint on this network. The network driver might ignore this parameter.</p>
-												deploy: da2b9538f419bf51f749f5a8f8a7138eb9aa59b4

											
										
										
											2024-07-02 14:16:28 +00:00
+								<h4 class="anchor anchorWithStickyNavbar_JmGV" id="defined-in-12">Defined in<a class="hash-link" aria-label="Direct link to Defined in" title="Direct link to Defined in" href="/api/interfaces/EndpointSettings#defined-in-12"></a></h4>
-												deploy: d4209c24d1ba77e42019cba4835fc357c2c1a1e6

											
										
										
											2024-07-25 10:27:17 +00:00
+								<p><a href="https://github.com/containers/podman-desktop/blob/d4209c24d1ba77e42019cba4835fc357c2c1a1e6/packages/extension-api/src/extension-api.d.ts#L2775" target="_blank" rel="noopener noreferrer">packages/extension-api/src/extension-api.d.ts:2775</a></p>
-												deploy: f8a3f5c04def1fceac66c2663588b7c37522934f

											
										
										
											2024-03-04 10:44:38 +00:00
+								<hr>
-												deploy: 6b93dc5d129d3e3fd8c5f303d5f460805c4b6b65

											
										
										
											2024-06-05 08:03:38 +00:00
+								<h3 class="anchor anchorWithStickyNavbar_JmGV" id="networkid">NetworkID?<a class="hash-link" aria-label="Direct link to NetworkID?" title="Direct link to NetworkID?" href="/api/interfaces/EndpointSettings#networkid"></a></h3>
-												deploy: f8a3f5c04def1fceac66c2663588b7c37522934f

											
										
										
											2024-03-04 10:44:38 +00:00
+								<blockquote>
-												deploy: 913e923c9731ff8cb55c8e36ffdd866e25b6442a

											
										
										
											2024-04-23 13:30:46 +00:00
+								<p><code>optional</code> <strong>NetworkID</strong>: <code>string</code></p>
-												deploy: f8a3f5c04def1fceac66c2663588b7c37522934f

											
										
										
											2024-03-04 10:44:38 +00:00
+								</blockquote>
 								<p>Unique ID of the network.</p>
-												deploy: da2b9538f419bf51f749f5a8f8a7138eb9aa59b4

											
										
										
											2024-07-02 14:16:28 +00:00
+								<h4 class="anchor anchorWithStickyNavbar_JmGV" id="defined-in-13">Defined in<a class="hash-link" aria-label="Direct link to Defined in" title="Direct link to Defined in" href="/api/interfaces/EndpointSettings#defined-in-13"></a></h4>
-												deploy: d4209c24d1ba77e42019cba4835fc357c2c1a1e6

											
										
										
											2024-07-25 10:27:17 +00:00
+								<p><a href="https://github.com/containers/podman-desktop/blob/d4209c24d1ba77e42019cba4835fc357c2c1a1e6/packages/extension-api/src/extension-api.d.ts#L2782" target="_blank" rel="noopener noreferrer">packages/extension-api/src/extension-api.d.ts:2782</a></p></div></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/api/interfaces/EndpointIPAMConfig"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">EndpointIPAMConfig</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/api/interfaces/Event"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Event</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_XG6w thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a class="table-of-contents__link toc-highlight" href="/api/interfaces/EndpointSettings#properties">Properties</a><ul><li><a class="table-of-contents__link toc-highlight" href="/api/interfaces/EndpointSettings#aliases">Aliases?</a></li><li><a class="table-of-contents__link toc-highlight" href="/api/interfaces/EndpointSettings#dnsnames">DNSNames?</a></li><li><a class="table-of-contents__link toc-highlight" href="/api/interfaces/EndpointSettings#driveropts">DriverOpts?</a></li><li><a class="table-of-contents__link toc-highlight" href="/api/interfaces/EndpointSettings#endpointid">EndpointID?</a></li><li><a class="table-of-contents__link toc-highlight" href="/api/interfaces/EndpointSettings#gateway">Gateway?</a></li><li><a class="table-of-contents__link toc-highlight" href="/api/interfaces/EndpointSettings#globalipv6address">GlobalIPv6Address?</a></li><li><a class="table-of-contents__link toc-highlight" href="/api/interfaces/EndpointSettings#globalipv6prefixlen">GlobalIPv6PrefixLen?</a></li><li><a class="table-of-contents__link toc-highlight" href="/api/interfaces/EndpointSettings#ipamconfig">IPAMConfig?</a></li><li><a class="table-of-contents__link toc-highlight" href="/api/interfaces/EndpointSettings#ipaddress">IPAddress?</a></li><li><a class="table-of-contents__link toc-highlight" href="/api/interfaces/EndpointSettings#ipprefixlen">IPPrefixLen?</a></li><li><a class="table-of-contents__link toc-highlight" href="/api/interfaces/EndpointSettings#ipv6gateway">IPv6Gateway?</a></li><li><a class="table-of-contents__link toc-highlight" href="/api/interfaces/EndpointSettings#links">Links?</a></li><li><a class="table-of-contents__link toc-highlight" href="/api/interfaces/EndpointSettings#macaddress">MacAddress?</a></li><li><a class="table-of-contents__link toc-highlight" href="/api/interfaces/EndpointSettings#networkid">NetworkID?</a></li></ul></li></ul></div></div></div></div></main></div></div></div><footer class="footer"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Documentation</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/docs/installation">Installing Podman Desktop</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/migrating-from-docker">Migrating from Docker</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/kubernetes">Working with Kubernetes</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/troubleshooting">Troubleshooting</a></li></ul></div><div class="col footer__col"><div class="footer__title">Links</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://github.com/containers/podman-desktop" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPrP"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://discord.com/invite/x
-												deploy: f8a3f5c04def1fceac66c2663588b7c37522934f

											
										
										
											2024-03-04 10:44:38 +00:00
+								</body>
 								</html>