podman-desktop/api/@podman-desktop/namespaces/containerEngine/functions/pullImage.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-@podman-desktop/namespaces/containerEngine/functions/pullImage" data-has-hydrated="false">
<head>
<meta charset="UTF-8">
<meta name="generator" content="Docusaurus v3.9.2">
<title data-rh="true">Function: pullImage() | 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/@podman-desktop/namespaces/containerEngine/functions/pullImage"><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="Function: pullImage() | Podman Desktop"><meta data-rh="true" name="description" content="pullImage(containerProviderConnection, imageName, callback, platform?, token?): Promise\"><meta data-rh="true" property="og:description" content="pullImage(containerProviderConnection, imageName, callback, platform?, token?): Promise\"><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://podman-desktop.io/api/@podman-desktop/namespaces/containerEngine/functions/pullImage"><link data-rh="true" rel="alternate" href="https://podman-desktop.io/api/@podman-desktop/namespaces/containerEngine/functions/pullImage" hreflang="en"><link data-rh="true" rel="alternate" href="https://podman-desktop.io/api/@podman-desktop/namespaces/containerEngine/functions/pullImage" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://MR01ANKQ9S-dsn.algolia.net" crossorigin="anonymous"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Podman-Desktop API","item":"https://podman-desktop.io/api/"},{"@type":"ListItem","position":2,"name":"containerEngine","item":"https://podman-desktop.io/api/@podman-desktop/namespaces/containerEngine/"},{"@type":"ListItem","position":3,"name":"pullImage","item":"https://podman-desktop.io/api/@podman-desktop/namespaces/containerEngine/functions/pullImage"}]}</script><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.82f9557a.css">
<script src="/assets/js/runtime~main.cb08c0d4.js" defer="defer"></script>
<script src="/assets/js/main.bf8df4af.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
<svg style="display: none;"><defs>
<symbol id="theme-svg-external-link" viewBox="0 0 24 24"><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"/></symbol>
</defs></svg>
<script>!function(){var t=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();document.documentElement.setAttribute("data-theme",t||(window.matchMedia("(prefers-color-scheme: dark)").matches?"dark":"light")),document.documentElement.setAttribute("data-theme-choice",t||"system")}(),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="theme-layout-navbar navbar navbar--fixed-top"><div class="navbar__inner"><div class="theme-layout-navbar-left 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="/downloads">Downloads</a><a class="navbar__item navbar__link" href="/community">Community</a><div class="navbar__item dropdown dropdown--hoverable"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link">Resources</a><ul class="dropdown__menu"><li><a class="dropdown__link" href="/features">Features</a></li><li><a class="dropdown__link" href="/tutorial">Tutorials</a></li><li><a class="dropdown__link" href="/extend">Extend</a></li></ul></div><a class="navbar__item navbar__link" href="/blog">Blog</a></div><div class="theme-layout-navbar-right navbar__items navbar__items--right"><a href="https://github.com/podman-desktop/podman-desktop" target="_blank" id="github-stars-button" rel="noopener noreferrer" class="navbar__item navbar__link hidden xl:flex items-center gap-2 px-4 mr-3 py-[9px] border border-black dark:border-white rounded-lg font-medium min-w-[9rem] text-base"><svg data-prefix="fab" data-icon="github" class="svg-inline--fa fa-github" role="img" viewBox="0 0 512 512" aria-hidden="true"><path fill="currentColor" d="M173.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3 .3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6zm-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5 .3-6.2 2.3zm44.2-1.7c-2.9 .7-4.9 2.6-4.6 4.9 .3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9zM252.8 8c-138.7 0-244.8 105.3-244.8 244 0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1 100-33.2 167.8-128.1 167.8-239 0-138.7-112.5-244-251.2-244zM105.2 352.9c-1.3 1-1 3.3 .7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1zm-10.8-8.1c-.7 1.3 .3 2.9 2.3 3.9 1.6 1 3.6 .7 4.3-.7 .7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3 .7zm32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3 .7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1zm-11.4-14.7
<blockquote>
<p><strong>pullImage</strong>(<code>containerProviderConnection</code>, <code>imageName</code>, <code>callback</code>, <code>platform?</code>, <code>token?</code>): <code>Promise</code>&lt;<code>void</code>&gt;</p>
</blockquote>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/409ceec0cf8b518da23a98e99391bd655b61124a/packages/extension-api/src/extension-api.d.ts#L4100" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4100</a></p>
<p>Pull an image from a registry</p>
<h2 class="anchor anchorTargetStickyNavbar_tleR" id="parameters">Parameters<a href="#parameters" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters" translate="no"></a></h2>
<h3 class="anchor anchorTargetStickyNavbar_tleR" id="containerproviderconnection">containerProviderConnection<a href="#containerproviderconnection" class="hash-link" aria-label="Direct link to containerProviderConnection" title="Direct link to containerProviderConnection" translate="no"></a></h3>
<p><a class="" href="/api/interfaces/ContainerProviderConnection"><code>ContainerProviderConnection</code></a></p>
<p>the connection to the local engine to use for pulling the image</p>
<h3 class="anchor anchorTargetStickyNavbar_tleR" id="imagename">imageName<a href="#imagename" class="hash-link" aria-label="Direct link to imageName" title="Direct link to imageName" translate="no"></a></h3>
<p><code>string</code></p>
<p>the name of the image to pull</p>
<h3 class="anchor anchorTargetStickyNavbar_tleR" id="callback">callback<a href="#callback" class="hash-link" aria-label="Direct link to callback" title="Direct link to callback" translate="no"></a></h3>
<p>(<code>event</code>) =&gt; <code>void</code></p>
<p>the function called when new logs are emitted during the pull operation</p>
<h3 class="anchor anchorTargetStickyNavbar_tleR" id="platform">platform?<a href="#platform" class="hash-link" aria-label="Direct link to platform?" title="Direct link to platform?" translate="no"></a></h3>
<p><code>string</code></p>
<p>the platform of the image to pull (optional, by default it will pull the same architecture as the host)</p>
<h3 class="anchor anchorTargetStickyNavbar_tleR" id="token">token?<a href="#token" class="hash-link" aria-label="Direct link to token?" title="Direct link to token?" translate="no"></a></h3>
<p><a class="" href="/api/interfaces/CancellationToken"><code>CancellationToken</code></a></p>
<p>an optional <a class="" href="/api/interfaces/CancellationToken">CancellationToken</a> to cancel the pull operation</p>
<h2 class="anchor anchorTargetStickyNavbar_tleR" id="returns">Returns<a href="#returns" class="hash-link" aria-label="Direct link to Returns" title="Direct link to Returns" translate="no"></a></h2>
<p><code>Promise</code>&lt;<code>void</code>&gt;</p></div></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/api/@podman-desktop/namespaces/containerEngine/functions/logsContainer"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">logsContainer</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/api/@podman-desktop/namespaces/containerEngine/functions/pushImage"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">pushImage</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 href="#parameters" class="table-of-contents__link toc-highlight">Parameters</a><ul><li><a href="#containerproviderconnection" class="table-of-contents__link toc-highlight">containerProviderConnection</a></li><li><a href="#imagename" class="table-of-contents__link toc-highlight">imageName</a></li><li><a href="#callback" class="table-of-contents__link toc-highlight">callback</a></li><li><a href="#platform" class="table-of-contents__link toc-highlight">platform?</a></li><li><a href="#token" class="table-of-contents__link toc-highlight">token?</a></li></ul></li><li><a href="#returns" class="table-of-contents__link toc-highlight">Returns</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column 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="theme-layout-footer-column col footer__col"><div class="footer__title">Links</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://github.com/podman-desktop/podman-desktop" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></svg></a></li><li class="footer__item"><a href="https://discord.com/invite/x5GzFF6QH4" target="_blank" rel="noopener noreferrer" class="footer__link-item">Chat (bridged): #podman-desktop on Discord<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></svg></a></li><li class="footer__item"><a href="https://github.com/podman-desktop/podman-desktop#communication" target="_blank" rel="noopener noreferrer" class="footer__link-item">Other ways to Communicate<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></svg></a></li><li class="footer__item"><a href="https://github.com/orgs/podman-desktop/projects/4/views/3" target="_blank" rel="noopener noreferrer" class="footer__link-item">Current Sprint<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></svg></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">
          <div class="flex flex-col items-start text-left gap-4">
            <div class="w-96 mt-8 mb-8">
              <img class="dark:hidden" alt="Cloud Native Computing Foundation" src="/img/cncf-logo.svg">
              <img class="hidden dark:inline" alt="Cloud Native Computing Foundation" src="/img/cncf-logo-dark.svg">
            </div>
            <div class="text-sm">
              <p class="mb-1">We are a <a href="https://cncf.io/" class="underline">Cloud Native Computing Foundation</a> sandbox project.</p>
              <p class="mb-1">© Copyright Podman Desktop Contributors 2026. © 2026 The Linux Foundation. All rights reserved.</p>
              <p class="mb-1">The Linux Foundation has registered trademarks and uses trademarks.
              For a list of trademarks of The Linux Foundation, please see our
              <a href="https://www.linuxfoundation.org/trademark-usage/" class="underline"> Trademark Usage</a> page.</p>
            </div>
          </div>
      </div></div></div></footer></div>
