<h2class="anchor anchorWithStickyNavbar_JmGV"id="properties">Properties<ahref="#properties"class="hash-link"aria-label="Direct link to Properties"title="Direct link to Properties"></a></h2>
<h3class="anchor anchorWithStickyNavbar_JmGV"id="argsescaped">ArgsEscaped?<ahref="#argsescaped"class="hash-link"aria-label="Direct link to ArgsEscaped?"title="Direct link to ArgsEscaped?"></a></h3>
<h4class="anchor anchorWithStickyNavbar_JmGV"id="defined-in">Defined in<ahref="#defined-in"class="hash-link"aria-label="Direct link to Defined in"title="Direct link to Defined in"></a></h4>
<h3class="anchor anchorWithStickyNavbar_JmGV"id="attachstderr">AttachStderr?<ahref="#attachstderr"class="hash-link"aria-label="Direct link to AttachStderr?"title="Direct link to AttachStderr?"></a></h3>
<h4class="anchor anchorWithStickyNavbar_JmGV"id="defined-in-1">Defined in<ahref="#defined-in-1"class="hash-link"aria-label="Direct link to Defined in"title="Direct link to Defined in"></a></h4>
<h3class="anchor anchorWithStickyNavbar_JmGV"id="attachstdin">AttachStdin?<ahref="#attachstdin"class="hash-link"aria-label="Direct link to AttachStdin?"title="Direct link to AttachStdin?"></a></h3>
<h4class="anchor anchorWithStickyNavbar_JmGV"id="defined-in-2">Defined in<ahref="#defined-in-2"class="hash-link"aria-label="Direct link to Defined in"title="Direct link to Defined in"></a></h4>
<h3class="anchor anchorWithStickyNavbar_JmGV"id="attachstdout">AttachStdout?<ahref="#attachstdout"class="hash-link"aria-label="Direct link to AttachStdout?"title="Direct link to AttachStdout?"></a></h3>
<h4class="anchor anchorWithStickyNavbar_JmGV"id="defined-in-3">Defined in<ahref="#defined-in-3"class="hash-link"aria-label="Direct link to Defined in"title="Direct link to Defined in"></a></h4>
<h3class="anchor anchorWithStickyNavbar_JmGV"id="cmd">Cmd?<ahref="#cmd"class="hash-link"aria-label="Direct link to Cmd?"title="Direct link to Cmd?"></a></h3>
<h4class="anchor anchorWithStickyNavbar_JmGV"id="defined-in-4">Defined in<ahref="#defined-in-4"class="hash-link"aria-label="Direct link to Defined in"title="Direct link to Defined in"></a></h4>
<h3class="anchor anchorWithStickyNavbar_JmGV"id="detach">Detach?<ahref="#detach"class="hash-link"aria-label="Direct link to Detach?"title="Direct link to Detach?"></a></h3>
<h4class="anchor anchorWithStickyNavbar_JmGV"id="defined-in-5">Defined in<ahref="#defined-in-5"class="hash-link"aria-label="Direct link to Defined in"title="Direct link to Defined in"></a></h4>
<h3class="anchor anchorWithStickyNavbar_JmGV"id="domainname">Domainname?<ahref="#domainname"class="hash-link"aria-label="Direct link to Domainname?"title="Direct link to Domainname?"></a></h3>
<h4class="anchor anchorWithStickyNavbar_JmGV"id="defined-in-6">Defined in<ahref="#defined-in-6"class="hash-link"aria-label="Direct link to Defined in"title="Direct link to Defined in"></a></h4>
<h3class="anchor anchorWithStickyNavbar_JmGV"id="entrypoint">Entrypoint?<ahref="#entrypoint"class="hash-link"aria-label="Direct link to Entrypoint?"title="Direct link to Entrypoint?"></a></h3>
<p>The entry point for the container as a string or an array of strings.</p>
<p>If the array consists of exactly one empty string (<code>[""]</code>) then the entry point is reset to system default (i.e., the entry point used by docker when there is no ENTRYPOINT instruction in the Containerfile).</p>
<h4class="anchor anchorWithStickyNavbar_JmGV"id="defined-in-7">Defined in<ahref="#defined-in-7"class="hash-link"aria-label="Direct link to Defined in"title="Direct link to Defined in"></a></h4>
<h3class="anchor anchorWithStickyNavbar_JmGV"id="env">Env?<ahref="#env"class="hash-link"aria-label="Direct link to Env?"title="Direct link to Env?"></a></h3>
<p>A list of environment variables to set inside the container in the form <code>["VAR=value", ...]</code>. A variable without <code>=</code> is removed from the environment, rather than to have an empty value</p>
<h4class="anchor anchorWithStickyNavbar_JmGV"id="defined-in-8">Defined in<ahref="#defined-in-8"class="hash-link"aria-label="Direct link to Defined in"title="Direct link to Defined in"></a></h4>
<h3class="anchor anchorWithStickyNavbar_JmGV"id="envfiles">EnvFiles?<ahref="#envfiles"class="hash-link"aria-label="Direct link to EnvFiles?"title="Direct link to EnvFiles?"></a></h3>
<h4class="anchor anchorWithStickyNavbar_JmGV"id="defined-in-9">Defined in<ahref="#defined-in-9"class="hash-link"aria-label="Direct link to Defined in"title="Direct link to Defined in"></a></h4>
<h3class="anchor anchorWithStickyNavbar_JmGV"id="exposedports">ExposedPorts?<ahref="#exposedports"class="hash-link"aria-label="Direct link to ExposedPorts?"title="Direct link to ExposedPorts?"></a></h3>
<h4class="anchor anchorWithStickyNavbar_JmGV"id="index-signature">Index Signature<ahref="#index-signature"class="hash-link"aria-label="Direct link to Index Signature"title="Direct link to Index Signature"></a></h4>
<h4class="anchor anchorWithStickyNavbar_JmGV"id="defined-in-10">Defined in<ahref="#defined-in-10"class="hash-link"aria-label="Direct link to Defined in"title="Direct link to Defined in"></a></h4>
<h3class="anchor anchorWithStickyNavbar_JmGV"id="healthcheck">HealthCheck?<ahref="#healthcheck"class="hash-link"aria-label="Direct link to HealthCheck?"title="Direct link to HealthCheck?"></a></h3>
<h4class="anchor anchorWithStickyNavbar_JmGV"id="defined-in-11">Defined in<ahref="#defined-in-11"class="hash-link"aria-label="Direct link to Defined in"title="Direct link to Defined in"></a></h4>
<h3class="anchor anchorWithStickyNavbar_JmGV"id="hostconfig">HostConfig?<ahref="#hostconfig"class="hash-link"aria-label="Direct link to HostConfig?"title="Direct link to HostConfig?"></a></h3>
<h4class="anchor anchorWithStickyNavbar_JmGV"id="defined-in-12">Defined in<ahref="#defined-in-12"class="hash-link"aria-label="Direct link to Defined in"title="Direct link to Defined in"></a></h4>
<h3class="anchor anchorWithStickyNavbar_JmGV"id="hostname">Hostname?<ahref="#hostname"class="hash-link"aria-label="Direct link to Hostname?"title="Direct link to Hostname?"></a></h3>
<h4class="anchor anchorWithStickyNavbar_JmGV"id="defined-in-13">Defined in<ahref="#defined-in-13"class="hash-link"aria-label="Direct link to Defined in"title="Direct link to Defined in"></a></h4>
<h3class="anchor anchorWithStickyNavbar_JmGV"id="image">Image?<ahref="#image"class="hash-link"aria-label="Direct link to Image?"title="Direct link to Image?"></a></h3>
<h4class="anchor anchorWithStickyNavbar_JmGV"id="defined-in-14">Defined in<ahref="#defined-in-14"class="hash-link"aria-label="Direct link to Defined in"title="Direct link to Defined in"></a></h4>
<h3class="anchor anchorWithStickyNavbar_JmGV"id="labels">Labels?<ahref="#labels"class="hash-link"aria-label="Direct link to Labels?"title="Direct link to Labels?"></a></h3>
<h4class="anchor anchorWithStickyNavbar_JmGV"id="index-signature-1">Index Signature<ahref="#index-signature-1"class="hash-link"aria-label="Direct link to Index Signature"title="Direct link to Index Signature"></a></h4>
<h4class="anchor anchorWithStickyNavbar_JmGV"id="defined-in-15">Defined in<ahref="#defined-in-15"class="hash-link"aria-label="Direct link to Defined in"title="Direct link to Defined in"></a></h4>
<h3class="anchor anchorWithStickyNavbar_JmGV"id="macaddress">MacAddress?<ahref="#macaddress"class="hash-link"aria-label="Direct link to MacAddress?"title="Direct link to MacAddress?"></a></h3>
<h4class="anchor anchorWithStickyNavbar_JmGV"id="defined-in-16">Defined in<ahref="#defined-in-16"class="hash-link"aria-label="Direct link to Defined in"title="Direct link to Defined in"></a></h4>
<h3class="anchor anchorWithStickyNavbar_JmGV"id="networkconfig">NetworkConfig?<ahref="#networkconfig"class="hash-link"aria-label="Direct link to NetworkConfig?"title="Direct link to NetworkConfig?"></a></h3>
<h4class="anchor anchorWithStickyNavbar_JmGV"id="defined-in-17">Defined in<ahref="#defined-in-17"class="hash-link"aria-label="Direct link to Defined in"title="Direct link to Defined in"></a></h4>
<h3class="anchor anchorWithStickyNavbar_JmGV"id="networkdisabled">NetworkDisabled?<ahref="#networkdisabled"class="hash-link"aria-label="Direct link to NetworkDisabled?"title="Direct link to NetworkDisabled?"></a></h3>
<h4class="anchor anchorWithStickyNavbar_JmGV"id="defined-in-18">Defined in<ahref="#defined-in-18"class="hash-link"aria-label="Direct link to Defined in"title="Direct link to Defined in"></a></h4>
<h3class="anchor anchorWithStickyNavbar_JmGV"id="onbuild">OnBuild?<ahref="#onbuild"class="hash-link"aria-label="Direct link to OnBuild?"title="Direct link to OnBuild?"></a></h3>
<h4class="anchor anchorWithStickyNavbar_JmGV"id="defined-in-19">Defined in<ahref="#defined-in-19"class="hash-link"aria-label="Direct link to Defined in"title="Direct link to Defined in"></a></h4>
<h3class="anchor anchorWithStickyNavbar_JmGV"id="openstdin">OpenStdin?<ahref="#openstdin"class="hash-link"aria-label="Direct link to OpenStdin?"title="Direct link to OpenStdin?"></a></h3>
<h4class="anchor anchorWithStickyNavbar_JmGV"id="defined-in-20">Defined in<ahref="#defined-in-20"class="hash-link"aria-label="Direct link to Defined in"title="Direct link to Defined in"></a></h4>
<h3class="anchor anchorWithStickyNavbar_JmGV"id="shell">Shell?<ahref="#shell"class="hash-link"aria-label="Direct link to Shell?"title="Direct link to Shell?"></a></h3>
<h4class="anchor anchorWithStickyNavbar_JmGV"id="defined-in-21">Defined in<ahref="#defined-in-21"class="hash-link"aria-label="Direct link to Defined in"title="Direct link to Defined in"></a></h4>
<h3class="anchor anchorWithStickyNavbar_JmGV"id="stdinonce">StdinOnce?<ahref="#stdinonce"class="hash-link"aria-label="Direct link to StdinOnce?"title="Direct link to StdinOnce?"></a></h3>
<h4class="anchor anchorWithStickyNavbar_JmGV"id="defined-in-22">Defined in<ahref="#defined-in-22"class="hash-link"aria-label="Direct link to Defined in"title="Direct link to Defined in"></a></h4>
<h3class="anchor anchorWithStickyNavbar_JmGV"id="stopsignal">StopSignal?<ahref="#stopsignal"class="hash-link"aria-label="Direct link to StopSignal?"title="Direct link to StopSignal?"></a></h3>
<h4class="anchor anchorWithStickyNavbar_JmGV"id="defined-in-23">Defined in<ahref="#defined-in-23"class="hash-link"aria-label="Direct link to Defined in"title="Direct link to Defined in"></a></h4>
<h3class="anchor anchorWithStickyNavbar_JmGV"id="stoptimeout">StopTimeout?<ahref="#stoptimeout"class="hash-link"aria-label="Direct link to StopTimeout?"title="Direct link to StopTimeout?"></a></h3>
<h4class="anchor anchorWithStickyNavbar_JmGV"id="defined-in-24">Defined in<ahref="#defined-in-24"class="hash-link"aria-label="Direct link to Defined in"title="Direct link to Defined in"></a></h4>
<h3class="anchor anchorWithStickyNavbar_JmGV"id="tty">Tty?<ahref="#tty"class="hash-link"aria-label="Direct link to Tty?"title="Direct link to Tty?"></a></h3>
<h4class="anchor anchorWithStickyNavbar_JmGV"id="defined-in-25">Defined in<ahref="#defined-in-25"class="hash-link"aria-label="Direct link to Defined in"title="Direct link to Defined in"></a></h4>
<h3class="anchor anchorWithStickyNavbar_JmGV"id="user">User?<ahref="#user"class="hash-link"aria-label="Direct link to User?"title="Direct link to User?"></a></h3>
<h4class="anchor anchorWithStickyNavbar_JmGV"id="defined-in-26">Defined in<ahref="#defined-in-26"class="hash-link"aria-label="Direct link to Defined in"title="Direct link to Defined in"></a></h4>
<h3class="anchor anchorWithStickyNavbar_JmGV"id="volumes">Volumes?<ahref="#volumes"class="hash-link"aria-label="Direct link to Volumes?"title="Direct link to Volumes?"></a></h3>
<h4class="anchor anchorWithStickyNavbar_JmGV"id="index-signature-2">Index Signature<ahref="#index-signature-2"class="hash-link"aria-label="Direct link to Index Signature"title="Direct link to Index Signature"></a></h4>
<h4class="anchor anchorWithStickyNavbar_JmGV"id="defined-in-27">Defined in<ahref="#defined-in-27"class="hash-link"aria-label="Direct link to Defined in"title="Direct link to Defined in"></a></h4>
<h3class="anchor anchorWithStickyNavbar_JmGV"id="workingdir">WorkingDir?<ahref="#workingdir"class="hash-link"aria-label="Direct link to WorkingDir?"title="Direct link to WorkingDir?"></a></h3>
<h4class="anchor anchorWithStickyNavbar_JmGV"id="defined-in-28">Defined in<ahref="#defined-in-28"class="hash-link"aria-label="Direct link to Defined in"title="Direct link to Defined in"></a></h4>
<h3class="anchor anchorWithStickyNavbar_JmGV"id="name">name?<ahref="#name"class="hash-link"aria-label="Direct link to name?"title="Direct link to name?"></a></h3>
<p>Assign the specified name to the container. Must match the regular expression<code>/?[a-zA-Z0-9][a-zA-Z0-9_.-]+</code>. If not speficied, the platform assigns a unique name to the container</p>
<h4class="anchor anchorWithStickyNavbar_JmGV"id="defined-in-29">Defined in<ahref="#defined-in-29"class="hash-link"aria-label="Direct link to Defined in"title="Direct link to Defined in"></a></h4>
<h3class="anchor anchorWithStickyNavbar_JmGV"id="platform">platform?<ahref="#platform"class="hash-link"aria-label="Direct link to platform?"title="Direct link to platform?"></a></h3>
<p>Platform in the format <code>os[/arch[/variant]]</code> used for image lookup.</p>
<p>When specified, the daemon checks if the requested image is present in the local image cache with the given OS and Architecture, and otherwise returns a <code>404</code> status.</p>
<p>If the option is not set, the host's native OS and Architecture are used to look up the image in the image cache. However, if no platform is passed and the given image does exist in the local image cache, but its OS or architecture does not match, the container is created with the available image, and a warning is added to the <code>Warnings</code> field in the response, for example;</p>
<divclass="codeBlockContainer_mQmQ theme-code-block"style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><divclass="codeBlockContent_D5yF"><pretabindex="0"class="prism-code language-text codeBlock_RMoD thin-scrollbar"style="color:#F8F8F2;background-color:#282A36"><codeclass="codeBlockLines_AclH"><spanclass="token-line"style="color:#F8F8F2"><spanclass="token plain">WARNING: The requested image's platform (linux/arm64/v8) does not</span><br></span><spanclass="token-line"style="color:#F8F8F2"><spanclass="token plain"> match the detected host platform (linux/amd64) and no</span><br></span><spanclass="token-line"style="color:#F8F8F2"><spanclass="token plain"> specific platform was requested</span><br></span></code></pre><divclass="buttonGroup_aaMX"><buttontype="button"aria-label="Copy code to clipboard"title="Copy"class="clean-btn"><spanclass="copyButtonIcons_z5j7"aria-hidden="true"><svgviewBox="0 0 24 24"class="copyButtonIcon_FoOz"><pathfill="currentColor"d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svgviewBox="0 0 24 24"class="copyButtonSuccessIcon_L0B6"><pathfill="currentColor"d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
<h4class="anchor anchorWithStickyNavbar_JmGV"id="defined-in-30">Defined in<ahref="#defined-in-30"class="hash-link"aria-label="Direct link to Defined in"title="Direct link to Defined in"></a></h4>
<h3class="anchor anchorWithStickyNavbar_JmGV"id="pod">pod?<ahref="#pod"class="hash-link"aria-label="Direct link to pod?"title="Direct link to pod?"></a></h3>
<h4class="anchor anchorWithStickyNavbar_JmGV"id="defined-in-31">Defined in<ahref="#defined-in-31"class="hash-link"aria-label="Direct link to Defined in"title="Direct link to Defined in"></a></h4>
<h3class="anchor anchorWithStickyNavbar_JmGV"id="start">start?<ahref="#start"class="hash-link"aria-label="Direct link to start?"title="Direct link to start?"></a></h3>
<h4class="anchor anchorWithStickyNavbar_JmGV"id="defined-in-32">Defined in<ahref="#defined-in-32"class="hash-link"aria-label="Direct link to Defined in"title="Direct link to Defined in"></a></h4>