</body>
</html>
-												deploy: 09704e3c0a3644d759528fe01670e718c20af6ae

											
										
										
											2025-03-17 09:57:37 +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-@podman-desktop/namespaces/containerEngine/functions/pullImage" data-has-hydrated="false">
 								<head>
 								<meta charset="UTF-8">
-												deploy: d3245ca5de6e92707f9d104c444d4fa8a3f477ac

											
										
										
											2025-11-05 20:28:25 +00:00
+								<meta name="generator" content="Docusaurus v3.9.2">
-												deploy: 6eee4cb661f1694db52c14ae481d5fc7ca0a7d11

											
										
										
											2025-09-08 13:08:00 +00:00
+								<title data-rh="true">Function: pullImage() | 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/@podman-desktop/namespaces/containerEngine/functions/pullImage"><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="Function: pullImage() | Podman Desktop"><meta data-rh="true" name="description" content="pullImage(containerProviderConnection, imageName, callback, platform?, token?): Promise\"><meta data-rh="true" property="og:description" content="pullImage(containerProviderConnection, imageName, callback, platform?, token?): Promise\"><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://podman-desktop.io/api/@podman-desktop/namespaces/containerEngine/functions/pullImage"><link data-rh="true" rel="alternate" href="https://podman-desktop.io/api/@podman-desktop/namespaces/containerEngine/functions/pullImage" hreflang="en"><link data-rh="true" rel="alternate" href="https://podman-desktop.io/api/@podman-desktop/namespaces/containerEngine/functions/pullImage" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://MR01ANKQ9S-dsn.algolia.net" crossorigin="anonymous"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Podman-Desktop API","item":"https://podman-desktop.io/api/"},{"@type":"ListItem","position":2,"name":"containerEngine","item":"https://podman-desktop.io/api/@podman-desktop/namespaces/containerEngine/"},{"@type":"ListItem","position":3,"name":"pullImage","item":"https://podman-desktop.io/api/@podman-desktop/namespaces/containerEngine/functions/pullImage"}]}</script><link rel="alternate" type="application/rss+xml" href="/blog/rss.xml" title="Podman Desktop RSS Feed">
-												deploy: 09704e3c0a3644d759528fe01670e718c20af6ae

											
										
										
											2025-03-17 09:57:37 +00:00
+								<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: 5c156196856815726d5b690a21f9c9641233f974

											
										
										
											2026-03-19 08:37:32 +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.82f9557a.css">
-												deploy: 409ceec0cf8b518da23a98e99391bd655b61124a

											
										
										
											2026-03-23 04:59:53 +00:00
+								<script src="/assets/js/runtime~main.cb08c0d4.js" defer="defer"></script>
 								<script src="/assets/js/main.bf8df4af.js" defer="defer"></script>
-												deploy: 09704e3c0a3644d759528fe01670e718c20af6ae

											
										
										
											2025-03-17 09:57:37 +00:00
+								</head>
 								<body class="navigation-with-keyboard">
-												deploy: d3245ca5de6e92707f9d104c444d4fa8a3f477ac

											
										
										
											2025-11-05 20:28:25 +00:00
+								<svg style="display: none;"><defs>
-												deploy: 6eee4cb661f1694db52c14ae481d5fc7ca0a7d11

											
										
										
											2025-09-08 13:08:00 +00:00
+								<symbol id="theme-svg-external-link" viewBox="0 0 24 24"><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"/></symbol>
 								</defs></svg>
-												deploy: f292a4ffcb050533f9e8cf26d6381bd3783df063

											
										
										
											2026-02-26 12:56:08 +00:00
+								<script>!function(){var t=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();document.documentElement.setAttribute("data-theme",t||(window.matchMedia("(prefers-color-scheme: dark)").matches?"dark":"light")),document.documentElement.setAttribute("data-theme-choice",t||"system")}(),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="theme-layout-navbar navbar navbar--fixed-top"><div class="navbar__inner"><div class="theme-layout-navbar-left 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="/downloads">Downloads</a><a class="navbar__item navbar__link" href="/community">Community</a><div class="navbar__item dropdown dropdown--hoverable"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link">Resources</a><ul class="dropdown__menu"><li><a class="dropdown__link" href="/features">Features</a></li><li><a class="dropdown__link" href="/tutorial">Tutorials</a></li><li><a class="dropdown__link" href="/extend">Extend</a></li></ul></div><a class="navbar__item navbar__link" href="/blog">Blog</a></div><div class="theme-layout-navbar-right navbar__items navbar__items--right"><a href="https://github.com/podman-desktop/podman-desktop" target="_blank" id="github-stars-button" rel="noopener noreferrer" class="navbar__item navbar__link hidden xl:flex items-center gap-2 px-4 mr-3 py-[9px] border border-black dark:border-white rounded-lg font-medium min-w-[9rem] text-base"><svg data-prefix="fab" data-icon="github" class="svg-inline--fa fa-github" role="img" viewBox="0 0 512 512" aria-hidden="true"><path fill="currentColor" d="M173.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3 .3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6zm-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5 .3-6.2 2.3zm44.2-1.7c-2.9 .7-4.9 2.6-4.6 4.9 .3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9zM252.8 8c-138.7 0-244.8 105.3-244.8 244 0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1 100-33.2 167.8-128.1 167.8-239 0-138.7-112.5-244-251.2-244zM105.2 352.9c-1.3 1-1 3.3 .7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1zm-10.8-8.1c-.7 1.3 .3 2.9 2.3 3.9 1.6 1 3.6 .7 4.3-.7 .7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3 .7zm32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3 .7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1zm-11.4-14.7
-												deploy: 09704e3c0a3644d759528fe01670e718c20af6ae

											
										
										
											2025-03-17 09:57:37 +00:00
+								<blockquote>
-												deploy: 372c382ba103b4e2a1ab513dda3c645cff2ade81

											
										
										
											2025-06-05 14:16:58 +00:00
+								<p><strong>pullImage</strong>(<code>containerProviderConnection</code>, <code>imageName</code>, <code>callback</code>, <code>platform?</code>, <code>token?</code>): <code>Promise</code>&lt;<code>void</code>&gt;</p>
-												deploy: 09704e3c0a3644d759528fe01670e718c20af6ae

											
										
										
											2025-03-17 09:57:37 +00:00
+								</blockquote>
-												deploy: 409ceec0cf8b518da23a98e99391bd655b61124a

											
										
										
											2026-03-23 04:59:53 +00:00
+								<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/409ceec0cf8b518da23a98e99391bd655b61124a/packages/extension-api/src/extension-api.d.ts#L4100" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4100</a></p>
-												deploy: 09704e3c0a3644d759528fe01670e718c20af6ae

											
										
										
											2025-03-17 09:57:37 +00:00
+								<p>Pull an image from a registry</p>
-												deploy: d3245ca5de6e92707f9d104c444d4fa8a3f477ac

											
										
										
											2025-11-05 20:28:25 +00:00
+								<h2 class="anchor anchorTargetStickyNavbar_tleR" id="parameters">Parameters<a href="#parameters" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters" translate="no"></a></h2>
 								<h3 class="anchor anchorTargetStickyNavbar_tleR" id="containerproviderconnection">containerProviderConnection<a href="#containerproviderconnection" class="hash-link" aria-label="Direct link to containerProviderConnection" title="Direct link to containerProviderConnection" translate="no"></a></h3>
 								<p><a class="" href="/api/interfaces/ContainerProviderConnection"><code>ContainerProviderConnection</code></a></p>
-												deploy: 09704e3c0a3644d759528fe01670e718c20af6ae

											
										
										
											2025-03-17 09:57:37 +00:00
+								<p>the connection to the local engine to use for pulling the image</p>
-												deploy: d3245ca5de6e92707f9d104c444d4fa8a3f477ac

											
										
										
											2025-11-05 20:28:25 +00:00
+								<h3 class="anchor anchorTargetStickyNavbar_tleR" id="imagename">imageName<a href="#imagename" class="hash-link" aria-label="Direct link to imageName" title="Direct link to imageName" translate="no"></a></h3>
-												deploy: 09704e3c0a3644d759528fe01670e718c20af6ae

											
										
										
											2025-03-17 09:57:37 +00:00
+								<p><code>string</code></p>
 								<p>the name of the image to pull</p>
-												deploy: d3245ca5de6e92707f9d104c444d4fa8a3f477ac

											
										
										
											2025-11-05 20:28:25 +00:00
+								<h3 class="anchor anchorTargetStickyNavbar_tleR" id="callback">callback<a href="#callback" class="hash-link" aria-label="Direct link to callback" title="Direct link to callback" translate="no"></a></h3>
-												deploy: 09704e3c0a3644d759528fe01670e718c20af6ae

											
										
										
											2025-03-17 09:57:37 +00:00
+								<p>(<code>event</code>) =&gt; <code>void</code></p>
 								<p>the function called when new logs are emitted during the pull operation</p>
-												deploy: d3245ca5de6e92707f9d104c444d4fa8a3f477ac

											
										
										
											2025-11-05 20:28:25 +00:00
+								<h3 class="anchor anchorTargetStickyNavbar_tleR" id="platform">platform?<a href="#platform" class="hash-link" aria-label="Direct link to platform?" title="Direct link to platform?" translate="no"></a></h3>
-												deploy: 09704e3c0a3644d759528fe01670e718c20af6ae

											
										
										
											2025-03-17 09:57:37 +00:00
+								<p><code>string</code></p>
 								<p>the platform of the image to pull (optional, by default it will pull the same architecture as the host)</p>
-												deploy: d3245ca5de6e92707f9d104c444d4fa8a3f477ac

											
										
										
											2025-11-05 20:28:25 +00:00
+								<h3 class="anchor anchorTargetStickyNavbar_tleR" id="token">token?<a href="#token" class="hash-link" aria-label="Direct link to token?" title="Direct link to token?" translate="no"></a></h3>
 								<p><a class="" href="/api/interfaces/CancellationToken"><code>CancellationToken</code></a></p>
 								<p>an optional <a class="" href="/api/interfaces/CancellationToken">CancellationToken</a> to cancel the pull operation</p>
 								<h2 class="anchor anchorTargetStickyNavbar_tleR" id="returns">Returns<a href="#returns" class="hash-link" aria-label="Direct link to Returns" title="Direct link to Returns" translate="no"></a></h2>
 								<p><code>Promise</code>&lt;<code>void</code>&gt;</p></div></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/api/@podman-desktop/namespaces/containerEngine/functions/logsContainer"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">logsContainer</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/api/@podman-desktop/namespaces/containerEngine/functions/pushImage"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">pushImage</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 href="#parameters" class="table-of-contents__link toc-highlight">Parameters</a><ul><li><a href="#containerproviderconnection" class="table-of-contents__link toc-highlight">containerProviderConnection</a></li><li><a href="#imagename" class="table-of-contents__link toc-highlight">imageName</a></li><li><a href="#callback" class="table-of-contents__link toc-highlight">callback</a></li><li><a href="#platform" class="table-of-contents__link toc-highlight">platform?</a></li><li><a href="#token" class="table-of-contents__link toc-highlight">token?</a></li></ul></li><li><a href="#returns" class="table-of-contents__link toc-highlight">Returns</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column 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="theme-layout-footer-column col footer__col"><div class="footer__title">Links</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://github.com/podman-desktop/podman-desktop" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></svg></a></li><li class="footer__item"><a href="https://discord.com/invite/x5GzFF6QH4" target="_blank" rel="noopener noreferrer" class="footer__link-item">Chat (bridged): #podman-desktop on Discord<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></svg></a></li><li class="footer__item"><a href="https://github.com/podman-desktop/podman-desktop#communication" target="_blank" rel="noopener noreferrer" class="footer__link-item">Other ways to Communicate<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></svg></a></li><li class="footer__item"><a href="https://github.com/orgs/podman-desktop/projects/4/views/3" target="_blank" rel="noopener noreferrer" class="footer__link-item">Current Sprint<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></svg></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">
-												deploy: a467a33f4a930b5a89e817c31d1a3b26dbeb6755

											
										
										
											2025-04-14 17:49:47 +00:00
+								          <div class="flex flex-col items-start text-left gap-4">
 								            <div class="w-96 mt-8 mb-8">
 								              <img class="dark:hidden" alt="Cloud Native Computing Foundation" src="/img/cncf-logo.svg">
 								              <img class="hidden dark:inline" alt="Cloud Native Computing Foundation" src="/img/cncf-logo-dark.svg">
 								            </div>
 								            <div class="text-sm">
 								              <p class="mb-1">We are a <a href="https://cncf.io/" class="underline">Cloud Native Computing Foundation</a> sandbox project.</p>
-												deploy: 0842ea99c42c3607a6340fc168a63e86c3d057d5

											
										
										
											2026-01-02 09:09:39 +00:00
+								              <p class="mb-1">© Copyright Podman Desktop Contributors 2026. © 2026 The Linux Foundation. All rights reserved.</p>
-												deploy: a467a33f4a930b5a89e817c31d1a3b26dbeb6755

											
										
										
											2025-04-14 17:49:47 +00:00
+								              <p class="mb-1">The Linux Foundation has registered trademarks and uses trademarks.
 								              For a list of trademarks of The Linux Foundation, please see our
 								              <a href="https://www.linuxfoundation.org/trademark-usage/" class="underline"> Trademark Usage</a> page.</p>
 								            </div>
 								          </div>
 								      </div></div></div></footer></div>
-												deploy: 09704e3c0a3644d759528fe01670e718c20af6ae

											
										
										
											2025-03-17 09:57:37 +00:00
+								</body>
 								</html>