http package - net/http

<!DOCTYPE html> <html lang="en" data-layout="responsive" data-local=""> <head> <script> window.addEventListener('error', window.__err=function f(e){f.p=f.p||[];f.p.push(e)}); </script> <script> (function() { const theme = document.cookie.match(/prefers-color-scheme=(light|dark|auto)/)?.[1] if (theme) { document.querySelector('html').setAttribute('data-theme', theme); } }()) </script> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="Description" content="Package http provides HTTP client and server implementations."> <meta class="js-gtmID" data-gtmid="GTM-W8MVQXG"> <link rel="shortcut icon" href="/static/shared/icon/favicon.ico"> <link rel="canonical" href="https://pkg.go.dev/net/http"> <link href="/static/frontend/frontend.min.css?version=prod-frontend-00098-h5t" rel="stylesheet"> <link rel="search" type="application/opensearchdescription+xml" href="/opensearch.xml" title="Go Packages"> <title>http package - net/http - Go Packages</title> <link href="/static/frontend/unit/unit.min.css?version=prod-frontend-00098-h5t" rel="stylesheet"> <link href="/static/frontend/unit/main/main.min.css?version=prod-frontend-00098-h5t" rel="stylesheet"> </head> <body> <script> function loadScript(src, mod = true) { let s = document.createElement('script'); s.src = src; if (mod) { s.type = 'module'; s.async = true; s.defer = true } document.head.appendChild(s); } loadScript("/third_party/dialog-polyfill/dialog-polyfill.js", false) loadScript("/static/frontend/frontend.js"); </script> <header class="go-Header go-Header--full js-siteHeader"> <div class="go-Header-inner go-Header-inner--dark"> <nav class="go-Header-nav"> <a href="https://go.dev/" class="js-headerLogo" data-gtmc="nav link" data-test-id="go-header-logo-link" role="heading" aria-level="1"> <img class="go-Header-logo" src="/static/shared/logo/go-white.svg" alt="Go"> </a> <div class="skip-navigation-wrapper"> <a class="skip-to-content-link" aria-label="Skip to main content" href="#main-content"> Skip to Main Content </a> </div> <div class="go-Header-rightContent"> <div class="go-SearchForm js-searchForm"> <form class="go-InputGroup go-ShortcutKey go-SearchForm-form" action="/search" data-shortcut="/" data-shortcut-alt="search" data-gtmc="search form" aria-label="Search for a package" role="search" > <input name="q" class="go-Input js-searchFocus" aria-label="Search for a package" type="search" autocapitalize="off" autocomplete="off" autocorrect="off" spellcheck="false" placeholder="Search packages or symbols" value="" /> <input name="m" value="" hidden> <button class="go-Button go-Button--inverted" aria-label="Submit search"> <img class="go-Icon" height="24" width="24" src="/static/shared/icon/search_gm_grey_24dp.svg" alt="" /> </button> </form> <button class="go-SearchForm-expandSearch js-expandSearch" data-gtmc="nav button" aria-label="Open search" data-test-id="expand-search"> <img class="go-Icon go-Icon--inverted" height="24" width="24" src="/static/shared/icon/search_gm_grey_24dp.svg" alt=""> </button> </div> <ul class="go-Header-menu"> <li class="go-Header-menuItem"> <a class="js-desktop-menu-hover" href="#" data-gtmc="nav link"> Why Go <img class="go-Icon" height="24" width="24" src="/static/shared/icon/arrow_drop_down_gm_grey_24dp.svg" alt="submenu dropdown icon"> </a> <ul class="go-Header-submenu go-Header-submenu--why js-desktop-submenu-hover" aria-label="submenu"> <li class="go-Header-submenuItem"> <div> <a href="https://go.dev/solutions#case-studies"> <span>Case Studies</span> </a> </div> <p>Common problems companies solve with Go</p> </li> <li class="go-Header-submenuItem"> <div> <a href="https://go.dev/solutions#use-cases"> <span>Use Cases</span> </a> </div> <p>Stories about how and why companies use Go</p> </li> <li class="go-Header-submenuItem"> <div> <a href="https://go.dev/security/"> <span>Security</span> </a> </div> <p>How Go can help keep you secure by default</p> </li> </ul> </li> <li class="go-Header-menuItem"> <a href="https://go.dev/learn/" data-gtmc="nav link">Learn</a> </li> <li class="go-Header-menuItem"> <a class="js-desktop-menu-hover" href="#" data-gtmc="nav link"> Docs <img class="go-Icon" height="24" width="24" src="/static/shared/icon/arrow_drop_down_gm_grey_24dp.svg" alt="submenu dropdown icon"> </a> <ul class="go-Header-submenu go-Header-submenu--docs js-desktop-submenu-hover" aria-label="submenu"> <li class="go-Header-submenuItem"> <div> <a href="https://go.dev/doc/effective_go"> <span>Effective Go</span> </a> </div> <p>Tips for writing clear, performant, and idiomatic Go code</p> </li> <li class="go-Header-submenuItem"> <div> <a href="https://go.dev/doc/"> <span>Go User Manual</span> </a> </div> <p>A complete introduction to building software with Go</p> </li> <li class="go-Header-submenuItem"> <div> <a href="https://pkg.go.dev/std"> <span>Standard library</span> </a> </div> <p>Reference documentation for Go's standard library</p> </li> <li class="go-Header-submenuItem"> <div> <a href="https://go.dev/doc/devel/release"> <span>Release Notes</span> </a> </div> <p>Learn what's new in each Go release</p> </li> </ul> </li> <li class="go-Header-menuItem go-Header-menuItem--active"> <a href="/" data-gtmc="nav link">Packages</a> </li> <li class="go-Header-menuItem"> <a class="js-desktop-menu-hover" href="#" data-gtmc="nav link"> Community <img class="go-Icon" height="24" width="24" src="/static/shared/icon/arrow_drop_down_gm_grey_24dp.svg" alt="submenu dropdown icon"> </a> <ul class="go-Header-submenu go-Header-submenu--community js-desktop-submenu-hover" aria-label="submenu"> <li class="go-Header-submenuItem"> <div> <a href="https://go.dev/talks/"> <span>Recorded Talks</span> </a> </div> <p>Videos from prior events</p> </li> <li class="go-Header-submenuItem"> <div> <a href="https://www.meetup.com/pro/go"> <span>Meetups</span> <i class="material-icons"> <img class="go-Icon" height="24" width="24" src="/static/shared/icon/launch_gm_grey_24dp.svg" alt=""> </i> </a> </div> <p>Meet other local Go developers</p> </li> <li class="go-Header-submenuItem"> <div> <a href="https://github.com/golang/go/wiki/Conferences"> <span>Conferences</span> <i class="material-icons"> <img class="go-Icon" height="24" width="24" src="/static/shared/icon/launch_gm_grey_24dp.svg" alt=""> </i> </a> </div> <p>Learn and network with Go developers from around the world</p> </li> <li class="go-Header-submenuItem"> <div> <a href="https://go.dev/blog"> <span>Go blog</span> </a> </div> <p>The Go project's official blog.</p> </li> <li class="go-Header-submenuItem"> <div> <a href="https://go.dev/help"> <span>Go project</span> </a> </div> <p>Get help and stay informed from Go</p> </li> <li class="go-Header-submenuItem"> <div> Get connected </div> <p></p> <div class="go-Header-socialIcons"> <a class="go-Header-socialIcon" aria-label="Get connected with google-groups (Opens in new window)" title="Get connected with google-groups (Opens in new window)" href="https://groups.google.com/g/golang-nuts"> <img src="/static/shared/logo/social/google-groups.svg" /> </a> <a class="go-Header-socialIcon" aria-label="Get connected with github (Opens in new window)" title="Get connected with github (Opens in new window)" href="https://github.com/golang"> <img src="/static/shared/logo/social/github.svg" /> </a> <a class="go-Header-socialIcon" aria-label="Get connected with twitter (Opens in new window)" title="Get connected with twitter (Opens in new window)" href="https://twitter.com/golang"> <img src="/static/shared/logo/social/twitter.svg" /> </a> <a class="go-Header-socialIcon" aria-label="Get connected with reddit (Opens in new window)" title="Get connected with reddit (Opens in new window)" href="https://www.reddit.com/r/golang/"> <img src="/static/shared/logo/social/reddit.svg" /> </a> <a class="go-Header-socialIcon" aria-label="Get connected with slack (Opens in new window)" title="Get connected with slack (Opens in new window)" href="https://invite.slack.golangbridge.org/"> <img src="/static/shared/logo/social/slack.svg" /> </a> <a class="go-Header-socialIcon" aria-label="Get connected with stack-overflow (Opens in new window)" title="" href="https://stackoverflow.com/collectives/go"> <img src="/static/shared/logo/social/stack-overflow.svg" /> </a> </div> </li> </ul> </li> </ul> <button class="go-Header-navOpen js-headerMenuButton go-Header-navOpen--white" data-gtmc="nav button" aria-label="Open navigation"> </button> </div> </nav> </div> </header> <aside class="go-NavigationDrawer js-header"> <nav class="go-NavigationDrawer-nav"> <div class="go-NavigationDrawer-header"> <a href="https://go.dev/"> <img class="go-NavigationDrawer-logo" src="/static/shared/logo/go-blue.svg" alt="Go."> </a> </div> <ul class="go-NavigationDrawer-list"> <li class="go-NavigationDrawer-listItem js-mobile-subnav-trigger go-NavigationDrawer-hasSubnav"> <a href="#"> <span>Why Go</span> <i class="material-icons"> <img class="go-Icon" height="24" width="24" src="/static/shared/icon/navigate_next_gm_grey_24dp.svg" alt=""> </i> </a> <div class="go-NavigationDrawer go-NavigationDrawer-submenuItem"> <div class="go-NavigationDrawer-nav"> <div class="go-NavigationDrawer-header"> <a href="#"> <i class="material-icons"> <img class="go-Icon" height="24" width="24" src="/static/shared/icon/navigate_before_gm_grey_24dp.svg" alt=""> </i> Why Go </a> </div> <ul class="go-NavigationDrawer-list"> <li class="go-NavigationDrawer-listItem"> <a href="https://go.dev/solutions#case-studies"> Case Studies </a> </li> <li class="go-NavigationDrawer-listItem"> <a href="https://go.dev/solutions#use-cases"> Use Cases </a> </li> <li class="go-NavigationDrawer-listItem"> <a href="https://go.dev/security/"> Security </a> </li> </ul> </div> </div> </li> <li class="go-NavigationDrawer-listItem"> <a href="https://go.dev/learn/">Learn</a> </li> <li class="go-NavigationDrawer-listItem js-mobile-subnav-trigger go-NavigationDrawer-hasSubnav"> <a href="#"> <span>Docs</span> <i class="material-icons"> <img class="go-Icon" height="24" width="24" src="/static/shared/icon/navigate_next_gm_grey_24dp.svg" alt=""> </i> </a> <div class="go-NavigationDrawer go-NavigationDrawer-submenuItem"> <div class="go-NavigationDrawer-nav"> <div class="go-NavigationDrawer-header"> <a href="#"><i class="material-icons"> <img class="go-Icon" height="24" width="24" src="/static/shared/icon/navigate_before_gm_grey_24dp.svg" alt=""> </i> Docs </a> </div> <ul class="go-NavigationDrawer-list"> <li class="go-NavigationDrawer-listItem"> <a href="https://go.dev/doc/effective_go"> Effective Go </a> </li> <li class="go-NavigationDrawer-listItem"> <a href="https://go.dev/doc/"> Go User Manual </a> </li> <li class="go-NavigationDrawer-listItem"> <a href="https://pkg.go.dev/std"> Standard library </a> </li> <li class="go-NavigationDrawer-listItem"> <a href="https://go.dev/doc/devel/release"> Release Notes </a> </li> </ul> </div> </div> </li> <li class="go-NavigationDrawer-listItem go-NavigationDrawer-listItem--active"> <a href="/">Packages</a> </li> <li class="go-NavigationDrawer-listItem js-mobile-subnav-trigger go-NavigationDrawer-hasSubnav"> <a href="#"> <span>Community</span> <i class="material-icons"> <img class="go-Icon" height="24" width="24" src="/static/shared/icon/navigate_next_gm_grey_24dp.svg" alt=""> </i> </a> <div class="go-NavigationDrawer go-NavigationDrawer-submenuItem"> <div class="go-NavigationDrawer-nav"> <div class="go-NavigationDrawer-header"> <a href="#"> <i class="material-icons"> <img class="go-Icon" height="24" width="24" src="/static/shared/icon/navigate_before_gm_grey_24dp.svg" alt=""> </i> Community </a> </div> <ul class="go-NavigationDrawer-list"> <li class="go-NavigationDrawer-listItem"> <a href="https://go.dev/talks/"> Recorded Talks </a> </li> <li class="go-NavigationDrawer-listItem"> <a href="https://www.meetup.com/pro/go"> Meetups <i class="material-icons"> <img class="go-Icon" height="24" width="24" src="/static/shared/icon/launch_gm_grey_24dp.svg" alt=""> </i> </a> </li> <li class="go-NavigationDrawer-listItem"> <a href="https://github.com/golang/go/wiki/Conferences"> Conferences <i class="material-icons"> <img class="go-Icon" height="24" width="24" src="/static/shared/icon/launch_gm_grey_24dp.svg" alt=""> </i> </a> </li> <li class="go-NavigationDrawer-listItem"> <a href="https://go.dev/blog"> Go blog </a> </li> <li class="go-NavigationDrawer-listItem"> <a href="https://go.dev/help"> Go project </a> </li> <li class="go-NavigationDrawer-listItem"> <div>Get connected</div> <div class="go-Header-socialIcons"> <a class="go-Header-socialIcon" href="https://groups.google.com/g/golang-nuts"><img src="/static/shared/logo/social/google-groups.svg" /></a> <a class="go-Header-socialIcon" href="https://github.com/golang"><img src="/static/shared/logo/social/github.svg" /></a> <a class="go-Header-socialIcon" href="https://twitter.com/golang"><img src="/static/shared/logo/social/twitter.svg" /></a> <a class="go-Header-socialIcon" href="https://www.reddit.com/r/golang/"><img src="/static/shared/logo/social/reddit.svg" /></a> <a class="go-Header-socialIcon" href="https://invite.slack.golangbridge.org/"><img src="/static/shared/logo/social/slack.svg" /></a> <a class="go-Header-socialIcon" href="https://stackoverflow.com/collectives/go"><img src="/static/shared/logo/social/stack-overflow.svg" /></a> </div> </li> </ul> </div> </div> </li> </ul> </nav> </aside> <div class="go-NavigationDrawer-scrim js-scrim" role="presentation"></div> <main class="go-Main" id="main-content"> <div class="go-Main-banner" role="alert"></div> <header class="go-Main-header js-mainHeader"> <nav class="go-Main-headerBreadcrumb go-Breadcrumb" aria-label="Breadcrumb" data-test-id="UnitHeader-breadcrumb"> <ol> <li data-test-id="UnitHeader-breadcrumbItem"> <a href="/" data-gtmc="breadcrumb link">Discover Packages</a> </li> <li data-test-id="UnitHeader-breadcrumbItem"> <a href="/std" data-gtmc="breadcrumb link">Standard library</a> </li> <li data-test-id="UnitHeader-breadcrumbItem"> <a href="/net" data-gtmc="breadcrumb link">net</a> </li> <li> <a href="/net/http@go1.24.2" data-gtmc="breadcrumb link" aria-current="location" data-test-id="UnitHeader-breadcrumbCurrent"> http </a> <button class="go-Button go-Button--inline go-Clipboard js-clipboard" title="Copy path to clipboard.

net/http" aria-label="Copy Path to Clipboard" data-to-copy="net/http" data-gtmc="breadcrumbs button" > <img class="go-Icon go-Icon--accented" height="24" width="24" src="/static/shared/icon/content_copy_gm_grey_24dp.svg" alt="" > </button> </li> </ol> </nav> <div class="go-Main-headerContent"> <div class="go-Main-headerTitle js-stickyHeader"> <a class="go-Main-headerLogo" href="https://go.dev/" aria-hidden="true" tabindex="-1" data-gtmc="header link" aria-label="Link to Go Homepage"> <img height="78" width="207" src="/static/shared/logo/go-blue.svg" alt="Go"> </a> <h1 class="UnitHeader-titleHeading" data-test-id="UnitHeader-title">http</h1> <span class="go-Chip go-Chip--inverted">package</span> <span class="go-Chip go-Chip--inverted">standard library</span> <button class="go-Button go-Button--inline go-Clipboard js-clipboard" title="Copy path to clipboard.

net/http" aria-label="Copy Path to Clipboard" data-to-copy="net/http" data-gtmc="title button" tabindex="-1" > <img class="go-Icon go-Icon--accented" height="24" width="24" src="/static/shared/icon/content_copy_gm_grey_24dp.svg" alt="" /> </button> </div> <div class="go-Main-headerDetails"> <span class="go-Main-headerDetailItem" data-test-id="UnitHeader-version"> <a href="?tab=versions" aria-label="Version: go1.24.2" data-gtmc="header link" aria-describedby="version-description"> <span class="go-textSubtle" aria-hidden="true">Version: </span> go1.24.2 </a> <div class="screen-reader-only" id="version-description" hidden> Opens a new window with list of versions in this module. </div> <span class="DetailsHeader-badge--latest" data-test-id="UnitHeader-minorVersionBanner"> <span class="go-Chip DetailsHeader-span--latest">Latest</span> <span class="go-Chip DetailsHeader-span--notAtLatest"> Latest <details class="go-Tooltip js-tooltip" data-gtmc="tooltip"> <summary> <img class="go-Icon go-Icon--inverted" height="24" width="24" src="/static/shared/icon/alert_gm_grey_24dp.svg" alt="Warning"> </summary> <p>This package is not in the latest version of its module.</p> </details> </span> <a href="/net/http" aria-label="Go to Latest Version" data-gtmc="header link"> <span class="go-Chip go-Chip--alert DetailsHeader-span--goToLatest">Go to latest</span> </a> </span> </span> <span class="go-Main-headerDetailItem" data-test-id="UnitHeader-commitTime"> Published: Apr 1, 2025 </span> <span class="go-Main-headerDetailItem" data-test-id="UnitHeader-licenses"> License: <a href="/net/http?tab=licenses" data-test-id="UnitHeader-license" data-gtmc="header link" aria-describedby="license-description">BSD-3-Clause</a> </span> <div class="screen-reader-only" id="license-description" hidden> Opens a new window with license information. </div> <span class="go-Main-headerDetailItem" data-test-id="UnitHeader-imports"> <a href="/net/http?tab=imports" aria-label="Imports: 46" data-gtmc="header link" aria-describedby="imports-description"> <span class="go-textSubtle">Imports: </span>46 </a> </span> <div class="screen-reader-only" id="imports-description" hidden> Opens a new window with list of imports. </div> <span class="go-Main-headerDetailItem" data-test-id="UnitHeader-importedby"> <a href="/net/http?tab=importedby" aria-label="Imported By: 1,596,376" data-gtmc="header link" aria-describedby="importedby-description"> <span class="go-textSubtle">Imported by: </span>1,596,376 </a> </span> <div class="screen-reader-only" id="importedby-description" hidden> Opens a new window with list of known importers. </div> </div> <div class="UnitHeader-overflowContainer"> <svg class="UnitHeader-overflowImage" xmlns="http://www.w3.org/2000/svg" height="24" viewBox="0 0 24 24" width="24"> <path d="M0 0h24v24H0z" fill="none"/> <path d="M12 8c1.1 0 2-.9 2-2s-.9-2-2-2-2 .9-2 2 .9 2 2 2zm0 2c-1.1 0-2 .9-2 2s.9 2 2 2 2-.9 2-2-.9-2-2-2zm0 6c-1.1 0-2 .9-2 2s.9 2 2 2 2-.9 2-2-.9-2-2-2z"/> </svg> <select class="UnitHeader-overflowSelect js-selectNav" tabindex="-1"> <option value="/">Main</option> <option value="/net/http?tab=versions"> Versions </option> <option value="/net/http?tab=licenses"> Licenses </option> <option value="/net/http?tab=imports"> Imports </option> <option value="/net/http?tab=importedby"> Imported By </option> </select> </div> </div> </header> <aside class="go-Main-aside js-mainAside"> <div class="UnitMeta"> <h2 class="go-textLabel">Details</h2> <ul class="UnitMeta-details"> <li> <details class="go-Tooltip js-tooltip" data-gtmc="tooltip"> <summary class="go-textSubtle"> <img class="go-Icon go-Icon--accented" tabindex="0" role="button"src="/static/shared/icon/check_circle_gm_grey_24dp.svg" alt="checked" aria-label="Valid file, toggle tooltip"height="24" width="24"> Valid <a href="https://cs.opensource.google/go/go/+/go1.24.2:src/go.mod" target="_blank" rel="noopener">go.mod</a> file <img class="go-Icon" role="button" tabindex="0" src="/static/shared/icon/help_gm_grey_24dp.svg" alt="" aria-label="Toggle go.mod validity tooltip" height="24" width="24"> </summary> <p aria-live="polite" role="tooltip"> The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go. </p> </details> </li> <li> <details class="go-Tooltip js-tooltip" data-gtmc="tooltip"> <summary class="go-textSubtle"> <img class="go-Icon go-Icon--accented" tabindex="0" role="button"src="/static/shared/icon/check_circle_gm_grey_24dp.svg" alt="checked" aria-label="Valid file, toggle tooltip"height="24" width="24"> Redistributable license <img class="go-Icon" role="button" tabindex="0" src="/static/shared/icon/help_gm_grey_24dp.svg" alt="" aria-label="Toggle redistributable help tooltip" height="24" width="24"> </summary> <p aria-live="polite" role="tooltip"> Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed. </p> </details> </li> <li> <details class="go-Tooltip js-tooltip" data-gtmc="tooltip"> <summary class="go-textSubtle"> <img class="go-Icon go-Icon--accented" tabindex="0" role="button"src="/static/shared/icon/check_circle_gm_grey_24dp.svg" alt="checked" aria-label="Valid file, toggle tooltip"height="24" width="24"> Tagged version <img class="go-Icon" role="button" tabindex="0" src="/static/shared/icon/help_gm_grey_24dp.svg" alt="" aria-label="Toggle tagged version tooltip" height="24" width="24"> </summary> <p aria-live="polite" role="tooltip">Modules with tagged versions give importers more predictable builds.</p> </details> </li> <li> <details class="go-Tooltip js-tooltip" data-gtmc="tooltip"> <summary class="go-textSubtle"> <img class="go-Icon go-Icon--accented" tabindex="0" role="button"src="/static/shared/icon/check_circle_gm_grey_24dp.svg" alt="checked" aria-label="Valid file, toggle tooltip"height="24" width="24"> Stable version <img class="go-Icon" role="button" tabindex="0" aria-label="Toggle stable version tooltip" src="/static/shared/icon/help_gm_grey_24dp.svg" alt="" height="24" width="24"> </summary> <p aria-live="polite" role="tooltip">When a project reaches major version v1 it is considered stable.</p> </details> </li> <li class="UnitMeta-detailsLearn"> <a href="/about#best-practices" data-gtmc="meta link">Learn more about best practices</a> </li> </ul> <h2 class="go-textLabel">Repository</h2> <div class="UnitMeta-repo"> <a href="https://cs.opensource.google/go/go" title="https://cs.opensource.google/go/go" target="_blank" rel="noopener"> cs.opensource.google/go/go </a> </div> <h2 class="go-textLabel" data-test-id="links-heading">Links</h2> <ul class="UnitMeta-links"> <li> <a href="https://go.dev/security/policy" title="Report security issues in the Go standard library and sub-repositories"> <img class="go-Icon" height="24" width="24" src="/static/shared/icon/security_grey_24dp.svg" alt=""> Report a Vulnerability </a> </li> </ul> </div> </aside> <nav class="go-Main-nav go-Main-nav--sticky js-mainNav" aria-label="Outline"> <div class="go-Main-navDesktop"> <div class="UnitOutline-jumpTo"> <button class="UnitOutline-jumpToInput go-ShortcutKey js-jumpToInput" aria-controls="jump-to-modal" aria-label="Open Jump to Identifier" data-shortcut="f" data-shortcut-alt="find" data-test-id="jump-to-button" data-gtmc="outline button"> Jump to ... </button> </div> <ul class="go-Tree js-tree" role="tree" aria-label="Outline"> <li> <a href="#section-documentation" data-gtmc="outline link"> Documentation </a> <ul> <li> <a href="#pkg-overview" data-gtmc="doc outline link">Overview</a> </li> <li class="DocNav-overview"> <a href="#pkg-index" data-gtmc="doc outline link"> Index </a> <ul> <li> <a href="#pkg-examples" data-gtmc="doc outline link"> Examples </a> </li> </ul> </li> <li class="DocNav-constants"> <a href="#pkg-constants" data-gtmc="doc outline link"> Constants </a> </li> <li class="DocNav-variables"> <a href="#pkg-variables" data-gtmc="doc outline link"> Variables </a> </li> <li class="DocNav-functions"> <a href="#pkg-functions" data-gtmc="doc outline link"> Functions </a> <ul> <li> <a href="#CanonicalHeaderKey" title="CanonicalHeaderKey(s)" data-gtmc="doc outline link"> CanonicalHeaderKey(s) </a> </li> <li> <a href="#DetectContentType" title="DetectContentType(data)" data-gtmc="doc outline link"> DetectContentType(data) </a> </li> <li> <a href="#Error" title="Error(w, error, code)" data-gtmc="doc outline link"> Error(w, error, code) </a> </li> <li> <a href="#Handle" title="Handle(pattern, handler)" data-gtmc="doc outline link"> Handle(pattern, handler) </a> </li> <li> <a href="#HandleFunc" title="HandleFunc(pattern, handler)" data-gtmc="doc outline link"> HandleFunc(pattern, handler) </a> </li> <li> <a href="#ListenAndServe" title="ListenAndServe(addr, handler)" data-gtmc="doc outline link"> ListenAndServe(addr, handler) </a> </li> <li> <a href="#ListenAndServeTLS" title="ListenAndServeTLS(addr, certFile, keyFile, handler)" data-gtmc="doc outline link"> ListenAndServeTLS(addr, certFile, keyFile, handler) </a> </li> <li> <a href="#MaxBytesReader" title="MaxBytesReader(w, r, n)" data-gtmc="doc outline link"> MaxBytesReader(w, r, n) </a> </li> <li> <a href="#NotFound" title="NotFound(w, r)" data-gtmc="doc outline link"> NotFound(w, r) </a> </li> <li> <a href="#ParseHTTPVersion" title="ParseHTTPVersion(vers)" data-gtmc="doc outline link"> ParseHTTPVersion(vers) </a> </li> <li> <a href="#ParseTime" title="ParseTime(text)" data-gtmc="doc outline link"> ParseTime(text) </a> </li> <li> <a href="#ProxyFromEnvironment" title="ProxyFromEnvironment(req)" data-gtmc="doc outline link"> ProxyFromEnvironment(req) </a> </li> <li> <a href="#ProxyURL" title="ProxyURL(fixedURL)" data-gtmc="doc outline link"> ProxyURL(fixedURL) </a> </li> <li> <a href="#Redirect" title="Redirect(w, r, url, code)" data-gtmc="doc outline link"> Redirect(w, r, url, code) </a> </li> <li> <a href="#Serve" title="Serve(l, handler)" data-gtmc="doc outline link"> Serve(l, handler) </a> </li> <li> <a href="#ServeContent" title="ServeContent(w, req, name, modtime, content)" data-gtmc="doc outline link"> ServeContent(w, req, name, modtime, content) </a> </li> <li> <a href="#ServeFile" title="ServeFile(w, r, name)" data-gtmc="doc outline link"> ServeFile(w, r, name) </a> </li> <li> <a href="#ServeFileFS" title="ServeFileFS(w, r, fsys, name)" data-gtmc="doc outline link"> ServeFileFS(w, r, fsys, name) </a> </li> <li> <a href="#ServeTLS" title="ServeTLS(l, handler, certFile, keyFile)" data-gtmc="doc outline link"> ServeTLS(l, handler, certFile, keyFile) </a> </li> <li> <a href="#SetCookie" title="SetCookie(w, cookie)" data-gtmc="doc outline link"> SetCookie(w, cookie) </a> </li> <li> <a href="#StatusText" title="StatusText(code)" data-gtmc="doc outline link"> StatusText(code) </a> </li> </ul> </li> <li class="DocNav-types"> <a href="#pkg-types" data-gtmc="doc outline link"> Types </a> <ul> <li> <a href="#Client" title="type Client" data-gtmc="doc outline link"> type Client </a> <ul> <li> <a href="#Client.CloseIdleConnections" title="(c) CloseIdleConnections()" data-gtmc="doc outline link"> (c) CloseIdleConnections() </a> </li> <li> <a href="#Client.Do" title="(c) Do(req)" data-gtmc="doc outline link"> (c) Do(req) </a> </li> <li> <a href="#Client.Get" title="(c) Get(url)" data-gtmc="doc outline link"> (c) Get(url) </a> </li> <li> <a href="#Client.Head" title="(c) Head(url)" data-gtmc="doc outline link"> (c) Head(url) </a> </li> <li> <a href="#Client.Post" title="(c) Post(url, contentType, body)" data-gtmc="doc outline link"> (c) Post(url, contentType, body) </a> </li> <li> <a href="#Client.PostForm" title="(c) PostForm(url, data)" data-gtmc="doc outline link"> (c) PostForm(url, data) </a> </li> </ul> </li> <li> <a href="#CloseNotifier" title="type CloseNotifier" data-gtmc="doc outline link"> type CloseNotifier </a> </li> <li> <a href="#ConnState" title="type ConnState" data-gtmc="doc outline link"> type ConnState </a> <ul> <li> <a href="#ConnState.String" title="(c) String()" data-gtmc="doc outline link"> (c) String() </a> </li> </ul> </li> <li> <a href="#Cookie" title="type Cookie" data-gtmc="doc outline link"> type Cookie </a> <ul> <li> <a href="#ParseCookie" title="ParseCookie(line)" data-gtmc="doc outline link"> ParseCookie(line) </a> </li> <li> <a href="#ParseSetCookie" title="ParseSetCookie(line)" data-gtmc="doc outline link"> ParseSetCookie(line) </a> </li> <li> <a href="#Cookie.String" title="(c) String()" data-gtmc="doc outline link"> (c) String() </a> </li> <li> <a href="#Cookie.Valid" title="(c) Valid()" data-gtmc="doc outline link"> (c) Valid() </a> </li> </ul> </li> <li> <a href="#CookieJar" title="type CookieJar" data-gtmc="doc outline link"> type CookieJar </a> </li> <li> <a href="#Dir" title="type Dir" data-gtmc="doc outline link"> type Dir </a> <ul> <li> <a href="#Dir.Open" title="(d) Open(name)" data-gtmc="doc outline link"> (d) Open(name) </a> </li> </ul> </li> <li> <a href="#File" title="type File" data-gtmc="doc outline link"> type File </a> </li> <li> <a href="#FileSystem" title="type FileSystem" data-gtmc="doc outline link"> type FileSystem </a> <ul> <li> <a href="#FS" title="FS(fsys)" data-gtmc="doc outline link"> FS(fsys) </a> </li> </ul> </li> <li> <a href="#Flusher" title="type Flusher" data-gtmc="doc outline link"> type Flusher </a> </li> <li> <a href="#HTTP2Config" title="type HTTP2Config" data-gtmc="doc outline link"> type HTTP2Config </a> </li> <li> <a href="#Handler" title="type Handler" data-gtmc="doc outline link"> type Handler </a> <ul> <li> <a href="#AllowQuerySemicolons" title="AllowQuerySemicolons(h)" data-gtmc="doc outline link"> AllowQuerySemicolons(h) </a> </li> <li> <a href="#FileServer" title="FileServer(root)" data-gtmc="doc outline link"> FileServer(root) </a> </li> <li> <a href="#FileServerFS" title="FileServerFS(root)" data-gtmc="doc outline link"> FileServerFS(root) </a> </li> <li> <a href="#MaxBytesHandler" title="MaxBytesHandler(h, n)" data-gtmc="doc outline link"> MaxBytesHandler(h, n) </a> </li> <li> <a href="#NotFoundHandler" title="NotFoundHandler()" data-gtmc="doc outline link"> NotFoundHandler() </a> </li> <li> <a href="#RedirectHandler" title="RedirectHandler(url, code)" data-gtmc="doc outline link"> RedirectHandler(url, code) </a> </li> <li> <a href="#StripPrefix" title="StripPrefix(prefix, h)" data-gtmc="doc outline link"> StripPrefix(prefix, h) </a> </li> <li> <a href="#TimeoutHandler" title="TimeoutHandler(h, dt, msg)" data-gtmc="doc outline link"> TimeoutHandler(h, dt, msg) </a> </li> </ul> </li> <li> <a href="#HandlerFunc" title="type HandlerFunc" data-gtmc="doc outline link"> type HandlerFunc </a> <ul> <li> <a href="#HandlerFunc.ServeHTTP" title="(f) ServeHTTP(w, r)" data-gtmc="doc outline link"> (f) ServeHTTP(w, r) </a> </li> </ul> </li> <li> <a href="#Header" title="type Header" data-gtmc="doc outline link"> type Header </a> <ul> <li> <a href="#Header.Add" title="(h) Add(key, value)" data-gtmc="doc outline link"> (h) Add(key, value) </a> </li> <li> <a href="#Header.Clone" title="(h) Clone()" data-gtmc="doc outline link"> (h) Clone() </a> </li> <li> <a href="#Header.Del" title="(h) Del(key)" data-gtmc="doc outline link"> (h) Del(key) </a> </li> <li> <a href="#Header.Get" title="(h) Get(key)" data-gtmc="doc outline link"> (h) Get(key) </a> </li> <li> <a href="#Header.Set" title="(h) Set(key, value)" data-gtmc="doc outline link"> (h) Set(key, value) </a> </li> <li> <a href="#Header.Values" title="(h) Values(key)" data-gtmc="doc outline link"> (h) Values(key) </a> </li> <li> <a href="#Header.Write" title="(h) Write(w)" data-gtmc="doc outline link"> (h) Write(w) </a> </li> <li> <a href="#Header.WriteSubset" title="(h) WriteSubset(w, exclude)" data-gtmc="doc outline link"> (h) WriteSubset(w, exclude) </a> </li> </ul> </li> <li> <a href="#Hijacker" title="type Hijacker" data-gtmc="doc outline link"> type Hijacker </a> </li> <li> <a href="#MaxBytesError" title="type MaxBytesError" data-gtmc="doc outline link"> type MaxBytesError </a> <ul> <li> <a href="#MaxBytesError.Error" title="(e) Error()" data-gtmc="doc outline link"> (e) Error() </a> </li> </ul> </li> <li> <a href="#ProtocolError" title="type ProtocolError" data-gtmc="doc outline link"> type ProtocolError </a> <ul> <li> <a href="#ProtocolError.Error" title="(pe) Error()" data-gtmc="doc outline link"> (pe) Error() </a> </li> <li> <a href="#ProtocolError.Is" title="(pe) Is(err)" data-gtmc="doc outline link"> (pe) Is(err) </a> </li> </ul> </li> <li> <a href="#Protocols" title="type Protocols" data-gtmc="doc outline link"> type Protocols </a> <ul> <li> <a href="#Protocols.HTTP1" title="(p) HTTP1()" data-gtmc="doc outline link"> (p) HTTP1() </a> </li> <li> <a href="#Protocols.HTTP2" title="(p) HTTP2()" data-gtmc="doc outline link"> (p) HTTP2() </a> </li> <li> <a href="#Protocols.SetHTTP1" title="(p) SetHTTP1(ok)" data-gtmc="doc outline link"> (p) SetHTTP1(ok) </a> </li> <li> <a href="#Protocols.SetHTTP2" title="(p) SetHTTP2(ok)" data-gtmc="doc outline link"> (p) SetHTTP2(ok) </a> </li> <li> <a href="#Protocols.SetUnencryptedHTTP2" title="(p) SetUnencryptedHTTP2(ok)" data-gtmc="doc outline link"> (p) SetUnencryptedHTTP2(ok) </a> </li> <li> <a href="#Protocols.String" title="(p) String()" data-gtmc="doc outline link"> (p) String() </a> </li> <li> <a href="#Protocols.UnencryptedHTTP2" title="(p) UnencryptedHTTP2()" data-gtmc="doc outline link"> (p) UnencryptedHTTP2() </a> </li> </ul> </li> <li> <a href="#PushOptions" title="type PushOptions" data-gtmc="doc outline link"> type PushOptions </a> </li> <li> <a href="#Pusher" title="type Pusher" data-gtmc="doc outline link"> type Pusher </a> </li> <li> <a href="#Request" title="type Request" data-gtmc="doc outline link"> type Request </a> <ul> <li> <a href="#NewRequest" title="NewRequest(method, url, body)" data-gtmc="doc outline link"> NewRequest(method, url, body) </a> </li> <li> <a href="#NewRequestWithContext" title="NewRequestWithContext(ctx, method, url, body)" data-gtmc="doc outline link"> NewRequestWithContext(ctx, method, url, body) </a> </li> <li> <a href="#ReadRequest" title="ReadRequest(b)" data-gtmc="doc outline link"> ReadRequest(b) </a> </li> <li> <a href="#Request.AddCookie" title="(r) AddCookie(c)" data-gtmc="doc outline link"> (r) AddCookie(c) </a> </li> <li> <a href="#Request.BasicAuth" title="(r) BasicAuth()" data-gtmc="doc outline link"> (r) BasicAuth() </a> </li> <li> <a href="#Request.Clone" title="(r) Clone(ctx)" data-gtmc="doc outline link"> (r) Clone(ctx) </a> </li> <li> <a href="#Request.Context" title="(r) Context()" data-gtmc="doc outline link"> (r) Context() </a> </li> <li> <a href="#Request.Cookie" title="(r) Cookie(name)" data-gtmc="doc outline link"> (r) Cookie(name) </a> </li> <li> <a href="#Request.Cookies" title="(r) Cookies()" data-gtmc="doc outline link"> (r) Cookies() </a> </li> <li> <a href="#Request.CookiesNamed" title="(r) CookiesNamed(name)" data-gtmc="doc outline link"> (r) CookiesNamed(name) </a> </li> <li> <a href="#Request.FormFile" title="(r) FormFile(key)" data-gtmc="doc outline link"> (r) FormFile(key) </a> </li> <li> <a href="#Request.FormValue" title="(r) FormValue(key)" data-gtmc="doc outline link"> (r) FormValue(key) </a> </li> <li> <a href="#Request.MultipartReader" title="(r) MultipartReader()" data-gtmc="doc outline link"> (r) MultipartReader() </a> </li> <li> <a href="#Request.ParseForm" title="(r) ParseForm()" data-gtmc="doc outline link"> (r) ParseForm() </a> </li> <li> <a href="#Request.ParseMultipartForm" title="(r) ParseMultipartForm(maxMemory)" data-gtmc="doc outline link"> (r) ParseMultipartForm(maxMemory) </a> </li> <li> <a href="#Request.PathValue" title="(r) PathValue(name)" data-gtmc="doc outline link"> (r) PathValue(name) </a> </li> <li> <a href="#Request.PostFormValue" title="(r) PostFormValue(key)" data-gtmc="doc outline link"> (r) PostFormValue(key) </a> </li> <li> <a href="#Request.ProtoAtLeast" title="(r) ProtoAtLeast(major, minor)" data-gtmc="doc outline link"> (r) ProtoAtLeast(major, minor) </a> </li> <li> <a href="#Request.Referer" title="(r) Referer()" data-gtmc="doc outline link"> (r) Referer() </a> </li> <li> <a href="#Request.SetBasicAuth" title="(r) SetBasicAuth(username, password)" data-gtmc="doc outline link"> (r) SetBasicAuth(username, password) </a> </li> <li> <a href="#Request.SetPathValue" title="(r) SetPathValue(name, value)" data-gtmc="doc outline link"> (r) SetPathValue(name, value) </a> </li> <li> <a href="#Request.UserAgent" title="(r) UserAgent()" data-gtmc="doc outline link"> (r) UserAgent() </a> </li> <li> <a href="#Request.WithContext" title="(r) WithContext(ctx)" data-gtmc="doc outline link"> (r) WithContext(ctx) </a> </li> <li> <a href="#Request.Write" title="(r) Write(w)" data-gtmc="doc outline link"> (r) Write(w) </a> </li> <li> <a href="#Request.WriteProxy" title="(r) WriteProxy(w)" data-gtmc="doc outline link"> (r) WriteProxy(w) </a> </li> </ul> </li> <li> <a href="#Response" title="type Response" data-gtmc="doc outline link"> type Response </a> <ul> <li> <a href="#Get" title="Get(url)" data-gtmc="doc outline link"> Get(url) </a> </li> <li> <a href="#Head" title="Head(url)" data-gtmc="doc outline link"> Head(url) </a> </li> <li> <a href="#Post" title="Post(url, contentType, body)" data-gtmc="doc outline link"> Post(url, contentType, body) </a> </li> <li> <a href="#PostForm" title="PostForm(url, data)" data-gtmc="doc outline link"> PostForm(url, data) </a> </li> <li> <a href="#ReadResponse" title="ReadResponse(r, req)" data-gtmc="doc outline link"> ReadResponse(r, req) </a> </li> <li> <a href="#Response.Cookies" title="(r) Cookies()" data-gtmc="doc outline link"> (r) Cookies() </a> </li> <li> <a href="#Response.Location" title="(r) Location()" data-gtmc="doc outline link"> (r) Location() </a> </li> <li> <a href="#Response.ProtoAtLeast" title="(r) ProtoAtLeast(major, minor)" data-gtmc="doc outline link"> (r) ProtoAtLeast(major, minor) </a> </li> <li> <a href="#Response.Write" title="(r) Write(w)" data-gtmc="doc outline link"> (r) Write(w) </a> </li> </ul> </li> <li> <a href="#ResponseController" title="type ResponseController" data-gtmc="doc outline link"> type ResponseController </a> <ul> <li> <a href="#NewResponseController" title="NewResponseController(rw)" data-gtmc="doc outline link"> NewResponseController(rw) </a> </li> <li> <a href="#ResponseController.EnableFullDuplex" title="(c) EnableFullDuplex()" data-gtmc="doc outline link"> (c) EnableFullDuplex() </a> </li> <li> <a href="#ResponseController.Flush" title="(c) Flush()" data-gtmc="doc outline link"> (c) Flush() </a> </li> <li> <a href="#ResponseController.Hijack" title="(c) Hijack()" data-gtmc="doc outline link"> (c) Hijack() </a> </li> <li> <a href="#ResponseController.SetReadDeadline" title="(c) SetReadDeadline(deadline)" data-gtmc="doc outline link"> (c) SetReadDeadline(deadline) </a> </li> <li> <a href="#ResponseController.SetWriteDeadline" title="(c) SetWriteDeadline(deadline)" data-gtmc="doc outline link"> (c) SetWriteDeadline(deadline) </a> </li> </ul> </li> <li> <a href="#ResponseWriter" title="type ResponseWriter" data-gtmc="doc outline link"> type ResponseWriter </a> </li> <li> <a href="#RoundTripper" title="type RoundTripper" data-gtmc="doc outline link"> type RoundTripper </a> <ul> <li> <a href="#NewFileTransport" title="NewFileTransport(fs)" data-gtmc="doc outline link"> NewFileTransport(fs) </a> </li> <li> <a href="#NewFileTransportFS" title="NewFileTransportFS(fsys)" data-gtmc="doc outline link"> NewFileTransportFS(fsys) </a> </li> </ul> </li> <li> <a href="#SameSite" title="type SameSite" data-gtmc="doc outline link"> type SameSite </a> </li> <li> <a href="#ServeMux" title="type ServeMux" data-gtmc="doc outline link"> type ServeMux </a> <ul> <li> <a href="#NewServeMux" title="NewServeMux()" data-gtmc="doc outline link"> NewServeMux() </a> </li> <li> <a href="#ServeMux.Handle" title="(mux) Handle(pattern, handler)" data-gtmc="doc outline link"> (mux) Handle(pattern, handler) </a> </li> <li> <a href="#ServeMux.HandleFunc" title="(mux) HandleFunc(pattern, handler)" data-gtmc="doc outline link"> (mux) HandleFunc(pattern, handler) </a> </li> <li> <a href="#ServeMux.Handler" title="(mux) Handler(r)" data-gtmc="doc outline link"> (mux) Handler(r) </a> </li> <li> <a href="#ServeMux.ServeHTTP" title="(mux) ServeHTTP(w, r)" data-gtmc="doc outline link"> (mux) ServeHTTP(w, r) </a> </li> </ul> </li> <li> <a href="#Server" title="type Server" data-gtmc="doc outline link"> type Server </a> <ul> <li> <a href="#Server.Close" title="(s) Close()" data-gtmc="doc outline link"> (s) Close() </a> </li> <li> <a href="#Server.ListenAndServe" title="(s) ListenAndServe()" data-gtmc="doc outline link"> (s) ListenAndServe() </a> </li> <li> <a href="#Server.ListenAndServeTLS" title="(s) ListenAndServeTLS(certFile, keyFile)" data-gtmc="doc outline link"> (s) ListenAndServeTLS(certFile, keyFile) </a> </li> <li> <a href="#Server.RegisterOnShutdown" title="(s) RegisterOnShutdown(f)" data-gtmc="doc outline link"> (s) RegisterOnShutdown(f) </a> </li> <li> <a href="#Server.Serve" title="(s) Serve(l)" data-gtmc="doc outline link"> (s) Serve(l) </a> </li> <li> <a href="#Server.ServeTLS" title="(s) ServeTLS(l, certFile, keyFile)" data-gtmc="doc outline link"> (s) ServeTLS(l, certFile, keyFile) </a> </li> <li> <a href="#Server.SetKeepAlivesEnabled" title="(s) SetKeepAlivesEnabled(v)" data-gtmc="doc outline link"> (s) SetKeepAlivesEnabled(v) </a> </li> <li> <a href="#Server.Shutdown" title="(s) Shutdown(ctx)" data-gtmc="doc outline link"> (s) Shutdown(ctx) </a> </li> </ul> </li> <li> <a href="#Transport" title="type Transport" data-gtmc="doc outline link"> type Transport </a> <ul> <li> <a href="#Transport.CancelRequest" title="(t) CancelRequest(req)" data-gtmc="doc outline link"> (t) CancelRequest(req) </a> </li> <li> <a href="#Transport.Clone" title="(t) Clone()" data-gtmc="doc outline link"> (t) Clone() </a> </li> <li> <a href="#Transport.CloseIdleConnections" title="(t) CloseIdleConnections()" data-gtmc="doc outline link"> (t) CloseIdleConnections() </a> </li> <li> <a href="#Transport.RegisterProtocol" title="(t) RegisterProtocol(scheme, rt)" data-gtmc="doc outline link"> (t) RegisterProtocol(scheme, rt) </a> </li> <li> <a href="#Transport.RoundTrip" title="(t) RoundTrip(req)" data-gtmc="doc outline link"> (t) RoundTrip(req) </a> </li> </ul> </li> </ul> </li> </ul> </li> <li> <a href="#section-sourcefiles" data-gtmc="outline link"> Source Files </a> </li> <li> <a href="#section-directories" data-gtmc="outline link"> Directories </a> </li> </ul> </div> <div class="go-Main-navMobile js-mainNavMobile"> <label class="go-Label"> <select class="go-Select"> <option selected disabled>Documentation</option> </select> </label> </div> </nav> <article class="go-Main-article js-mainContent"> <div class="UnitDetails" data-test-id="UnitDetails" style="display: block;"> <div class="UnitDetails-content js-unitDetailsContent" data-test-id="UnitDetails-content"> <div class="UnitDoc"> <h2 class="UnitDoc-title" id="section-documentation"> <img class="go-Icon" height="24" width="24" src="/static/shared/icon/code_gm_grey_24dp.svg" alt=""> Documentation <a class="UnitDoc-idLink" href="#section-documentation" title="Go to Documentation" aria-label="Go to Documentation">¶</a> </h2> <div class="UnitBuildContext-titleContext"> <label> <a href="https://go.dev/about#build-context" class="UnitBuildContext-link">Rendered for</a> <select class="go-Select js-buildContextSelect"> <option value="linux">linux/amd64</option> <option value="windows">windows/amd64</option> <option value="darwin">darwin/amd64</option> <option value="js">js/wasm</option> </select> </label> </div> <div class="Documentation js-documentation"> <div class="Documentation-content js-docContent"> <section class="Documentation-overview"> <h3 tabindex="-1" id="pkg-overview" class="Documentation-overviewHeader">Overview <a href="#pkg-overview" title="Go to Overview" aria-label="Go to Overview">¶</a></h3> <div role="navigation" aria-label="Table of Contents"> <ul class="Documentation-toc"> <li class="Documentation-tocItem"><a href="#hdr-Clients_and_Transports">Clients and Transports</a></li> <li class="Documentation-tocItem"><a href="#hdr-Servers">Servers</a></li> <li class="Documentation-tocItem"><a href="#hdr-HTTP_2">HTTP/2</a></li> </ul> </div> <p>Package http provides HTTP client and server implementations. </p><p><a href="#Get">Get</a>, <a href="#Head">Head</a>, <a href="#Post">Post</a>, and <a href="#PostForm">PostForm</a> make HTTP (or HTTPS) requests: </p><pre>resp, err := http.Get("http://example.com/") ... resp, err := http.Post("http://example.com/upload", "image/jpeg", &buf) ... resp, err := http.PostForm("http://example.com/form", url.Values{"key": {"Value"}, "id": {"123"}}) </pre><p>The caller must close the response body when finished with it: </p><pre>resp, err := http.Get("http://example.com/") if err != nil { // handle error } defer resp.Body.Close() body, err := io.ReadAll(resp.Body) // ... </pre><h4 id="hdr-Clients_and_Transports">Clients and Transports <a class="Documentation-idLink" href="#hdr-Clients_and_Transports" title="Go to Clients and Transports" aria-label="Go to Clients and Transports">¶</a></h4><p>For control over HTTP client headers, redirect policy, and other settings, create a <a href="#Client">Client</a>: </p><pre>client := &http.Client{ CheckRedirect: redirectPolicyFunc, } resp, err := client.Get("http://example.com") // ... req, err := http.NewRequest("GET", "http://example.com", nil) // ... req.Header.Add("If-None-Match", `W/"wyzzy"`) resp, err := client.Do(req) // ... </pre><p>For control over proxies, TLS configuration, keep-alives, compression, and other settings, create a <a href="#Transport">Transport</a>: </p><pre>tr := &http.Transport{ MaxIdleConns: 10, IdleConnTimeout: 30 * time.Second, DisableCompression: true, } client := &http.Client{Transport: tr} resp, err := client.Get("https://example.com") </pre><p>Clients and Transports are safe for concurrent use by multiple goroutines and for efficiency should only be created once and re-used. </p><h4 id="hdr-Servers">Servers <a class="Documentation-idLink" href="#hdr-Servers" title="Go to Servers" aria-label="Go to Servers">¶</a></h4><p>ListenAndServe starts an HTTP server with a given address and handler. The handler is usually nil, which means to use <a href="#DefaultServeMux">DefaultServeMux</a>. <a href="#Handle">Handle</a> and <a href="#HandleFunc">HandleFunc</a> add handlers to <a href="#DefaultServeMux">DefaultServeMux</a>: </p><pre>http.Handle("/foo", fooHandler) http.HandleFunc("/bar", func(w http.ResponseWriter, r *http.Request) { fmt.Fprintf(w, "Hello, %q", html.EscapeString(r.URL.Path)) }) log.Fatal(http.ListenAndServe(":8080", nil)) </pre><p>More control over the server's behavior is available by creating a custom Server: </p><pre>s := &http.Server{ Addr: ":8080", Handler: myHandler, ReadTimeout: 10 * time.Second, WriteTimeout: 10 * time.Second, MaxHeaderBytes: 1 << 20, } log.Fatal(s.ListenAndServe()) </pre><h4 id="hdr-HTTP_2">HTTP/2 <a class="Documentation-idLink" href="#hdr-HTTP_2" title="Go to HTTP/2" aria-label="Go to HTTP/2">¶</a></h4><p>Starting with Go 1.6, the http package has transparent support for the HTTP/2 protocol when using HTTPS. Programs that must disable HTTP/2 can do so by setting [Transport.TLSNextProto] (for clients) or [Server.TLSNextProto] (for servers) to a non-nil, empty map. Alternatively, the following GODEBUG settings are currently supported: </p><pre>GODEBUG=http2client=0 # disable HTTP/2 client support GODEBUG=http2server=0 # disable HTTP/2 server support GODEBUG=http2debug=1 # enable verbose HTTP/2 debug logs GODEBUG=http2debug=2 # ... even more verbose, with frame dumps </pre><p>Please report any issues before disabling HTTP/2 support: <a href="https://golang.org/s/http2bug">https://golang.org/s/http2bug</a> </p><p>The http package's <a href="#Transport">Transport</a> and <a href="#Server">Server</a> both automatically enable HTTP/2 support for simple configurations. To enable HTTP/2 for more complex configurations, to use lower-level HTTP/2 features, or to use a newer version of Go's http2 package, import "golang.org/x/net/http2" directly and use its ConfigureTransport and/or ConfigureServer functions. Manually configuring HTTP/2 via the golang.org/x/net/http2 package takes precedence over the net/http package's built-in HTTP/2 support. </p> </section><section class="Documentation-index"> <h3 id="pkg-index" class="Documentation-indexHeader">Index <a href="#pkg-index" title="Go to Index" aria-label="Go to Index">¶</a></h3> <ul class="Documentation-indexList"> <li class="Documentation-indexConstants"><a href="#pkg-constants">Constants</a></li> <li class="Documentation-indexVariables"><a href="#pkg-variables">Variables</a></li> <li class="Documentation-indexFunction"> <a href="#CanonicalHeaderKey">func CanonicalHeaderKey(s string) string</a></li> <li class="Documentation-indexFunction"> <a href="#DetectContentType">func DetectContentType(data []byte) string</a></li> <li class="Documentation-indexFunction"> <a href="#Error">func Error(w ResponseWriter, error string, code int)</a></li> <li class="Documentation-indexFunction"> <a href="#Handle">func Handle(pattern string, handler Handler)</a></li> <li class="Documentation-indexFunction"> <a href="#HandleFunc">func HandleFunc(pattern string, handler func(ResponseWriter, *Request))</a></li> <li class="Documentation-indexFunction"> <a href="#ListenAndServe">func ListenAndServe(addr string, handler Handler) error</a></li> <li class="Documentation-indexFunction"> <a href="#ListenAndServeTLS">func ListenAndServeTLS(addr, certFile, keyFile string, handler Handler) error</a></li> <li class="Documentation-indexFunction"> <a href="#MaxBytesReader">func MaxBytesReader(w ResponseWriter, r io.ReadCloser, n int64) io.ReadCloser</a></li> <li class="Documentation-indexFunction"> <a href="#NotFound">func NotFound(w ResponseWriter, r *Request)</a></li> <li class="Documentation-indexFunction"> <a href="#ParseHTTPVersion">func ParseHTTPVersion(vers string) (major, minor int, ok bool)</a></li> <li class="Documentation-indexFunction"> <a href="#ParseTime">func ParseTime(text string) (t time.Time, err error)</a></li> <li class="Documentation-indexFunction"> <a href="#ProxyFromEnvironment">func ProxyFromEnvironment(req *Request) (*url.URL, error)</a></li> <li class="Documentation-indexFunction"> <a href="#ProxyURL">func ProxyURL(fixedURL *url.URL) func(*Request) (*url.URL, error)</a></li> <li class="Documentation-indexFunction"> <a href="#Redirect">func Redirect(w ResponseWriter, r *Request, url string, code int)</a></li> <li class="Documentation-indexFunction"> <a href="#Serve">func Serve(l net.Listener, handler Handler) error</a></li> <li class="Documentation-indexFunction"> <a href="#ServeContent">func ServeContent(w ResponseWriter, req *Request, name string, modtime time.Time, ...)</a></li> <li class="Documentation-indexFunction"> <a href="#ServeFile">func ServeFile(w ResponseWriter, r *Request, name string)</a></li> <li class="Documentation-indexFunction"> <a href="#ServeFileFS">func ServeFileFS(w ResponseWriter, r *Request, fsys fs.FS, name string)</a></li> <li class="Documentation-indexFunction"> <a href="#ServeTLS">func ServeTLS(l net.Listener, handler Handler, certFile, keyFile string) error</a></li> <li class="Documentation-indexFunction"> <a href="#SetCookie">func SetCookie(w ResponseWriter, cookie *Cookie)</a></li> <li class="Documentation-indexFunction"> <a href="#StatusText">func StatusText(code int) string</a></li> <li class="Documentation-indexType"> <a href="#Client">type Client</a></li> <li><ul class="Documentation-indexTypeMethods"> <li> <a href="#Client.CloseIdleConnections">func (c *Client) CloseIdleConnections()</a></li> <li> <a href="#Client.Do">func (c *Client) Do(req *Request) (*Response, error)</a></li> <li> <a href="#Client.Get">func (c *Client) Get(url string) (resp *Response, err error)</a></li> <li> <a href="#Client.Head">func (c *Client) Head(url string) (resp *Response, err error)</a></li> <li> <a href="#Client.Post">func (c *Client) Post(url, contentType string, body io.Reader) (resp *Response, err error)</a></li> <li> <a href="#Client.PostForm">func (c *Client) PostForm(url string, data url.Values) (resp *Response, err error)</a></li> </ul></li> <li class="Documentation-indexType"> <a class="js-deprecatedTagLink" href="#CloseNotifier">type CloseNotifier</a><span class="Documentation-indexDeprecated Documentation-deprecatedTag">deprecated</span></li> <li class="Documentation-indexType"> <a href="#ConnState">type ConnState</a></li> <li><ul class="Documentation-indexTypeMethods"> <li> <a href="#ConnState.String">func (c ConnState) String() string</a></li> </ul></li> <li class="Documentation-indexType"> <a href="#Cookie">type Cookie</a></li> <li><ul class="Documentation-indexTypeFunctions"> <li> <a href="#ParseCookie">func ParseCookie(line string) ([]*Cookie, error)</a></li> <li> <a href="#ParseSetCookie">func ParseSetCookie(line string) (*Cookie, error)</a></li> </ul></li> <li><ul class="Documentation-indexTypeMethods"> <li> <a href="#Cookie.String">func (c *Cookie) String() string</a></li> <li> <a href="#Cookie.Valid">func (c *Cookie) Valid() error</a></li> </ul></li> <li class="Documentation-indexType"> <a href="#CookieJar">type CookieJar</a></li> <li class="Documentation-indexType"> <a href="#Dir">type Dir</a></li> <li><ul class="Documentation-indexTypeMethods"> <li> <a href="#Dir.Open">func (d Dir) Open(name string) (File, error)</a></li> </ul></li> <li class="Documentation-indexType"> <a href="#File">type File</a></li> <li class="Documentation-indexType"> <a href="#FileSystem">type FileSystem</a></li> <li><ul class="Documentation-indexTypeFunctions"> <li> <a href="#FS">func FS(fsys fs.FS) FileSystem</a></li> </ul></li> <li class="Documentation-indexType"> <a href="#Flusher">type Flusher</a></li> <li class="Documentation-indexType"> <a href="#HTTP2Config">type HTTP2Config</a></li> <li class="Documentation-indexType"> <a href="#Handler">type Handler</a></li> <li><ul class="Documentation-indexTypeFunctions"> <li> <a href="#AllowQuerySemicolons">func AllowQuerySemicolons(h Handler) Handler</a></li> <li> <a href="#FileServer">func FileServer(root FileSystem) Handler</a></li> <li> <a href="#FileServerFS">func FileServerFS(root fs.FS) Handler</a></li> <li> <a href="#MaxBytesHandler">func MaxBytesHandler(h Handler, n int64) Handler</a></li> <li> <a href="#NotFoundHandler">func NotFoundHandler() Handler</a></li> <li> <a href="#RedirectHandler">func RedirectHandler(url string, code int) Handler</a></li> <li> <a href="#StripPrefix">func StripPrefix(prefix string, h Handler) Handler</a></li> <li> <a href="#TimeoutHandler">func TimeoutHandler(h Handler, dt time.Duration, msg string) Handler</a></li> </ul></li> <li class="Documentation-indexType"> <a href="#HandlerFunc">type HandlerFunc</a></li> <li><ul class="Documentation-indexTypeMethods"> <li> <a href="#HandlerFunc.ServeHTTP">func (f HandlerFunc) ServeHTTP(w ResponseWriter, r *Request)</a></li> </ul></li> <li class="Documentation-indexType"> <a href="#Header">type Header</a></li> <li><ul class="Documentation-indexTypeMethods"> <li> <a href="#Header.Add">func (h Header) Add(key, value string)</a></li> <li> <a href="#Header.Clone">func (h Header) Clone() Header</a></li> <li> <a href="#Header.Del">func (h Header) Del(key string)</a></li> <li> <a href="#Header.Get">func (h Header) Get(key string) string</a></li> <li> <a href="#Header.Set">func (h Header) Set(key, value string)</a></li> <li> <a href="#Header.Values">func (h Header) Values(key string) []string</a></li> <li> <a href="#Header.Write">func (h Header) Write(w io.Writer) error</a></li> <li> <a href="#Header.WriteSubset">func (h Header) WriteSubset(w io.Writer, exclude map[string]bool) error</a></li> </ul></li> <li class="Documentation-indexType"> <a href="#Hijacker">type Hijacker</a></li> <li class="Documentation-indexType"> <a href="#MaxBytesError">type MaxBytesError</a></li> <li><ul class="Documentation-indexTypeMethods"> <li> <a href="#MaxBytesError.Error">func (e *MaxBytesError) Error() string</a></li> </ul></li> <li class="Documentation-indexType"> <a class="js-deprecatedTagLink" href="#ProtocolError">type ProtocolError</a><span class="Documentation-indexDeprecated Documentation-deprecatedTag">deprecated</span></li> <li><ul class="Documentation-indexTypeMethods"> <li> <a href="#ProtocolError.Error">func (pe *ProtocolError) Error() string</a></li> <li> <a href="#ProtocolError.Is">func (pe *ProtocolError) Is(err error) bool</a></li> </ul></li> <li class="Documentation-indexType"> <a href="#Protocols">type Protocols</a></li> <li><ul class="Documentation-indexTypeMethods"> <li> <a href="#Protocols.HTTP1">func (p Protocols) HTTP1() bool</a></li> <li> <a href="#Protocols.HTTP2">func (p Protocols) HTTP2() bool</a></li> <li> <a href="#Protocols.SetHTTP1">func (p *Protocols) SetHTTP1(ok bool)</a></li> <li> <a href="#Protocols.SetHTTP2">func (p *Protocols) SetHTTP2(ok bool)</a></li> <li> <a href="#Protocols.SetUnencryptedHTTP2">func (p *Protocols) SetUnencryptedHTTP2(ok bool)</a></li> <li> <a href="#Protocols.String">func (p Protocols) String() string</a></li> <li> <a href="#Protocols.UnencryptedHTTP2">func (p Protocols) UnencryptedHTTP2() bool</a></li> </ul></li> <li class="Documentation-indexType"> <a href="#PushOptions">type PushOptions</a></li> <li class="Documentation-indexType"> <a href="#Pusher">type Pusher</a></li> <li class="Documentation-indexType"> <a href="#Request">type Request</a></li> <li><ul class="Documentation-indexTypeFunctions"> <li> <a href="#NewRequest">func NewRequest(method, url string, body io.Reader) (*Request, error)</a></li> <li> <a href="#NewRequestWithContext">func NewRequestWithContext(ctx context.Context, method, url string, body io.Reader) (*Request, error)</a></li> <li> <a href="#ReadRequest">func ReadRequest(b *bufio.Reader) (*Request, error)</a></li> </ul></li> <li><ul class="Documentation-indexTypeMethods"> <li> <a href="#Request.AddCookie">func (r *Request) AddCookie(c *Cookie)</a></li> <li> <a href="#Request.BasicAuth">func (r *Request) BasicAuth() (username, password string, ok bool)</a></li> <li> <a href="#Request.Clone">func (r *Request) Clone(ctx context.Context) *Request</a></li> <li> <a href="#Request.Context">func (r *Request) Context() context.Context</a></li> <li> <a href="#Request.Cookie">func (r *Request) Cookie(name string) (*Cookie, error)</a></li> <li> <a href="#Request.Cookies">func (r *Request) Cookies() []*Cookie</a></li> <li> <a href="#Request.CookiesNamed">func (r *Request) CookiesNamed(name string) []*Cookie</a></li> <li> <a href="#Request.FormFile">func (r *Request) FormFile(key string) (multipart.File, *multipart.FileHeader, error)</a></li> <li> <a href="#Request.FormValue">func (r *Request) FormValue(key string) string</a></li> <li> <a href="#Request.MultipartReader">func (r *Request) MultipartReader() (*multipart.Reader, error)</a></li> <li> <a href="#Request.ParseForm">func (r *Request) ParseForm() error</a></li> <li> <a href="#Request.ParseMultipartForm">func (r *Request) ParseMultipartForm(maxMemory int64) error</a></li> <li> <a href="#Request.PathValue">func (r *Request) PathValue(name string) string</a></li> <li> <a href="#Request.PostFormValue">func (r *Request) PostFormValue(key string) string</a></li> <li> <a href="#Request.ProtoAtLeast">func (r *Request) ProtoAtLeast(major, minor int) bool</a></li> <li> <a href="#Request.Referer">func (r *Request) Referer() string</a></li> <li> <a href="#Request.SetBasicAuth">func (r *Request) SetBasicAuth(username, password string)</a></li> <li> <a href="#Request.SetPathValue">func (r *Request) SetPathValue(name, value string)</a></li> <li> <a href="#Request.UserAgent">func (r *Request) UserAgent() string</a></li> <li> <a href="#Request.WithContext">func (r *Request) WithContext(ctx context.Context) *Request</a></li> <li> <a href="#Request.Write">func (r *Request) Write(w io.Writer) error</a></li> <li> <a href="#Request.WriteProxy">func (r *Request) WriteProxy(w io.Writer) error</a></li> </ul></li> <li class="Documentation-indexType"> <a href="#Response">type Response</a></li> <li><ul class="Documentation-indexTypeFunctions"> <li> <a href="#Get">func Get(url string) (resp *Response, err error)</a></li> <li> <a href="#Head">func Head(url string) (resp *Response, err error)</a></li> <li> <a href="#Post">func Post(url, contentType string, body io.Reader) (resp *Response, err error)</a></li> <li> <a href="#PostForm">func PostForm(url string, data url.Values) (resp *Response, err error)</a></li> <li> <a href="#ReadResponse">func ReadResponse(r *bufio.Reader, req *Request) (*Response, error)</a></li> </ul></li> <li><ul class="Documentation-indexTypeMethods"> <li> <a href="#Response.Cookies">func (r *Response) Cookies() []*Cookie</a></li> <li> <a href="#Response.Location">func (r *Response) Location() (*url.URL, error)</a></li> <li> <a href="#Response.ProtoAtLeast">func (r *Response) ProtoAtLeast(major, minor int) bool</a></li> <li> <a href="#Response.Write">func (r *Response) Write(w io.Writer) error</a></li> </ul></li> <li class="Documentation-indexType"> <a href="#ResponseController">type ResponseController</a></li> <li><ul class="Documentation-indexTypeFunctions"> <li> <a href="#NewResponseController">func NewResponseController(rw ResponseWriter) *ResponseController</a></li> </ul></li> <li><ul class="Documentation-indexTypeMethods"> <li> <a href="#ResponseController.EnableFullDuplex">func (c *ResponseController) EnableFullDuplex() error</a></li> <li> <a href="#ResponseController.Flush">func (c *ResponseController) Flush() error</a></li> <li> <a href="#ResponseController.Hijack">func (c *ResponseController) Hijack() (net.Conn, *bufio.ReadWriter, error)</a></li> <li> <a href="#ResponseController.SetReadDeadline">func (c *ResponseController) SetReadDeadline(deadline time.Time) error</a></li> <li> <a href="#ResponseController.SetWriteDeadline">func (c *ResponseController) SetWriteDeadline(deadline time.Time) error</a></li> </ul></li> <li class="Documentation-indexType"> <a href="#ResponseWriter">type ResponseWriter</a></li> <li class="Documentation-indexType"> <a href="#RoundTripper">type RoundTripper</a></li> <li><ul class="Documentation-indexTypeFunctions"> <li> <a href="#NewFileTransport">func NewFileTransport(fs FileSystem) RoundTripper</a></li> <li> <a href="#NewFileTransportFS">func NewFileTransportFS(fsys fs.FS) RoundTripper</a></li> </ul></li> <li class="Documentation-indexType"> <a href="#SameSite">type SameSite</a></li> <li class="Documentation-indexType"> <a href="#ServeMux">type ServeMux</a></li> <li><ul class="Documentation-indexTypeFunctions"> <li> <a href="#NewServeMux">func NewServeMux() *ServeMux</a></li> </ul></li> <li><ul class="Documentation-indexTypeMethods"> <li> <a href="#ServeMux.Handle">func (mux *ServeMux) Handle(pattern string, handler Handler)</a></li> <li> <a href="#ServeMux.HandleFunc">func (mux *ServeMux) HandleFunc(pattern string, handler func(ResponseWriter, *Request))</a></li> <li> <a href="#ServeMux.Handler">func (mux *ServeMux) Handler(r *Request) (h Handler, pattern string)</a></li> <li> <a href="#ServeMux.ServeHTTP">func (mux *ServeMux) ServeHTTP(w ResponseWriter, r *Request)</a></li> </ul></li> <li class="Documentation-indexType"> <a href="#Server">type Server</a></li> <li><ul class="Documentation-indexTypeMethods"> <li> <a href="#Server.Close">func (s *Server) Close() error</a></li> <li> <a href="#Server.ListenAndServe">func (s *Server) ListenAndServe() error</a></li> <li> <a href="#Server.ListenAndServeTLS">func (s *Server) ListenAndServeTLS(certFile, keyFile string) error</a></li> <li> <a href="#Server.RegisterOnShutdown">func (s *Server) RegisterOnShutdown(f func())</a></li> <li> <a href="#Server.Serve">func (s *Server) Serve(l net.Listener) error</a></li> <li> <a href="#Server.ServeTLS">func (s *Server) ServeTLS(l net.Listener, certFile, keyFile string) error</a></li> <li> <a href="#Server.SetKeepAlivesEnabled">func (s *Server) SetKeepAlivesEnabled(v bool)</a></li> <li> <a href="#Server.Shutdown">func (s *Server) Shutdown(ctx context.Context) error</a></li> </ul></li> <li class="Documentation-indexType"> <a href="#Transport">type Transport</a></li> <li><ul class="Documentation-indexTypeMethods"> <li> <a class="js-deprecatedTagLink" href="#Transport.CancelRequest">func (t *Transport) CancelRequest(req *Request)</a><span class="Documentation-indexDeprecated Documentation-deprecatedTag">deprecated</span></li> <li> <a href="#Transport.Clone">func (t *Transport) Clone() *Transport</a></li> <li> <a href="#Transport.CloseIdleConnections">func (t *Transport) CloseIdleConnections()</a></li> <li> <a href="#Transport.RegisterProtocol">func (t *Transport) RegisterProtocol(scheme string, rt RoundTripper)</a></li> <li> <a href="#Transport.RoundTrip">func (t *Transport) RoundTrip(req *Request) (*Response, error)</a></li> </ul></li> </ul> </section><section class="Documentation-examples"> <h4 tabindex="-1" id="pkg-examples" class="Documentation-examplesHeader">Examples <a class="Documentation-idLink" href="#pkg-examples" title="Go to Examples" aria-label="Go to Examples">¶</a></h4> <ul class="Documentation-examplesList"> <li><a href="#example-FileServer" class="js-exampleHref">FileServer</a></li> <li><a href="#example-FileServer-DotFileHiding" class="js-exampleHref">FileServer (DotFileHiding)</a></li> <li><a href="#example-FileServer-StripPrefix" class="js-exampleHref">FileServer (StripPrefix)</a></li> <li><a href="#example-Get" class="js-exampleHref">Get</a></li> <li><a href="#example-Handle" class="js-exampleHref">Handle</a></li> <li><a href="#example-HandleFunc" class="js-exampleHref">HandleFunc</a></li> <li><a href="#example-Hijacker" class="js-exampleHref">Hijacker</a></li> <li><a href="#example-ListenAndServe" class="js-exampleHref">ListenAndServe</a></li> <li><a href="#example-ListenAndServeTLS" class="js-exampleHref">ListenAndServeTLS</a></li> <li><a href="#example-NotFoundHandler" class="js-exampleHref">NotFoundHandler</a></li> <li><a href="#example-Protocols-Http1" class="js-exampleHref">Protocols (Http1)</a></li> <li><a href="#example-Protocols-Http1or2" class="js-exampleHref">Protocols (Http1or2)</a></li> <li><a href="#example-ResponseWriter-Trailers" class="js-exampleHref">ResponseWriter (Trailers)</a></li> <li><a href="#example-ServeMux.Handle" class="js-exampleHref">ServeMux.Handle</a></li> <li><a href="#example-Server.Shutdown" class="js-exampleHref">Server.Shutdown</a></li> <li><a href="#example-StripPrefix" class="js-exampleHref">StripPrefix</a></li> </ul> </section><h3 tabindex="-1" id="pkg-constants" class="Documentation-constantsHeader">Constants <a href="#pkg-constants" title="Go to Constants" aria-label="Go to Constants">¶</a></h3> <section class="Documentation-constants"> <div class="Documentation-declaration"> <span class="Documentation-declarationLink"><a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/method.go;l=10">View Source</a></span> <pre>const ( <span id="MethodGet" data-kind="constant"> MethodGet = "GET" </span><span id="MethodHead" data-kind="constant"> MethodHead = "HEAD" </span><span id="MethodPost" data-kind="constant"> MethodPost = "POST" </span><span id="MethodPut" data-kind="constant"> MethodPut = "PUT" </span><span id="MethodPatch" data-kind="constant"> MethodPatch = "PATCH" <span class="comment">// <a href="https://rfc-editor.org/rfc/rfc5789.html">RFC 5789</a></span> </span><span id="MethodDelete" data-kind="constant"> MethodDelete = "DELETE" </span><span id="MethodConnect" data-kind="constant"> MethodConnect = "CONNECT" </span><span id="MethodOptions" data-kind="constant"> MethodOptions = "OPTIONS" </span><span id="MethodTrace" data-kind="constant"> MethodTrace = "TRACE" </span>)</pre> </div> <p>Common HTTP methods. </p><p>Unless otherwise noted, these are defined in <a href="https://rfc-editor.org/rfc/rfc7231.html#section-4.3">RFC 7231 section 4.3</a>. </p> <div class="Documentation-declaration"> <span class="Documentation-declarationLink"><a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/status.go;l=9">View Source</a></span> <pre>const ( <span id="StatusContinue" data-kind="constant"> StatusContinue = 100 <span class="comment">// <a href="https://rfc-editor.org/rfc/rfc9110.html">RFC 9110</a>, 15.2.1</span> </span><span id="StatusSwitchingProtocols" data-kind="constant"> StatusSwitchingProtocols = 101 <span class="comment">// <a href="https://rfc-editor.org/rfc/rfc9110.html">RFC 9110</a>, 15.2.2</span> </span><span id="StatusProcessing" data-kind="constant"> StatusProcessing = 102 <span class="comment">// <a href="https://rfc-editor.org/rfc/rfc2518.html">RFC 2518</a>, 10.1</span> </span><span id="StatusEarlyHints" data-kind="constant"> StatusEarlyHints = 103 <span class="comment">// <a href="https://rfc-editor.org/rfc/rfc8297.html">RFC 8297</a></span> </span> <span id="StatusOK" data-kind="constant"> StatusOK = 200 <span class="comment">// <a href="https://rfc-editor.org/rfc/rfc9110.html">RFC 9110</a>, 15.3.1</span> </span><span id="StatusCreated" data-kind="constant"> StatusCreated = 201 <span class="comment">// <a href="https://rfc-editor.org/rfc/rfc9110.html">RFC 9110</a>, 15.3.2</span> </span><span id="StatusAccepted" data-kind="constant"> StatusAccepted = 202 <span class="comment">// <a href="https://rfc-editor.org/rfc/rfc9110.html">RFC 9110</a>, 15.3.3</span> </span><span id="StatusNonAuthoritativeInfo" data-kind="constant"> StatusNonAuthoritativeInfo = 203 <span class="comment">// <a href="https://rfc-editor.org/rfc/rfc9110.html">RFC 9110</a>, 15.3.4</span> </span><span id="StatusNoContent" data-kind="constant"> StatusNoContent = 204 <span class="comment">// <a href="https://rfc-editor.org/rfc/rfc9110.html">RFC 9110</a>, 15.3.5</span> </span><span id="StatusResetContent" data-kind="constant"> StatusResetContent = 205 <span class="comment">// <a href="https://rfc-editor.org/rfc/rfc9110.html">RFC 9110</a>, 15.3.6</span> </span><span id="StatusPartialContent" data-kind="constant"> StatusPartialContent = 206 <span class="comment">// <a href="https://rfc-editor.org/rfc/rfc9110.html">RFC 9110</a>, 15.3.7</span> </span><span id="StatusMultiStatus" data-kind="constant"> StatusMultiStatus = 207 <span class="comment">// <a href="https://rfc-editor.org/rfc/rfc4918.html">RFC 4918</a>, 11.1</span> </span><span id="StatusAlreadyReported" data-kind="constant"> StatusAlreadyReported = 208 <span class="comment">// <a href="https://rfc-editor.org/rfc/rfc5842.html">RFC 5842</a>, 7.1</span> </span><span id="StatusIMUsed" data-kind="constant"> StatusIMUsed = 226 <span class="comment">// <a href="https://rfc-editor.org/rfc/rfc3229.html">RFC 3229</a>, 10.4.1</span> </span> <span id="StatusMultipleChoices" data-kind="constant"> StatusMultipleChoices = 300 <span class="comment">// <a href="https://rfc-editor.org/rfc/rfc9110.html">RFC 9110</a>, 15.4.1</span> </span><span id="StatusMovedPermanently" data-kind="constant"> StatusMovedPermanently = 301 <span class="comment">// <a href="https://rfc-editor.org/rfc/rfc9110.html">RFC 9110</a>, 15.4.2</span> </span><span id="StatusFound" data-kind="constant"> StatusFound = 302 <span class="comment">// <a href="https://rfc-editor.org/rfc/rfc9110.html">RFC 9110</a>, 15.4.3</span> </span><span id="StatusSeeOther" data-kind="constant"> StatusSeeOther = 303 <span class="comment">// <a href="https://rfc-editor.org/rfc/rfc9110.html">RFC 9110</a>, 15.4.4</span> </span><span id="StatusNotModified" data-kind="constant"> StatusNotModified = 304 <span class="comment">// <a href="https://rfc-editor.org/rfc/rfc9110.html">RFC 9110</a>, 15.4.5</span> </span><span id="StatusUseProxy" data-kind="constant"> StatusUseProxy = 305 <span class="comment">// <a href="https://rfc-editor.org/rfc/rfc9110.html">RFC 9110</a>, 15.4.6</span> </span> <span id="StatusTemporaryRedirect" data-kind="constant"> StatusTemporaryRedirect = 307 <span class="comment">// <a href="https://rfc-editor.org/rfc/rfc9110.html">RFC 9110</a>, 15.4.8</span> </span><span id="StatusPermanentRedirect" data-kind="constant"> StatusPermanentRedirect = 308 <span class="comment">// <a href="https://rfc-editor.org/rfc/rfc9110.html">RFC 9110</a>, 15.4.9</span> </span> <span id="StatusBadRequest" data-kind="constant"> StatusBadRequest = 400 <span class="comment">// <a href="https://rfc-editor.org/rfc/rfc9110.html">RFC 9110</a>, 15.5.1</span> </span><span id="StatusUnauthorized" data-kind="constant"> StatusUnauthorized = 401 <span class="comment">// <a href="https://rfc-editor.org/rfc/rfc9110.html">RFC 9110</a>, 15.5.2</span> </span><span id="StatusPaymentRequired" data-kind="constant"> StatusPaymentRequired = 402 <span class="comment">// <a href="https://rfc-editor.org/rfc/rfc9110.html">RFC 9110</a>, 15.5.3</span> </span><span id="StatusForbidden" data-kind="constant"> StatusForbidden = 403 <span class="comment">// <a href="https://rfc-editor.org/rfc/rfc9110.html">RFC 9110</a>, 15.5.4</span> </span><span id="StatusNotFound" data-kind="constant"> StatusNotFound = 404 <span class="comment">// <a href="https://rfc-editor.org/rfc/rfc9110.html">RFC 9110</a>, 15.5.5</span> </span><span id="StatusMethodNotAllowed" data-kind="constant"> StatusMethodNotAllowed = 405 <span class="comment">// <a href="https://rfc-editor.org/rfc/rfc9110.html">RFC 9110</a>, 15.5.6</span> </span><span id="StatusNotAcceptable" data-kind="constant"> StatusNotAcceptable = 406 <span class="comment">// <a href="https://rfc-editor.org/rfc/rfc9110.html">RFC 9110</a>, 15.5.7</span> </span><span id="StatusProxyAuthRequired" data-kind="constant"> StatusProxyAuthRequired = 407 <span class="comment">// <a href="https://rfc-editor.org/rfc/rfc9110.html">RFC 9110</a>, 15.5.8</span> </span><span id="StatusRequestTimeout" data-kind="constant"> StatusRequestTimeout = 408 <span class="comment">// <a href="https://rfc-editor.org/rfc/rfc9110.html">RFC 9110</a>, 15.5.9</span> </span><span id="StatusConflict" data-kind="constant"> StatusConflict = 409 <span class="comment">// <a href="https://rfc-editor.org/rfc/rfc9110.html">RFC 9110</a>, 15.5.10</span> </span><span id="StatusGone" data-kind="constant"> StatusGone = 410 <span class="comment">// <a href="https://rfc-editor.org/rfc/rfc9110.html">RFC 9110</a>, 15.5.11</span> </span><span id="StatusLengthRequired" data-kind="constant"> StatusLengthRequired = 411 <span class="comment">// <a href="https://rfc-editor.org/rfc/rfc9110.html">RFC 9110</a>, 15.5.12</span> </span><span id="StatusPreconditionFailed" data-kind="constant"> StatusPreconditionFailed = 412 <span class="comment">// <a href="https://rfc-editor.org/rfc/rfc9110.html">RFC 9110</a>, 15.5.13</span> </span><span id="StatusRequestEntityTooLarge" data-kind="constant"> StatusRequestEntityTooLarge = 413 <span class="comment">// <a href="https://rfc-editor.org/rfc/rfc9110.html">RFC 9110</a>, 15.5.14</span> </span><span id="StatusRequestURITooLong" data-kind="constant"> StatusRequestURITooLong = 414 <span class="comment">// <a href="https://rfc-editor.org/rfc/rfc9110.html">RFC 9110</a>, 15.5.15</span> </span><span id="StatusUnsupportedMediaType" data-kind="constant"> StatusUnsupportedMediaType = 415 <span class="comment">// <a href="https://rfc-editor.org/rfc/rfc9110.html">RFC 9110</a>, 15.5.16</span> </span><span id="StatusRequestedRangeNotSatisfiable" data-kind="constant"> StatusRequestedRangeNotSatisfiable = 416 <span class="comment">// <a href="https://rfc-editor.org/rfc/rfc9110.html">RFC 9110</a>, 15.5.17</span> </span><span id="StatusExpectationFailed" data-kind="constant"> StatusExpectationFailed = 417 <span class="comment">// <a href="https://rfc-editor.org/rfc/rfc9110.html">RFC 9110</a>, 15.5.18</span> </span><span id="StatusTeapot" data-kind="constant"> StatusTeapot = 418 <span class="comment">// <a href="https://rfc-editor.org/rfc/rfc9110.html">RFC 9110</a>, 15.5.19 (Unused)</span> </span><span id="StatusMisdirectedRequest" data-kind="constant"> StatusMisdirectedRequest = 421 <span class="comment">// <a href="https://rfc-editor.org/rfc/rfc9110.html">RFC 9110</a>, 15.5.20</span> </span><span id="StatusUnprocessableEntity" data-kind="constant"> StatusUnprocessableEntity = 422 <span class="comment">// <a href="https://rfc-editor.org/rfc/rfc9110.html">RFC 9110</a>, 15.5.21</span> </span><span id="StatusLocked" data-kind="constant"> StatusLocked = 423 <span class="comment">// <a href="https://rfc-editor.org/rfc/rfc4918.html">RFC 4918</a>, 11.3</span> </span><span id="StatusFailedDependency" data-kind="constant"> StatusFailedDependency = 424 <span class="comment">// <a href="https://rfc-editor.org/rfc/rfc4918.html">RFC 4918</a>, 11.4</span> </span><span id="StatusTooEarly" data-kind="constant"> StatusTooEarly = 425 <span class="comment">// <a href="https://rfc-editor.org/rfc/rfc8470.html">RFC 8470</a>, 5.2.</span> </span><span id="StatusUpgradeRequired" data-kind="constant"> StatusUpgradeRequired = 426 <span class="comment">// <a href="https://rfc-editor.org/rfc/rfc9110.html">RFC 9110</a>, 15.5.22</span> </span><span id="StatusPreconditionRequired" data-kind="constant"> StatusPreconditionRequired = 428 <span class="comment">// <a href="https://rfc-editor.org/rfc/rfc6585.html">RFC 6585</a>, 3</span> </span><span id="StatusTooManyRequests" data-kind="constant"> StatusTooManyRequests = 429 <span class="comment">// <a href="https://rfc-editor.org/rfc/rfc6585.html">RFC 6585</a>, 4</span> </span><span id="StatusRequestHeaderFieldsTooLarge" data-kind="constant"> StatusRequestHeaderFieldsTooLarge = 431 <span class="comment">// <a href="https://rfc-editor.org/rfc/rfc6585.html">RFC 6585</a>, 5</span> </span><span id="StatusUnavailableForLegalReasons" data-kind="constant"> StatusUnavailableForLegalReasons = 451 <span class="comment">// <a href="https://rfc-editor.org/rfc/rfc7725.html">RFC 7725</a>, 3</span> </span> <span id="StatusInternalServerError" data-kind="constant"> StatusInternalServerError = 500 <span class="comment">// <a href="https://rfc-editor.org/rfc/rfc9110.html">RFC 9110</a>, 15.6.1</span> </span><span id="StatusNotImplemented" data-kind="constant"> StatusNotImplemented = 501 <span class="comment">// <a href="https://rfc-editor.org/rfc/rfc9110.html">RFC 9110</a>, 15.6.2</span> </span><span id="StatusBadGateway" data-kind="constant"> StatusBadGateway = 502 <span class="comment">// <a href="https://rfc-editor.org/rfc/rfc9110.html">RFC 9110</a>, 15.6.3</span> </span><span id="StatusServiceUnavailable" data-kind="constant"> StatusServiceUnavailable = 503 <span class="comment">// <a href="https://rfc-editor.org/rfc/rfc9110.html">RFC 9110</a>, 15.6.4</span> </span><span id="StatusGatewayTimeout" data-kind="constant"> StatusGatewayTimeout = 504 <span class="comment">// <a href="https://rfc-editor.org/rfc/rfc9110.html">RFC 9110</a>, 15.6.5</span> </span><span id="StatusHTTPVersionNotSupported" data-kind="constant"> StatusHTTPVersionNotSupported = 505 <span class="comment">// <a href="https://rfc-editor.org/rfc/rfc9110.html">RFC 9110</a>, 15.6.6</span> </span><span id="StatusVariantAlsoNegotiates" data-kind="constant"> StatusVariantAlsoNegotiates = 506 <span class="comment">// <a href="https://rfc-editor.org/rfc/rfc2295.html">RFC 2295</a>, 8.1</span> </span><span id="StatusInsufficientStorage" data-kind="constant"> StatusInsufficientStorage = 507 <span class="comment">// <a href="https://rfc-editor.org/rfc/rfc4918.html">RFC 4918</a>, 11.5</span> </span><span id="StatusLoopDetected" data-kind="constant"> StatusLoopDetected = 508 <span class="comment">// <a href="https://rfc-editor.org/rfc/rfc5842.html">RFC 5842</a>, 7.2</span> </span><span id="StatusNotExtended" data-kind="constant"> StatusNotExtended = 510 <span class="comment">// <a href="https://rfc-editor.org/rfc/rfc2774.html">RFC 2774</a>, 7</span> </span><span id="StatusNetworkAuthenticationRequired" data-kind="constant"> StatusNetworkAuthenticationRequired = 511 <span class="comment">// <a href="https://rfc-editor.org/rfc/rfc6585.html">RFC 6585</a>, 6</span> </span>)</pre> </div> <p>HTTP status codes as registered with IANA. See: <a href="https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml">https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml</a> </p> <div class="Documentation-declaration"> <span class="Documentation-declarationLink"><a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/server.go;l=916">View Source</a></span> <pre><span id="DefaultMaxHeaderBytes" data-kind="constant">const DefaultMaxHeaderBytes = 1 << 20 <span class="comment">// 1 MB</span> </span></pre> </div> <p>DefaultMaxHeaderBytes is the maximum permitted size of the headers in an HTTP request. This can be overridden by setting [Server.MaxHeaderBytes]. </p> <div class="Documentation-declaration"> <span class="Documentation-declarationLink"><a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/transport.go;l=60">View Source</a></span> <pre><span id="DefaultMaxIdleConnsPerHost" data-kind="constant">const DefaultMaxIdleConnsPerHost = 2</span></pre> </div> <p>DefaultMaxIdleConnsPerHost is the default value of <a href="#Transport">Transport</a>'s MaxIdleConnsPerHost. </p> <div class="Documentation-declaration"> <span class="Documentation-declarationLink"><a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/server.go;l=992">View Source</a></span> <pre><span id="TimeFormat" data-kind="constant">const TimeFormat = "Mon, 02 Jan 2006 15:04:05 GMT"</span></pre> </div> <p>TimeFormat is the time format to use when generating times in HTTP headers. It is like <a href="/time#RFC1123">time.RFC1123</a> but hard-codes GMT as the time zone. The time being formatted must be in UTC for Format to generate the correct format. </p><p>For parsing this time format, see <a href="#ParseTime">ParseTime</a>. </p> <div class="Documentation-declaration"> <span class="Documentation-declarationLink"><a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/server.go;l=522">View Source</a></span> <pre><span id="TrailerPrefix" data-kind="constant">const TrailerPrefix = "Trailer:"</span></pre> </div> <p>TrailerPrefix is a magic prefix for [ResponseWriter.Header] map keys that, if present, signals that the map entry is actually for the response trailers, and not the response headers. The prefix is stripped after the ServeHTTP call finishes and the values are sent in the trailers. </p><p>This mechanism is intended only for trailers that are not known prior to the headers being written. If the set of trailers is fixed or known before the header is written, the normal Go trailers mechanism is preferred: </p><pre>https://pkg.go.dev/net/http#ResponseWriter https://pkg.go.dev/net/http#example-ResponseWriter-Trailers </pre> </section> <h3 tabindex="-1" id="pkg-variables" class="Documentation-variablesHeader">Variables <a href="#pkg-variables" title="Go to Variables" aria-label="Go to Variables">¶</a></h3> <section class="Documentation-variables"> <div class="Documentation-declaration"> <span class="Documentation-declarationLink"><a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/request.go;l=58">View Source</a></span> <pre>var ( <span id="ErrNotSupported" data-kind="variable"> <span class="comment">// ErrNotSupported indicates that a feature is not supported.</span> </span> <span class="comment">//</span> <span class="comment">// It is returned by ResponseController methods to indicate that</span> <span class="comment">// the handler does not support the method, and by the Push method</span> <span class="comment">// of Pusher implementations to indicate that HTTP/2 Push support</span> <span class="comment">// is not available.</span> ErrNotSupported = &<a href="#ProtocolError">ProtocolError</a>{"feature not supported"} <span id="ErrUnexpectedTrailer" data-kind="variable"> <span class="comment">// Deprecated: ErrUnexpectedTrailer is no longer returned by</span> </span> <span class="comment">// anything in the net/http package. Callers should not</span> <span class="comment">// compare errors against this variable.</span> ErrUnexpectedTrailer = &<a href="#ProtocolError">ProtocolError</a>{"trailer header without chunked transfer encoding"} <span id="ErrMissingBoundary" data-kind="variable"> <span class="comment">// ErrMissingBoundary is returned by Request.MultipartReader when the</span> </span> <span class="comment">// request's Content-Type does not include a "boundary" parameter.</span> ErrMissingBoundary = &<a href="#ProtocolError">ProtocolError</a>{"no multipart boundary param in Content-Type"} <span id="ErrNotMultipart" data-kind="variable"> <span class="comment">// ErrNotMultipart is returned by Request.MultipartReader when the</span> </span> <span class="comment">// request's Content-Type is not multipart/form-data.</span> ErrNotMultipart = &<a href="#ProtocolError">ProtocolError</a>{"request Content-Type isn't multipart/form-data"} <span id="ErrHeaderTooLong" data-kind="variable"> <span class="comment">// Deprecated: ErrHeaderTooLong is no longer returned by</span> </span> <span class="comment">// anything in the net/http package. Callers should not</span> <span class="comment">// compare errors against this variable.</span> ErrHeaderTooLong = &<a href="#ProtocolError">ProtocolError</a>{"header too long"} <span id="ErrShortBody" data-kind="variable"> <span class="comment">// Deprecated: ErrShortBody is no longer returned by</span> </span> <span class="comment">// anything in the net/http package. Callers should not</span> <span class="comment">// compare errors against this variable.</span> ErrShortBody = &<a href="#ProtocolError">ProtocolError</a>{"entity body too short"} <span id="ErrMissingContentLength" data-kind="variable"> <span class="comment">// Deprecated: ErrMissingContentLength is no longer returned by</span> </span> <span class="comment">// anything in the net/http package. Callers should not</span> <span class="comment">// compare errors against this variable.</span> ErrMissingContentLength = &<a href="#ProtocolError">ProtocolError</a>{"missing ContentLength in HEAD response"} )</pre> </div> <div class="Documentation-declaration"> <span class="Documentation-declarationLink"><a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/server.go;l=39">View Source</a></span> <pre>var ( <span id="ErrBodyNotAllowed" data-kind="variable"> <span class="comment">// ErrBodyNotAllowed is returned by ResponseWriter.Write calls</span> </span> <span class="comment">// when the HTTP method or response code does not permit a</span> <span class="comment">// body.</span> ErrBodyNotAllowed = <a href="/errors">errors</a>.<a href="/errors#New">New</a>("http: request method or response status code does not allow body") <span id="ErrHijacked" data-kind="variable"> <span class="comment">// ErrHijacked is returned by ResponseWriter.Write calls when</span> </span> <span class="comment">// the underlying connection has been hijacked using the</span> <span class="comment">// Hijacker interface. A zero-byte write on a hijacked</span> <span class="comment">// connection will return ErrHijacked without any other side</span> <span class="comment">// effects.</span> ErrHijacked = <a href="/errors">errors</a>.<a href="/errors#New">New</a>("http: connection has been hijacked") <span id="ErrContentLength" data-kind="variable"> <span class="comment">// ErrContentLength is returned by ResponseWriter.Write calls</span> </span> <span class="comment">// when a Handler set a Content-Length response header with a</span> <span class="comment">// declared size and then attempted to write more bytes than</span> <span class="comment">// declared.</span> ErrContentLength = <a href="/errors">errors</a>.<a href="/errors#New">New</a>("http: wrote more than the declared Content-Length") <span id="ErrWriteAfterFlush" data-kind="variable"> <span class="comment">// Deprecated: ErrWriteAfterFlush is no longer returned by</span> </span> <span class="comment">// anything in the net/http package. Callers should not</span> <span class="comment">// compare errors against this variable.</span> ErrWriteAfterFlush = <a href="/errors">errors</a>.<a href="/errors#New">New</a>("unused") )</pre> </div> <p>Errors used by the HTTP server. </p> <div class="Documentation-declaration"> <span class="Documentation-declarationLink"><a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/server.go;l=239">View Source</a></span> <pre>var ( <span id="ServerContextKey" data-kind="variable"> <span class="comment">// ServerContextKey is a context key. It can be used in HTTP</span> </span> <span class="comment">// handlers with Context.Value to access the server that</span> <span class="comment">// started the handler. The associated value will be of</span> <span class="comment">// type *Server.</span> ServerContextKey = &contextKey{"http-server"} <span id="LocalAddrContextKey" data-kind="variable"> <span class="comment">// LocalAddrContextKey is a context key. It can be used in</span> </span> <span class="comment">// HTTP handlers with Context.Value to access the local</span> <span class="comment">// address the connection arrived on.</span> <span class="comment">// The associated value will be of type net.Addr.</span> LocalAddrContextKey = &contextKey{"local-addr"} )</pre> </div> <div class="Documentation-declaration"> <span class="Documentation-declarationLink"><a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/client.go;l=109">View Source</a></span> <pre><span id="DefaultClient" data-kind="variable">var DefaultClient = &<a href="#Client">Client</a>{}</span></pre> </div> <p>DefaultClient is the default <a href="#Client">Client</a> and is used by <a href="#Get">Get</a>, <a href="#Head">Head</a>, and <a href="#Post">Post</a>. </p> <div class="Documentation-declaration"> <span class="Documentation-declarationLink"><a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/server.go;l=2594">View Source</a></span> <pre><span id="DefaultServeMux" data-kind="variable">var DefaultServeMux = &defaultServeMux</span></pre> </div> <p>DefaultServeMux is the default <a href="#ServeMux">ServeMux</a> used by <a href="#Serve">Serve</a>. </p> <div class="Documentation-declaration"> <span class="Documentation-declarationLink"><a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/server.go;l=1917">View Source</a></span> <pre><span id="ErrAbortHandler" data-kind="variable">var ErrAbortHandler = <a href="/errors">errors</a>.<a href="/errors#New">New</a>("net/http: abort Handler")</span></pre> </div> <p>ErrAbortHandler is a sentinel panic value to abort a handler. While any panic from ServeHTTP aborts the response to the client, panicking with ErrAbortHandler also suppresses logging of a stack trace to the server's error log. </p> <div class="Documentation-declaration"> <span class="Documentation-declarationLink"><a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/transfer.go;l=829">View Source</a></span> <pre><span id="ErrBodyReadAfterClose" data-kind="variable">var ErrBodyReadAfterClose = <a href="/errors">errors</a>.<a href="/errors#New">New</a>("http: invalid Read on closed Body")</span></pre> </div> <p>ErrBodyReadAfterClose is returned when reading a <a href="#Request">Request</a> or <a href="#Response">Response</a> Body after the body has been closed. This typically happens when the body is read after an HTTP <a href="#Handler">Handler</a> calls WriteHeader or Write on its <a href="#ResponseWriter">ResponseWriter</a>. </p> <div class="Documentation-declaration"> <span class="Documentation-declarationLink"><a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/server.go;l=3787">View Source</a></span> <pre><span id="ErrHandlerTimeout" data-kind="variable">var ErrHandlerTimeout = <a href="/errors">errors</a>.<a href="/errors#New">New</a>("http: Handler timeout")</span></pre> </div> <p>ErrHandlerTimeout is returned on <a href="#ResponseWriter">ResponseWriter</a> Write calls in handlers which have timed out. </p> <div class="Documentation-declaration"> <span class="Documentation-declarationLink"><a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/transfer.go;l=31">View Source</a></span> <pre><span id="ErrLineTooLong" data-kind="variable">var ErrLineTooLong = <a href="/net/http/internal">internal</a>.<a href="/net/http/internal#ErrLineTooLong">ErrLineTooLong</a></span></pre> </div> <p>ErrLineTooLong is returned when reading request or response bodies with malformed chunked encoding. </p> <div class="Documentation-declaration"> <span class="Documentation-declarationLink"><a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/request.go;l=41">View Source</a></span> <pre><span id="ErrMissingFile" data-kind="variable">var ErrMissingFile = <a href="/errors">errors</a>.<a href="/errors#New">New</a>("http: no such file")</span></pre> </div> <p>ErrMissingFile is returned by FormFile when the provided file field name is either not present in the request or not a file field. </p> <div class="Documentation-declaration"> <span class="Documentation-declarationLink"><a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/request.go;l=442">View Source</a></span> <pre><span id="ErrNoCookie" data-kind="variable">var ErrNoCookie = <a href="/errors">errors</a>.<a href="/errors#New">New</a>("http: named cookie not present")</span></pre> </div> <p>ErrNoCookie is returned by Request's Cookie method when a cookie is not found. </p> <div class="Documentation-declaration"> <span class="Documentation-declarationLink"><a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/response.go;l=131">View Source</a></span> <pre><span id="ErrNoLocation" data-kind="variable">var ErrNoLocation = <a href="/errors">errors</a>.<a href="/errors#New">New</a>("http: no Location header in response")</span></pre> </div> <p>ErrNoLocation is returned by the <a href="#Response.Location">Response.Location</a> method when no Location header is present. </p> <div class="Documentation-declaration"> <span class="Documentation-declarationLink"><a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/client.go;l=207">View Source</a></span> <pre><span id="ErrSchemeMismatch" data-kind="variable">var ErrSchemeMismatch = <a href="/errors">errors</a>.<a href="/errors#New">New</a>("http: server gave HTTP response to HTTPS client")</span></pre> </div> <p>ErrSchemeMismatch is returned when a server returns an HTTP response to an HTTPS client. </p> <div class="Documentation-declaration"> <span class="Documentation-declarationLink"><a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/server.go;l=3382">View Source</a></span> <pre><span id="ErrServerClosed" data-kind="variable">var ErrServerClosed = <a href="/errors">errors</a>.<a href="/errors#New">New</a>("http: Server closed")</span></pre> </div> <p>ErrServerClosed is returned by the <a href="#Server.Serve">Server.Serve</a>, <a href="#ServeTLS">ServeTLS</a>, <a href="#ListenAndServe">ListenAndServe</a>, and <a href="#ListenAndServeTLS">ListenAndServeTLS</a> methods after a call to <a href="#Server.Shutdown">Server.Shutdown</a> or <a href="#Server.Close">Server.Close</a>. </p> <div class="Documentation-declaration"> <span class="Documentation-declarationLink"><a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/transport.go;l=856">View Source</a></span> <pre><span id="ErrSkipAltProtocol" data-kind="variable">var ErrSkipAltProtocol = <a href="/errors">errors</a>.<a href="/errors#New">New</a>("net/http: skip alternate protocol")</span></pre> </div> <p>ErrSkipAltProtocol is a sentinel error value defined by Transport.RegisterProtocol. </p> <div class="Documentation-declaration"> <span class="Documentation-declarationLink"><a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/client.go;l=493">View Source</a></span> <pre><span id="ErrUseLastResponse" data-kind="variable">var ErrUseLastResponse = <a href="/errors">errors</a>.<a href="/errors#New">New</a>("net/http: use last response")</span></pre> </div> <p>ErrUseLastResponse can be returned by Client.CheckRedirect hooks to control how redirects are processed. If returned, the next request is not sent and the most recent response is returned with its body unclosed. </p> <div class="Documentation-declaration"> <span class="Documentation-declarationLink"><a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/http.go;l=171">View Source</a></span> <pre><span id="NoBody" data-kind="variable">var NoBody = noBody{}</span></pre> </div> <p>NoBody is an <a href="/io#ReadCloser">io.ReadCloser</a> with no bytes. Read always returns EOF and Close always returns nil. It can be used in an outgoing client request to explicitly signal that a request has zero bytes. An alternative, however, is to simply set [Request.Body] to nil. </p> </section> <h3 tabindex="-1" id="pkg-functions" class="Documentation-functionsHeader">Functions <a href="#pkg-functions" title="Go to Functions" aria-label="Go to Functions">¶</a></h3> <section class="Documentation-functions"><div class="Documentation-function"> <h4 tabindex="-1" id="CanonicalHeaderKey" data-kind="function" class="Documentation-functionHeader"> <span>func <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/header.go;l=234">CanonicalHeaderKey</a> <a class="Documentation-idLink" href="#CanonicalHeaderKey" title="Go to CanonicalHeaderKey" aria-label="Go to CanonicalHeaderKey">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>func CanonicalHeaderKey(s <a href="/builtin#string">string</a>) <a href="/builtin#string">string</a></pre> </div> <p>CanonicalHeaderKey returns the canonical format of the header key s. The canonicalization converts the first letter and any letter following a hyphen to upper case; the rest are converted to lowercase. For example, the canonical key for "accept-encoding" is "Accept-Encoding". If s contains a space or invalid header field bytes, it is returned without modifications. </p> </div><div class="Documentation-function"> <h4 tabindex="-1" id="DetectContentType" data-kind="function" class="Documentation-functionHeader"> <span>func <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/sniff.go;l=21">DetectContentType</a> <a class="Documentation-idLink" href="#DetectContentType" title="Go to DetectContentType" aria-label="Go to DetectContentType">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>func DetectContentType(data []<a href="/builtin#byte">byte</a>) <a href="/builtin#string">string</a></pre> </div> <p>DetectContentType implements the algorithm described at <a href="https://mimesniff.spec.whatwg.org/">https://mimesniff.spec.whatwg.org/</a> to determine the Content-Type of the given data. It considers at most the first 512 bytes of data. DetectContentType always returns a valid MIME type: if it cannot determine a more specific one, it returns "application/octet-stream". </p> </div><div class="Documentation-function"> <h4 tabindex="-1" id="Error" data-kind="function" class="Documentation-functionHeader"> <span>func <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/server.go;l=2309">Error</a> <a class="Documentation-idLink" href="#Error" title="Go to Error" aria-label="Go to Error">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>func Error(w <a href="#ResponseWriter">ResponseWriter</a>, error <a href="/builtin#string">string</a>, code <a href="/builtin#int">int</a>)</pre> </div> <p>Error replies to the request with the specified error message and HTTP code. It does not otherwise end the request; the caller should ensure no further writes are done to w. The error message should be plain text. </p><p>Error deletes the Content-Length header, sets Content-Type to “text/plain; charset=utf-8”, and sets X-Content-Type-Options to “nosniff”. This configures the header properly for the error message, in case the caller had set it up expecting a successful output. </p> </div><div class="Documentation-function"> <h4 tabindex="-1" id="Handle" data-kind="function" class="Documentation-functionHeader"> <span>func <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/server.go;l=2852">Handle</a> <a class="Documentation-idLink" href="#Handle" title="Go to Handle" aria-label="Go to Handle">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>func Handle(pattern <a href="/builtin#string">string</a>, handler <a href="#Handler">Handler</a>)</pre> </div> <p>Handle registers the handler for the given pattern in <a href="#DefaultServeMux">DefaultServeMux</a>. The documentation for <a href="#ServeMux">ServeMux</a> explains how patterns are matched. </p> <details tabindex="-1" id="example-Handle" class="Documentation-exampleDetails js-exampleContainer"> <summary class="Documentation-exampleDetailsHeader">Example <a href="#example-Handle" title="Go to Example" aria-label="Go to Example">¶</a></summary> <div class="Documentation-exampleDetailsBody"> <pre class="Documentation-exampleCode"> package main import ( "fmt" "log" "net/http" "sync" ) type countHandler struct { mu sync.Mutex // guards n n int } func (h *countHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) { h.mu.Lock() defer h.mu.Unlock() h.n++ fmt.Fprintf(w, "count is %d\n", h.n) } func main() { http.Handle("/count", new(countHandler)) log.Fatal(http.ListenAndServe(":8080", nil)) } </pre> <pre><span class="Documentation-exampleOutputLabel">Output:</span> <span class="Documentation-exampleOutput"></span></pre> </div> <div class="Documentation-exampleButtonsContainer"> <p class="Documentation-exampleError" role="alert" aria-atomic="true"></p> <button class="Documentation-exampleShareButton" aria-label="Share Code">Share</button> <button class="Documentation-exampleFormatButton" aria-label="Format Code">Format</button> <button class="Documentation-exampleRunButton" aria-label="Run Code">Run</button> </div></details> </div><div class="Documentation-function"> <h4 tabindex="-1" id="HandleFunc" data-kind="function" class="Documentation-functionHeader"> <span>func <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/server.go;l=2862">HandleFunc</a> <a class="Documentation-idLink" href="#HandleFunc" title="Go to HandleFunc" aria-label="Go to HandleFunc">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>func HandleFunc(pattern <a href="/builtin#string">string</a>, handler func(<a href="#ResponseWriter">ResponseWriter</a>, *<a href="#Request">Request</a>))</pre> </div> <p>HandleFunc registers the handler function for the given pattern in <a href="#DefaultServeMux">DefaultServeMux</a>. The documentation for <a href="#ServeMux">ServeMux</a> explains how patterns are matched. </p> <details tabindex="-1" id="example-HandleFunc" class="Documentation-exampleDetails js-exampleContainer"> <summary class="Documentation-exampleDetailsHeader">Example <a href="#example-HandleFunc" title="Go to Example" aria-label="Go to Example">¶</a></summary> <div class="Documentation-exampleDetailsBody"> <pre class="Documentation-exampleCode"> package main import ( "io" "log" "net/http" ) func main() { h1 := func(w http.ResponseWriter, _ *http.Request) { io.WriteString(w, "Hello from a HandleFunc #1!\n") } h2 := func(w http.ResponseWriter, _ *http.Request) { io.WriteString(w, "Hello from a HandleFunc #2!\n") } http.HandleFunc("/", h1) http.HandleFunc("/endpoint", h2) log.Fatal(http.ListenAndServe(":8080", nil)) } </pre> <pre><span class="Documentation-exampleOutputLabel">Output:</span> <span class="Documentation-exampleOutput"></span></pre> </div> <div class="Documentation-exampleButtonsContainer"> <p class="Documentation-exampleError" role="alert" aria-atomic="true"></p> <button class="Documentation-exampleShareButton" aria-label="Share Code">Share</button> <button class="Documentation-exampleFormatButton" aria-label="Format Code">Format</button> <button class="Documentation-exampleRunButton" aria-label="Run Code">Run</button> </div></details> </div><div class="Documentation-function"> <h4 tabindex="-1" id="ListenAndServe" data-kind="function" class="Documentation-functionHeader"> <span>func <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/server.go;l=3663">ListenAndServe</a> <a class="Documentation-idLink" href="#ListenAndServe" title="Go to ListenAndServe" aria-label="Go to ListenAndServe">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>func ListenAndServe(addr <a href="/builtin#string">string</a>, handler <a href="#Handler">Handler</a>) <a href="/builtin#error">error</a></pre> </div> <p>ListenAndServe listens on the TCP network address addr and then calls <a href="#Serve">Serve</a> with handler to handle requests on incoming connections. Accepted connections are configured to enable TCP keep-alives. </p><p>The handler is typically nil, in which case <a href="#DefaultServeMux">DefaultServeMux</a> is used. </p><p>ListenAndServe always returns a non-nil error. </p> <details tabindex="-1" id="example-ListenAndServe" class="Documentation-exampleDetails js-exampleContainer"> <summary class="Documentation-exampleDetailsHeader">Example <a href="#example-ListenAndServe" title="Go to Example" aria-label="Go to Example">¶</a></summary> <div class="Documentation-exampleDetailsBody"> <pre class="Documentation-exampleCode"> package main import ( "io" "log" "net/http" ) func main() { // Hello world, the web server helloHandler := func(w http.ResponseWriter, req *http.Request) { io.WriteString(w, "Hello, world!\n") } http.HandleFunc("/hello", helloHandler) log.Fatal(http.ListenAndServe(":8080", nil)) } </pre> <pre><span class="Documentation-exampleOutputLabel">Output:</span> <span class="Documentation-exampleOutput"></span></pre> </div> <div class="Documentation-exampleButtonsContainer"> <p class="Documentation-exampleError" role="alert" aria-atomic="true"></p> <button class="Documentation-exampleShareButton" aria-label="Share Code">Share</button> <button class="Documentation-exampleFormatButton" aria-label="Format Code">Format</button> <button class="Documentation-exampleRunButton" aria-label="Run Code">Run</button> </div></details> </div><div class="Documentation-function"> <h4 tabindex="-1" id="ListenAndServeTLS" data-kind="function" class="Documentation-functionHeader"> <span>func <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/server.go;l=3673">ListenAndServeTLS</a> <a class="Documentation-idLink" href="#ListenAndServeTLS" title="Go to ListenAndServeTLS" aria-label="Go to ListenAndServeTLS">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>func ListenAndServeTLS(addr, certFile, keyFile <a href="/builtin#string">string</a>, handler <a href="#Handler">Handler</a>) <a href="/builtin#error">error</a></pre> </div> <p>ListenAndServeTLS acts identically to <a href="#ListenAndServe">ListenAndServe</a>, except that it expects HTTPS connections. Additionally, files containing a certificate and matching private key for the server must be provided. If the certificate is signed by a certificate authority, the certFile should be the concatenation of the server's certificate, any intermediates, and the CA's certificate. </p> <details tabindex="-1" id="example-ListenAndServeTLS" class="Documentation-exampleDetails js-exampleContainer"> <summary class="Documentation-exampleDetailsHeader">Example <a href="#example-ListenAndServeTLS" title="Go to Example" aria-label="Go to Example">¶</a></summary> <div class="Documentation-exampleDetailsBody"> <pre class="Documentation-exampleCode"> package main import ( "io" "log" "net/http" ) func main() { http.HandleFunc("/", func(w http.ResponseWriter, req *http.Request) { io.WriteString(w, "Hello, TLS!\n") }) // One can use generate_cert.go in crypto/tls to generate cert.pem and key.pem. log.Printf("About to listen on 8443. Go to https://127.0.0.1:8443/") err := http.ListenAndServeTLS(":8443", "cert.pem", "key.pem", nil) log.Fatal(err) } </pre> <pre><span class="Documentation-exampleOutputLabel">Output:</span> <span class="Documentation-exampleOutput"></span></pre> </div> <div class="Documentation-exampleButtonsContainer"> <p class="Documentation-exampleError" role="alert" aria-atomic="true"></p> <button class="Documentation-exampleShareButton" aria-label="Share Code">Share</button> <button class="Documentation-exampleFormatButton" aria-label="Format Code">Format</button> <button class="Documentation-exampleRunButton" aria-label="Run Code">Run</button> </div></details> </div><div class="Documentation-function"> <h4 tabindex="-1" id="MaxBytesReader" data-kind="function" class="Documentation-functionHeader"> <span>func <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/request.go;l=1186">MaxBytesReader</a> <a class="Documentation-idLink" href="#MaxBytesReader" title="Go to MaxBytesReader" aria-label="Go to MaxBytesReader">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>func MaxBytesReader(w <a href="#ResponseWriter">ResponseWriter</a>, r <a href="/io">io</a>.<a href="/io#ReadCloser">ReadCloser</a>, n <a href="/builtin#int64">int64</a>) <a href="/io">io</a>.<a href="/io#ReadCloser">ReadCloser</a></pre> </div> <p>MaxBytesReader is similar to <a href="/io#LimitReader">io.LimitReader</a> but is intended for limiting the size of incoming request bodies. In contrast to io.LimitReader, MaxBytesReader's result is a ReadCloser, returns a non-nil error of type <a href="#MaxBytesError">*MaxBytesError</a> for a Read beyond the limit, and closes the underlying reader when its Close method is called. </p><p>MaxBytesReader prevents clients from accidentally or maliciously sending a large request and wasting server resources. If possible, it tells the <a href="#ResponseWriter">ResponseWriter</a> to close the connection after the limit has been reached. </p> </div><div class="Documentation-function"> <h4 tabindex="-1" id="NotFound" data-kind="function" class="Documentation-functionHeader"> <span>func <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/server.go;l=2330">NotFound</a> <a class="Documentation-idLink" href="#NotFound" title="Go to NotFound" aria-label="Go to NotFound">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>func NotFound(w <a href="#ResponseWriter">ResponseWriter</a>, r *<a href="#Request">Request</a>)</pre> </div> <p>NotFound replies to the request with an HTTP 404 not found error. </p> </div><div class="Documentation-function"> <h4 tabindex="-1" id="ParseHTTPVersion" data-kind="function" class="Documentation-functionHeader"> <span>func <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/request.go;l=817">ParseHTTPVersion</a> <a class="Documentation-idLink" href="#ParseHTTPVersion" title="Go to ParseHTTPVersion" aria-label="Go to ParseHTTPVersion">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>func ParseHTTPVersion(vers <a href="/builtin#string">string</a>) (major, minor <a href="/builtin#int">int</a>, ok <a href="/builtin#bool">bool</a>)</pre> </div> <p>ParseHTTPVersion parses an HTTP version string according to <a href="https://rfc-editor.org/rfc/rfc7230.html#section-2.6">RFC 7230, section 2.6</a>. "HTTP/1.0" returns (1, 0, true). Note that strings without a minor version, such as "HTTP/2", are not valid. </p> </div><div class="Documentation-function"> <h4 tabindex="-1" id="ParseTime" data-kind="function" class="Documentation-functionHeader"> <span>func <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/header.go;l=129">ParseTime</a> <a class="Documentation-idLink" href="#ParseTime" title="Go to ParseTime" aria-label="Go to ParseTime">¶</a></span> <span class="Documentation-sinceVersion"> <span class="Documentation-sinceVersionLabel">added in</span> <span class="Documentation-sinceVersionVersion">go1.1</span> </span> </h4> <div class="Documentation-declaration"> <pre>func ParseTime(text <a href="/builtin#string">string</a>) (t <a href="/time">time</a>.<a href="/time#Time">Time</a>, err <a href="/builtin#error">error</a>)</pre> </div> <p>ParseTime parses a time header (such as the Date: header), trying each of the three formats allowed by HTTP/1.1: <a href="#TimeFormat">TimeFormat</a>, <a href="/time#RFC850">time.RFC850</a>, and <a href="/time#ANSIC">time.ANSIC</a>. </p> </div><div class="Documentation-function"> <h4 tabindex="-1" id="ProxyFromEnvironment" data-kind="function" class="Documentation-functionHeader"> <span>func <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/transport.go;l=499">ProxyFromEnvironment</a> <a class="Documentation-idLink" href="#ProxyFromEnvironment" title="Go to ProxyFromEnvironment" aria-label="Go to ProxyFromEnvironment">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>func ProxyFromEnvironment(req *<a href="#Request">Request</a>) (*<a href="/net/url">url</a>.<a href="/net/url#URL">URL</a>, <a href="/builtin#error">error</a>)</pre> </div> <p>ProxyFromEnvironment returns the URL of the proxy to use for a given request, as indicated by the environment variables HTTP_PROXY, HTTPS_PROXY and NO_PROXY (or the lowercase versions thereof). Requests use the proxy from the environment variable matching their scheme, unless excluded by NO_PROXY. </p><p>The environment values may be either a complete URL or a "host[:port]", in which case the "http" scheme is assumed. An error is returned if the value is a different form. </p><p>A nil URL and nil error are returned if no proxy is defined in the environment, or a proxy should not be used for the given request, as defined by NO_PROXY. </p><p>As a special case, if req.URL.Host is "localhost" (with or without a port number), then a nil URL and nil error will be returned. </p> </div><div class="Documentation-function"> <h4 tabindex="-1" id="ProxyURL" data-kind="function" class="Documentation-functionHeader"> <span>func <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/transport.go;l=505">ProxyURL</a> <a class="Documentation-idLink" href="#ProxyURL" title="Go to ProxyURL" aria-label="Go to ProxyURL">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>func ProxyURL(fixedURL *<a href="/net/url">url</a>.<a href="/net/url#URL">URL</a>) func(*<a href="#Request">Request</a>) (*<a href="/net/url">url</a>.<a href="/net/url#URL">URL</a>, <a href="/builtin#error">error</a>)</pre> </div> <p>ProxyURL returns a proxy function (for use in a <a href="#Transport">Transport</a>) that always returns the same URL. </p> </div><div class="Documentation-function"> <h4 tabindex="-1" id="Redirect" data-kind="function" class="Documentation-functionHeader"> <span>func <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/server.go;l=2373">Redirect</a> <a class="Documentation-idLink" href="#Redirect" title="Go to Redirect" aria-label="Go to Redirect">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>func Redirect(w <a href="#ResponseWriter">ResponseWriter</a>, r *<a href="#Request">Request</a>, url <a href="/builtin#string">string</a>, code <a href="/builtin#int">int</a>)</pre> </div> <p>Redirect replies to the request with a redirect to url, which may be a path relative to the request path. </p><p>The provided code should be in the 3xx range and is usually <a href="#StatusMovedPermanently">StatusMovedPermanently</a>, <a href="#StatusFound">StatusFound</a> or <a href="#StatusSeeOther">StatusSeeOther</a>. </p><p>If the Content-Type header has not been set, <a href="#Redirect">Redirect</a> sets it to "text/html; charset=utf-8" and writes a small HTML body. Setting the Content-Type header to any value, including nil, disables that behavior. </p> </div><div class="Documentation-function"> <h4 tabindex="-1" id="Serve" data-kind="function" class="Documentation-functionHeader"> <span>func <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/server.go;l=2930">Serve</a> <a class="Documentation-idLink" href="#Serve" title="Go to Serve" aria-label="Go to Serve">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>func Serve(l <a href="/net">net</a>.<a href="/net#Listener">Listener</a>, handler <a href="#Handler">Handler</a>) <a href="/builtin#error">error</a></pre> </div> <p>Serve accepts incoming HTTP connections on the listener l, creating a new service goroutine for each. The service goroutines read requests and then call handler to reply to them. </p><p>The handler is typically nil, in which case <a href="#DefaultServeMux">DefaultServeMux</a> is used. </p><p>HTTP/2 support is only enabled if the Listener returns <a href="/crypto/tls#Conn">*tls.Conn</a> connections and they were configured with "h2" in the TLS Config.NextProtos. </p><p>Serve always returns a non-nil error. </p> </div><div class="Documentation-function"> <h4 tabindex="-1" id="ServeContent" data-kind="function" class="Documentation-functionHeader"> <span>func <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/fs.go;l=240">ServeContent</a> <a class="Documentation-idLink" href="#ServeContent" title="Go to ServeContent" aria-label="Go to ServeContent">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>func ServeContent(w <a href="#ResponseWriter">ResponseWriter</a>, req *<a href="#Request">Request</a>, name <a href="/builtin#string">string</a>, modtime <a href="/time">time</a>.<a href="/time#Time">Time</a>, content <a href="/io">io</a>.<a href="/io#ReadSeeker">ReadSeeker</a>)</pre> </div> <p>ServeContent replies to the request using the content in the provided ReadSeeker. The main benefit of ServeContent over <a href="/io#Copy">io.Copy</a> is that it handles Range requests properly, sets the MIME type, and handles If-Match, If-Unmodified-Since, If-None-Match, If-Modified-Since, and If-Range requests. </p><p>If the response's Content-Type header is not set, ServeContent first tries to deduce the type from name's file extension and, if that fails, falls back to reading the first block of the content and passing it to <a href="#DetectContentType">DetectContentType</a>. The name is otherwise unused; in particular it can be empty and is never sent in the response. </p><p>If modtime is not the zero time or Unix epoch, ServeContent includes it in a Last-Modified header in the response. If the request includes an If-Modified-Since header, ServeContent uses modtime to decide whether the content needs to be sent at all. </p><p>The content's Seek method must work: ServeContent uses a seek to the end of the content to determine its size. Note that <a href="/os#File">*os.File</a> implements the <a href="/io#ReadSeeker">io.ReadSeeker</a> interface. </p><p>If the caller has set w's ETag header formatted per <a href="https://rfc-editor.org/rfc/rfc7232.html#section-2.3">RFC 7232, section 2.3</a>, ServeContent uses it to handle requests using If-Match, If-None-Match, or If-Range. </p><p>If an error occurs when serving the request (for example, when handling an invalid range request), ServeContent responds with an error message. By default, ServeContent strips the Cache-Control, Content-Encoding, ETag, and Last-Modified headers from error responses. The GODEBUG setting httpservecontentkeepheaders=1 causes ServeContent to preserve these headers. </p> </div><div class="Documentation-function"> <h4 tabindex="-1" id="ServeFile" data-kind="function" class="Documentation-functionHeader"> <span>func <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/fs.go;l=806">ServeFile</a> <a class="Documentation-idLink" href="#ServeFile" title="Go to ServeFile" aria-label="Go to ServeFile">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>func ServeFile(w <a href="#ResponseWriter">ResponseWriter</a>, r *<a href="#Request">Request</a>, name <a href="/builtin#string">string</a>)</pre> </div> <p>ServeFile replies to the request with the contents of the named file or directory. </p><p>If the provided file or directory name is a relative path, it is interpreted relative to the current directory and may ascend to parent directories. If the provided name is constructed from user input, it should be sanitized before calling <a href="#ServeFile">ServeFile</a>. </p><p>As a precaution, ServeFile will reject requests where r.URL.Path contains a ".." path element; this protects against callers who might unsafely use <a href="/path/filepath#Join">filepath.Join</a> on r.URL.Path without sanitizing it and then use that filepath.Join result as the name argument. </p><p>As another special case, ServeFile redirects any request where r.URL.Path ends in "/index.html" to the same path, without the final "index.html". To avoid such redirects either modify the path or use <a href="#ServeContent">ServeContent</a>. </p><p>Outside of those two special cases, ServeFile does not use r.URL.Path for selecting the file or directory to serve; only the file or directory provided in the name argument is used. </p> </div><div class="Documentation-function"> <h4 tabindex="-1" id="ServeFileFS" data-kind="function" class="Documentation-functionHeader"> <span>func <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/fs.go;l=840">ServeFileFS</a> <a class="Documentation-idLink" href="#ServeFileFS" title="Go to ServeFileFS" aria-label="Go to ServeFileFS">¶</a></span> <span class="Documentation-sinceVersion"> <span class="Documentation-sinceVersionLabel">added in</span> <span class="Documentation-sinceVersionVersion">go1.22.0</span> </span> </h4> <div class="Documentation-declaration"> <pre>func ServeFileFS(w <a href="#ResponseWriter">ResponseWriter</a>, r *<a href="#Request">Request</a>, fsys <a href="/io/fs">fs</a>.<a href="/io/fs#FS">FS</a>, name <a href="/builtin#string">string</a>)</pre> </div> <p>ServeFileFS replies to the request with the contents of the named file or directory from the file system fsys. The files provided by fsys must implement <a href="/io#Seeker">io.Seeker</a>. </p><p>If the provided name is constructed from user input, it should be sanitized before calling <a href="#ServeFileFS">ServeFileFS</a>. </p><p>As a precaution, ServeFileFS will reject requests where r.URL.Path contains a ".." path element; this protects against callers who might unsafely use <a href="/path/filepath#Join">filepath.Join</a> on r.URL.Path without sanitizing it and then use that filepath.Join result as the name argument. </p><p>As another special case, ServeFileFS redirects any request where r.URL.Path ends in "/index.html" to the same path, without the final "index.html". To avoid such redirects either modify the path or use <a href="#ServeContent">ServeContent</a>. </p><p>Outside of those two special cases, ServeFileFS does not use r.URL.Path for selecting the file or directory to serve; only the file or directory provided in the name argument is used. </p> </div><div class="Documentation-function"> <h4 tabindex="-1" id="ServeTLS" data-kind="function" class="Documentation-functionHeader"> <span>func <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/server.go;l=2947">ServeTLS</a> <a class="Documentation-idLink" href="#ServeTLS" title="Go to ServeTLS" aria-label="Go to ServeTLS">¶</a></span> <span class="Documentation-sinceVersion"> <span class="Documentation-sinceVersionLabel">added in</span> <span class="Documentation-sinceVersionVersion">go1.9</span> </span> </h4> <div class="Documentation-declaration"> <pre>func ServeTLS(l <a href="/net">net</a>.<a href="/net#Listener">Listener</a>, handler <a href="#Handler">Handler</a>, certFile, keyFile <a href="/builtin#string">string</a>) <a href="/builtin#error">error</a></pre> </div> <p>ServeTLS accepts incoming HTTPS connections on the listener l, creating a new service goroutine for each. The service goroutines read requests and then call handler to reply to them. </p><p>The handler is typically nil, in which case <a href="#DefaultServeMux">DefaultServeMux</a> is used. </p><p>Additionally, files containing a certificate and matching private key for the server must be provided. If the certificate is signed by a certificate authority, the certFile should be the concatenation of the server's certificate, any intermediates, and the CA's certificate. </p><p>ServeTLS always returns a non-nil error. </p> </div><div class="Documentation-function"> <h4 tabindex="-1" id="SetCookie" data-kind="function" class="Documentation-functionHeader"> <span>func <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/cookie.go;l=217">SetCookie</a> <a class="Documentation-idLink" href="#SetCookie" title="Go to SetCookie" aria-label="Go to SetCookie">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>func SetCookie(w <a href="#ResponseWriter">ResponseWriter</a>, cookie *<a href="#Cookie">Cookie</a>)</pre> </div> <p>SetCookie adds a Set-Cookie header to the provided <a href="#ResponseWriter">ResponseWriter</a>'s headers. The provided cookie must have a valid Name. Invalid cookies may be silently dropped. </p> </div><div class="Documentation-function"> <h4 tabindex="-1" id="StatusText" data-kind="function" class="Documentation-functionHeader"> <span>func <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/status.go;l=81">StatusText</a> <a class="Documentation-idLink" href="#StatusText" title="Go to StatusText" aria-label="Go to StatusText">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>func StatusText(code <a href="/builtin#int">int</a>) <a href="/builtin#string">string</a></pre> </div> <p>StatusText returns a text for the HTTP status code. It returns the empty string if the code is unknown. </p> </div></section> <h3 tabindex="-1" id="pkg-types" class="Documentation-typesHeader">Types <a href="#pkg-types" title="Go to Types" aria-label="Go to Types">¶</a></h3> <section class="Documentation-types"><div class="Documentation-type"> <h4 tabindex="-1" id="Client" data-kind="type" class="Documentation-typeHeader"> <span>type <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/client.go;l=57">Client</a> <a class="Documentation-idLink" href="#Client" title="Go to Client" aria-label="Go to Client">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>type Client struct { <span id="Client.Transport" data-kind="field"> <span class="comment">// Transport specifies the mechanism by which individual</span> </span> <span class="comment">// HTTP requests are made.</span> <span class="comment">// If nil, DefaultTransport is used.</span> Transport <a href="#RoundTripper">RoundTripper</a> <span id="Client.CheckRedirect" data-kind="field"> <span class="comment">// CheckRedirect specifies the policy for handling redirects.</span> </span> <span class="comment">// If CheckRedirect is not nil, the client calls it before</span> <span class="comment">// following an HTTP redirect. The arguments req and via are</span> <span class="comment">// the upcoming request and the requests made already, oldest</span> <span class="comment">// first. If CheckRedirect returns an error, the Client's Get</span> <span class="comment">// method returns both the previous Response (with its Body</span> <span class="comment">// closed) and CheckRedirect's error (wrapped in a url.Error)</span> <span class="comment">// instead of issuing the Request req.</span> <span class="comment">// As a special case, if CheckRedirect returns ErrUseLastResponse,</span> <span class="comment">// then the most recent response is returned with its body</span> <span class="comment">// unclosed, along with a nil error.</span> <span class="comment">//</span> <span class="comment">// If CheckRedirect is nil, the Client uses its default policy,</span> <span class="comment">// which is to stop after 10 consecutive requests.</span> CheckRedirect func(req *<a href="#Request">Request</a>, via []*<a href="#Request">Request</a>) <a href="/builtin#error">error</a> <span id="Client.Jar" data-kind="field"> <span class="comment">// Jar specifies the cookie jar.</span> </span> <span class="comment">//</span> <span class="comment">// The Jar is used to insert relevant cookies into every</span> <span class="comment">// outbound Request and is updated with the cookie values</span> <span class="comment">// of every inbound Response. The Jar is consulted for every</span> <span class="comment">// redirect that the Client follows.</span> <span class="comment">//</span> <span class="comment">// If Jar is nil, cookies are only sent if they are explicitly</span> <span class="comment">// set on the Request.</span> Jar <a href="#CookieJar">CookieJar</a> <span id="Client.Timeout" data-kind="field"> <span class="comment">// Timeout specifies a time limit for requests made by this</span> </span> <span class="comment">// Client. The timeout includes connection time, any</span> <span class="comment">// redirects, and reading the response body. The timer remains</span> <span class="comment">// running after Get, Head, Post, or Do return and will</span> <span class="comment">// interrupt reading of the Response.Body.</span> <span class="comment">//</span> <span class="comment">// A Timeout of zero means no timeout.</span> <span class="comment">//</span> <span class="comment">// The Client cancels requests to the underlying Transport</span> <span class="comment">// as if the Request's Context ended.</span> <span class="comment">//</span> <span class="comment">// For compatibility, the Client will also use the deprecated</span> <span class="comment">// CancelRequest method on Transport if found. New</span> <span class="comment">// RoundTripper implementations should use the Request's Context</span> <span class="comment">// for cancellation instead of implementing CancelRequest.</span> Timeout <a href="/time">time</a>.<a href="/time#Duration">Duration</a> }</pre> </div> <p>A Client is an HTTP client. Its zero value (<a href="#DefaultClient">DefaultClient</a>) is a usable client that uses <a href="#DefaultTransport">DefaultTransport</a>. </p><p>The [Client.Transport] typically has internal state (cached TCP connections), so Clients should be reused instead of created as needed. Clients are safe for concurrent use by multiple goroutines. </p><p>A Client is higher-level than a <a href="#RoundTripper">RoundTripper</a> (such as <a href="#Transport">Transport</a>) and additionally handles HTTP details such as cookies and redirects. </p><p>When following redirects, the Client will forward all headers set on the initial <a href="#Request">Request</a> except: </p><ul class="Documentation-bulletList"> <li>when forwarding sensitive headers like "Authorization", "WWW-Authenticate", and "Cookie" to untrusted targets. These headers will be ignored when following a redirect to a domain that is not a subdomain match or exact match of the initial domain. For example, a redirect from "foo.com" to either "foo.com" or "sub.foo.com" will forward the sensitive headers, but a redirect to "bar.com" will not.</li> <li>when forwarding the "Cookie" header with a non-nil cookie Jar. Since each redirect may mutate the state of the cookie jar, a redirect may possibly alter a cookie set in the initial request. When forwarding the "Cookie" header, any mutated cookies will be omitted, with the expectation that the Jar will insert those mutated cookies with the updated values (assuming the origin matches). If Jar is nil, the initial cookies are forwarded without change.</li> </ul> <div class="Documentation-typeMethod"> <h4 tabindex="-1" id="Client.CloseIdleConnections" data-kind="method" class="Documentation-typeMethodHeader"> <span>func (*Client) <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/client.go;l=951">CloseIdleConnections</a> <a class="Documentation-idLink" href="#Client.CloseIdleConnections" title="Go to Client.CloseIdleConnections" aria-label="Go to Client.CloseIdleConnections">¶</a></span> <span class="Documentation-sinceVersion"> <span class="Documentation-sinceVersionLabel">added in</span> <span class="Documentation-sinceVersionVersion">go1.12</span> </span> </h4> <div class="Documentation-declaration"> <pre>func (c *<a href="#Client">Client</a>) CloseIdleConnections()</pre> </div> <p>CloseIdleConnections closes any connections on its <a href="#Transport">Transport</a> which were previously connected from previous requests but are now sitting idle in a "keep-alive" state. It does not interrupt any connections currently in use. </p><p>If [Client.Transport] does not have a <a href="#Client.CloseIdleConnections">Client.CloseIdleConnections</a> method then this method does nothing. </p> </div><div class="Documentation-typeMethod"> <h4 tabindex="-1" id="Client.Do" data-kind="method" class="Documentation-typeMethodHeader"> <span>func (*Client) <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/client.go;l=586">Do</a> <a class="Documentation-idLink" href="#Client.Do" title="Go to Client.Do" aria-label="Go to Client.Do">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>func (c *<a href="#Client">Client</a>) Do(req *<a href="#Request">Request</a>) (*<a href="#Response">Response</a>, <a href="/builtin#error">error</a>)</pre> </div> <p>Do sends an HTTP request and returns an HTTP response, following policy (such as redirects, cookies, auth) as configured on the client. </p><p>An error is returned if caused by client policy (such as CheckRedirect), or failure to speak HTTP (such as a network connectivity problem). A non-2xx status code doesn't cause an error. </p><p>If the returned error is nil, the <a href="#Response">Response</a> will contain a non-nil Body which the user is expected to close. If the Body is not both read to EOF and closed, the <a href="#Client">Client</a>'s underlying <a href="#RoundTripper">RoundTripper</a> (typically <a href="#Transport">Transport</a>) may not be able to re-use a persistent TCP connection to the server for a subsequent "keep-alive" request. </p><p>The request Body, if non-nil, will be closed by the underlying Transport, even on errors. The Body may be closed asynchronously after Do returns. </p><p>On error, any Response can be ignored. A non-nil Response with a non-nil error only occurs when CheckRedirect fails, and even then the returned [Response.Body] is already closed. </p><p>Generally <a href="#Get">Get</a>, <a href="#Post">Post</a>, or <a href="#PostForm">PostForm</a> will be used instead of Do. </p><p>If the server replies with a redirect, the Client first uses the CheckRedirect function to determine whether the redirect should be followed. If permitted, a 301, 302, or 303 redirect causes subsequent requests to use HTTP method GET (or HEAD if the original request was HEAD), with no body. A 307 or 308 redirect preserves the original HTTP method and body, provided that the [Request.GetBody] function is defined. The <a href="#NewRequest">NewRequest</a> function automatically sets GetBody for common standard library body types. </p><p>Any returned error will be of type <a href="/net/url#Error">*url.Error</a>. The url.Error value's Timeout method will report true if the request timed out. </p> </div><div class="Documentation-typeMethod"> <h4 tabindex="-1" id="Client.Get" data-kind="method" class="Documentation-typeMethodHeader"> <span>func (*Client) <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/client.go;l=479">Get</a> <a class="Documentation-idLink" href="#Client.Get" title="Go to Client.Get" aria-label="Go to Client.Get">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>func (c *<a href="#Client">Client</a>) Get(url <a href="/builtin#string">string</a>) (resp *<a href="#Response">Response</a>, err <a href="/builtin#error">error</a>)</pre> </div> <p>Get issues a GET to the specified URL. If the response is one of the following redirect codes, Get follows the redirect after calling the [Client.CheckRedirect] function: </p><pre>301 (Moved Permanently) 302 (Found) 303 (See Other) 307 (Temporary Redirect) 308 (Permanent Redirect) </pre><p>An error is returned if the [Client.CheckRedirect] function fails or if there was an HTTP protocol error. A non-2xx response doesn't cause an error. Any returned error will be of type <a href="/net/url#Error">*url.Error</a>. The url.Error value's Timeout method will report true if the request timed out. </p><p>When err is nil, resp always contains a non-nil resp.Body. Caller should close resp.Body when done reading from it. </p><p>To make a request with custom headers, use <a href="#NewRequest">NewRequest</a> and <a href="#Client.Do">Client.Do</a>. </p><p>To make a request with a specified context.Context, use <a href="#NewRequestWithContext">NewRequestWithContext</a> and Client.Do. </p> </div><div class="Documentation-typeMethod"> <h4 tabindex="-1" id="Client.Head" data-kind="method" class="Documentation-typeMethodHeader"> <span>func (*Client) <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/client.go;l=936">Head</a> <a class="Documentation-idLink" href="#Client.Head" title="Go to Client.Head" aria-label="Go to Client.Head">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>func (c *<a href="#Client">Client</a>) Head(url <a href="/builtin#string">string</a>) (resp *<a href="#Response">Response</a>, err <a href="/builtin#error">error</a>)</pre> </div> <p>Head issues a HEAD to the specified URL. If the response is one of the following redirect codes, Head follows the redirect after calling the [Client.CheckRedirect] function: </p><pre>301 (Moved Permanently) 302 (Found) 303 (See Other) 307 (Temporary Redirect) 308 (Permanent Redirect) </pre><p>To make a request with a specified <a href="/context#Context">context.Context</a>, use <a href="#NewRequestWithContext">NewRequestWithContext</a> and <a href="#Client.Do">Client.Do</a>. </p> </div><div class="Documentation-typeMethod"> <h4 tabindex="-1" id="Client.Post" data-kind="method" class="Documentation-typeMethodHeader"> <span>func (*Client) <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/client.go;l=859">Post</a> <a class="Documentation-idLink" href="#Client.Post" title="Go to Client.Post" aria-label="Go to Client.Post">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>func (c *<a href="#Client">Client</a>) Post(url, contentType <a href="/builtin#string">string</a>, body <a href="/io">io</a>.<a href="/io#Reader">Reader</a>) (resp *<a href="#Response">Response</a>, err <a href="/builtin#error">error</a>)</pre> </div> <p>Post issues a POST to the specified URL. </p><p>Caller should close resp.Body when done reading from it. </p><p>If the provided body is an <a href="/io#Closer">io.Closer</a>, it is closed after the request. </p><p>To set custom headers, use <a href="#NewRequest">NewRequest</a> and <a href="#Client.Do">Client.Do</a>. </p><p>To make a request with a specified context.Context, use <a href="#NewRequestWithContext">NewRequestWithContext</a> and <a href="#Client.Do">Client.Do</a>. </p><p>See the Client.Do method documentation for details on how redirects are handled. </p> </div><div class="Documentation-typeMethod"> <h4 tabindex="-1" id="Client.PostForm" data-kind="method" class="Documentation-typeMethodHeader"> <span>func (*Client) <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/client.go;l=902">PostForm</a> <a class="Documentation-idLink" href="#Client.PostForm" title="Go to Client.PostForm" aria-label="Go to Client.PostForm">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>func (c *<a href="#Client">Client</a>) PostForm(url <a href="/builtin#string">string</a>, data <a href="/net/url">url</a>.<a href="/net/url#Values">Values</a>) (resp *<a href="#Response">Response</a>, err <a href="/builtin#error">error</a>)</pre> </div> <p>PostForm issues a POST to the specified URL, with data's keys and values URL-encoded as the request body. </p><p>The Content-Type header is set to application/x-www-form-urlencoded. To set other headers, use <a href="#NewRequest">NewRequest</a> and <a href="#Client.Do">Client.Do</a>. </p><p>When err is nil, resp always contains a non-nil resp.Body. Caller should close resp.Body when done reading from it. </p><p>See the Client.Do method documentation for details on how redirects are handled. </p><p>To make a request with a specified context.Context, use <a href="#NewRequestWithContext">NewRequestWithContext</a> and Client.Do. </p> </div> </div><div class="Documentation-type"> <details class="Documentation-deprecatedDetails js-deprecatedDetails"> <summary> <h4 tabindex="-1" id="CloseNotifier" data-kind="type" class="Documentation-typeHeader"> <span class="Documentation-deprecatedTitle"> type <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/server.go;l=217">CloseNotifier</a> <span class="Documentation-deprecatedTag">deprecated</span> <span class="Documentation-deprecatedBody"></span> </span> <span class="Documentation-sinceVersion"> <span class="Documentation-sinceVersionLabel">added in</span> <span class="Documentation-sinceVersionVersion">go1.1</span> </span> </h4> </summary> <div class="go-Message go-Message--warning Documentation-deprecatedItemBody"> <div class="Documentation-declaration"> <pre>type CloseNotifier interface { <span id="CloseNotifier.CloseNotify" data-kind="method"> <span class="comment">// CloseNotify returns a channel that receives at most a</span> </span> <span class="comment">// single value (true) when the client connection has gone</span> <span class="comment">// away.</span> <span class="comment">//</span> <span class="comment">// CloseNotify may wait to notify until Request.Body has been</span> <span class="comment">// fully read.</span> <span class="comment">//</span> <span class="comment">// After the Handler has returned, there is no guarantee</span> <span class="comment">// that the channel receives a value.</span> <span class="comment">//</span> <span class="comment">// If the protocol is HTTP/1.1 and CloseNotify is called while</span> <span class="comment">// processing an idempotent request (such as GET) while</span> <span class="comment">// HTTP/1.1 pipelining is in use, the arrival of a subsequent</span> <span class="comment">// pipelined request may cause a value to be sent on the</span> <span class="comment">// returned channel. In practice HTTP/1.1 pipelining is not</span> <span class="comment">// enabled in browsers and not seen often in the wild. If this</span> <span class="comment">// is a problem, use HTTP/2 or only use CloseNotify on methods</span> <span class="comment">// such as POST.</span> CloseNotify() <-chan <a href="/builtin#bool">bool</a> }</pre> </div> <p>The CloseNotifier interface is implemented by ResponseWriters which allow detecting when the underlying connection has gone away. </p><p>This mechanism can be used to cancel long operations on the server if the client has disconnected before the response is ready. </p><p>Deprecated: the CloseNotifier interface predates Go's context package. New code should use <a href="#Request.Context">Request.Context</a> instead. </p> </div> </details> </div><div class="Documentation-type"> <h4 tabindex="-1" id="ConnState" data-kind="type" class="Documentation-typeHeader"> <span>type <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/server.go;l=3227">ConnState</a> <a class="Documentation-idLink" href="#ConnState" title="Go to ConnState" aria-label="Go to ConnState">¶</a></span> <span class="Documentation-sinceVersion"> <span class="Documentation-sinceVersionLabel">added in</span> <span class="Documentation-sinceVersionVersion">go1.3</span> </span> </h4> <div class="Documentation-declaration"> <pre>type ConnState <a href="/builtin#int">int</a></pre> </div> <p>A ConnState represents the state of a client connection to a server. It's used by the optional [Server.ConnState] hook. </p> <div class="Documentation-typeConstant"> <div class="Documentation-declaration"> <pre>const ( <span id="StateNew" data-kind="constant"> <span class="comment">// StateNew represents a new connection that is expected to</span> </span> <span class="comment">// send a request immediately. Connections begin at this</span> <span class="comment">// state and then transition to either StateActive or</span> <span class="comment">// StateClosed.</span> StateNew <a href="#ConnState">ConnState</a> = <a href="/builtin#iota">iota</a> <span id="StateActive" data-kind="constant"> <span class="comment">// StateActive represents a connection that has read 1 or more</span> </span> <span class="comment">// bytes of a request. The Server.ConnState hook for</span> <span class="comment">// StateActive fires before the request has entered a handler</span> <span class="comment">// and doesn't fire again until the request has been</span> <span class="comment">// handled. After the request is handled, the state</span> <span class="comment">// transitions to StateClosed, StateHijacked, or StateIdle.</span> <span class="comment">// For HTTP/2, StateActive fires on the transition from zero</span> <span class="comment">// to one active request, and only transitions away once all</span> <span class="comment">// active requests are complete. That means that ConnState</span> <span class="comment">// cannot be used to do per-request work; ConnState only notes</span> <span class="comment">// the overall state of the connection.</span> StateActive <span id="StateIdle" data-kind="constant"> <span class="comment">// StateIdle represents a connection that has finished</span> </span> <span class="comment">// handling a request and is in the keep-alive state, waiting</span> <span class="comment">// for a new request. Connections transition from StateIdle</span> <span class="comment">// to either StateActive or StateClosed.</span> StateIdle <span id="StateHijacked" data-kind="constant"> <span class="comment">// StateHijacked represents a hijacked connection.</span> </span> <span class="comment">// This is a terminal state. It does not transition to StateClosed.</span> StateHijacked <span id="StateClosed" data-kind="constant"> <span class="comment">// StateClosed represents a closed connection.</span> </span> <span class="comment">// This is a terminal state. Hijacked connections do not</span> <span class="comment">// transition to StateClosed.</span> StateClosed )</pre> </div> </div><div class="Documentation-typeMethod"> <h4 tabindex="-1" id="ConnState.String" data-kind="method" class="Documentation-typeMethodHeader"> <span>func (ConnState) <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/server.go;l=3273">String</a> <a class="Documentation-idLink" href="#ConnState.String" title="Go to ConnState.String" aria-label="Go to ConnState.String">¶</a></span> <span class="Documentation-sinceVersion"> <span class="Documentation-sinceVersionLabel">added in</span> <span class="Documentation-sinceVersionVersion">go1.3</span> </span> </h4> <div class="Documentation-declaration"> <pre>func (c <a href="#ConnState">ConnState</a>) String() <a href="/builtin#string">string</a></pre> </div> </div> </div><div class="Documentation-type"> <h4 tabindex="-1" id="Cookie" data-kind="type" class="Documentation-typeHeader"> <span>type <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/cookie.go;l=23">Cookie</a> <a class="Documentation-idLink" href="#Cookie" title="Go to Cookie" aria-label="Go to Cookie">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>type Cookie struct { <span id="Cookie.Name" data-kind="field"> Name <a href="/builtin#string">string</a> </span><span id="Cookie.Value" data-kind="field"> Value <a href="/builtin#string">string</a> </span><span id="Cookie.Quoted" data-kind="field"> Quoted <a href="/builtin#bool">bool</a> <span class="comment">// indicates whether the Value was originally quoted</span> </span> <span id="Cookie.Path" data-kind="field"> Path <a href="/builtin#string">string</a> <span class="comment">// optional</span> </span><span id="Cookie.Domain" data-kind="field"> Domain <a href="/builtin#string">string</a> <span class="comment">// optional</span> </span><span id="Cookie.Expires" data-kind="field"> Expires <a href="/time">time</a>.<a href="/time#Time">Time</a> <span class="comment">// optional</span> </span><span id="Cookie.RawExpires" data-kind="field"> RawExpires <a href="/builtin#string">string</a> <span class="comment">// for reading cookies only</span> </span> <span class="comment">// MaxAge=0 means no 'Max-Age' attribute specified.</span> <span class="comment">// MaxAge<0 means delete cookie now, equivalently 'Max-Age: 0'</span> <span class="comment">// MaxAge>0 means Max-Age attribute present and given in seconds</span> <span id="Cookie.MaxAge" data-kind="field"> MaxAge <a href="/builtin#int">int</a> </span><span id="Cookie.Secure" data-kind="field"> Secure <a href="/builtin#bool">bool</a> </span><span id="Cookie.HttpOnly" data-kind="field"> HttpOnly <a href="/builtin#bool">bool</a> </span><span id="Cookie.SameSite" data-kind="field"> SameSite <a href="#SameSite">SameSite</a> </span><span id="Cookie.Partitioned" data-kind="field"> Partitioned <a href="/builtin#bool">bool</a> </span><span id="Cookie.Raw" data-kind="field"> Raw <a href="/builtin#string">string</a> </span><span id="Cookie.Unparsed" data-kind="field"> Unparsed []<a href="/builtin#string">string</a> <span class="comment">// Raw text of unparsed attribute-value pairs</span> </span>}</pre> </div> <p>A Cookie represents an HTTP cookie as sent in the Set-Cookie header of an HTTP response or the Cookie header of an HTTP request. </p><p>See <a href="https://tools.ietf.org/html/rfc6265">https://tools.ietf.org/html/rfc6265</a> for details. </p> <div class="Documentation-typeFunc"> <h4 tabindex="-1" id="ParseCookie" data-kind="function" class="Documentation-typeFuncHeader"> <span>func <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/cookie.go;l=70">ParseCookie</a> <a class="Documentation-idLink" href="#ParseCookie" title="Go to ParseCookie" aria-label="Go to ParseCookie">¶</a></span> <span class="Documentation-sinceVersion"> <span class="Documentation-sinceVersionLabel">added in</span> <span class="Documentation-sinceVersionVersion">go1.23.0</span> </span> </h4> <div class="Documentation-declaration"> <pre>func ParseCookie(line <a href="/builtin#string">string</a>) ([]*<a href="#Cookie">Cookie</a>, <a href="/builtin#error">error</a>)</pre> </div> <p>ParseCookie parses a Cookie header value and returns all the cookies which were set in it. Since the same cookie name can appear multiple times the returned Values can contain more than one value for a given key. </p> </div><div class="Documentation-typeFunc"> <h4 tabindex="-1" id="ParseSetCookie" data-kind="function" class="Documentation-typeFuncHeader"> <span>func <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/cookie.go;l=96">ParseSetCookie</a> <a class="Documentation-idLink" href="#ParseSetCookie" title="Go to ParseSetCookie" aria-label="Go to ParseSetCookie">¶</a></span> <span class="Documentation-sinceVersion"> <span class="Documentation-sinceVersionLabel">added in</span> <span class="Documentation-sinceVersionVersion">go1.23.0</span> </span> </h4> <div class="Documentation-declaration"> <pre>func ParseSetCookie(line <a href="/builtin#string">string</a>) (*<a href="#Cookie">Cookie</a>, <a href="/builtin#error">error</a>)</pre> </div> <p>ParseSetCookie parses a Set-Cookie header value and returns a cookie. It returns an error on syntax error. </p> </div><div class="Documentation-typeMethod"> <h4 tabindex="-1" id="Cookie.String" data-kind="method" class="Documentation-typeMethodHeader"> <span>func (*Cookie) <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/cookie.go;l=227">String</a> <a class="Documentation-idLink" href="#Cookie.String" title="Go to Cookie.String" aria-label="Go to Cookie.String">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>func (c *<a href="#Cookie">Cookie</a>) String() <a href="/builtin#string">string</a></pre> </div> <p>String returns the serialization of the cookie for use in a <a href="#Cookie">Cookie</a> header (if only Name and Value are set) or a Set-Cookie response header (if other fields are set). If c is nil or c.Name is invalid, the empty string is returned. </p> </div><div class="Documentation-typeMethod"> <h4 tabindex="-1" id="Cookie.Valid" data-kind="method" class="Documentation-typeMethodHeader"> <span>func (*Cookie) <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/cookie.go;l=294">Valid</a> <a class="Documentation-idLink" href="#Cookie.Valid" title="Go to Cookie.Valid" aria-label="Go to Cookie.Valid">¶</a></span> <span class="Documentation-sinceVersion"> <span class="Documentation-sinceVersionLabel">added in</span> <span class="Documentation-sinceVersionVersion">go1.18</span> </span> </h4> <div class="Documentation-declaration"> <pre>func (c *<a href="#Cookie">Cookie</a>) Valid() <a href="/builtin#error">error</a></pre> </div> <p>Valid reports whether the cookie is valid. </p> </div> </div><div class="Documentation-type"> <h4 tabindex="-1" id="CookieJar" data-kind="type" class="Documentation-typeHeader"> <span>type <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/jar.go;l=17">CookieJar</a> <a class="Documentation-idLink" href="#CookieJar" title="Go to CookieJar" aria-label="Go to CookieJar">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>type CookieJar interface { <span id="CookieJar.SetCookies" data-kind="method"> <span class="comment">// SetCookies handles the receipt of the cookies in a reply for the</span> </span> <span class="comment">// given URL. It may or may not choose to save the cookies, depending</span> <span class="comment">// on the jar's policy and implementation.</span> SetCookies(u *<a href="/net/url">url</a>.<a href="/net/url#URL">URL</a>, cookies []*<a href="#Cookie">Cookie</a>) <span id="CookieJar.Cookies" data-kind="method"> <span class="comment">// Cookies returns the cookies to send in a request for the given URL.</span> </span> <span class="comment">// It is up to the implementation to honor the standard cookie use</span> <span class="comment">// restrictions such as in <a href="https://rfc-editor.org/rfc/rfc6265.html">RFC 6265</a>.</span> Cookies(u *<a href="/net/url">url</a>.<a href="/net/url#URL">URL</a>) []*<a href="#Cookie">Cookie</a> }</pre> </div> <p>A CookieJar manages storage and use of cookies in HTTP requests. </p><p>Implementations of CookieJar must be safe for concurrent use by multiple goroutines. </p><p>The net/http/cookiejar package provides a CookieJar implementation. </p> </div><div class="Documentation-type"> <h4 tabindex="-1" id="Dir" data-kind="type" class="Documentation-typeHeader"> <span>type <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/fs.go;l=44">Dir</a> <a class="Documentation-idLink" href="#Dir" title="Go to Dir" aria-label="Go to Dir">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>type Dir <a href="/builtin#string">string</a></pre> </div> <p>A Dir implements <a href="#FileSystem">FileSystem</a> using the native file system restricted to a specific directory tree. </p><p>While the [FileSystem.Open] method takes '/'-separated paths, a Dir's string value is a directory path on the native file system, not a URL, so it is separated by <a href="/path/filepath#Separator">filepath.Separator</a>, which isn't necessarily '/'. </p><p>Note that Dir could expose sensitive files and directories. Dir will follow symlinks pointing out of the directory tree, which can be especially dangerous if serving from a directory in which users are able to create arbitrary symlinks. Dir will also allow access to files and directories starting with a period, which could expose sensitive directories like .git or sensitive files like .htpasswd. To exclude files with a leading period, remove the files/directories from the server or create a custom FileSystem implementation. </p><p>An empty Dir is treated as ".". </p> <div class="Documentation-typeMethod"> <h4 tabindex="-1" id="Dir.Open" data-kind="method" class="Documentation-typeMethodHeader"> <span>func (Dir) <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/fs.go;l=72">Open</a> <a class="Documentation-idLink" href="#Dir.Open" title="Go to Dir.Open" aria-label="Go to Dir.Open">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>func (d <a href="#Dir">Dir</a>) Open(name <a href="/builtin#string">string</a>) (<a href="#File">File</a>, <a href="/builtin#error">error</a>)</pre> </div> <p>Open implements <a href="#FileSystem">FileSystem</a> using <a href="/os#Open">os.Open</a>, opening files for reading rooted and relative to the directory d. </p> </div> </div><div class="Documentation-type"> <h4 tabindex="-1" id="File" data-kind="type" class="Documentation-typeHeader"> <span>type <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/fs.go;l=108">File</a> <a class="Documentation-idLink" href="#File" title="Go to File" aria-label="Go to File">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>type File interface { <a href="/io">io</a>.<a href="/io#Closer">Closer</a> <a href="/io">io</a>.<a href="/io#Reader">Reader</a> <a href="/io">io</a>.<a href="/io#Seeker">Seeker</a> <span id="File.Readdir" data-kind="method"> Readdir(count <a href="/builtin#int">int</a>) ([]<a href="/io/fs">fs</a>.<a href="/io/fs#FileInfo">FileInfo</a>, <a href="/builtin#error">error</a>) </span><span id="File.Stat" data-kind="method"> Stat() (<a href="/io/fs">fs</a>.<a href="/io/fs#FileInfo">FileInfo</a>, <a href="/builtin#error">error</a>) </span>}</pre> </div> <p>A File is returned by a <a href="#FileSystem">FileSystem</a>'s Open method and can be served by the <a href="#FileServer">FileServer</a> implementation. </p><p>The methods should behave the same as those on an <a href="/os#File">*os.File</a>. </p> </div><div class="Documentation-type"> <h4 tabindex="-1" id="FileSystem" data-kind="type" class="Documentation-typeHeader"> <span>type <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/fs.go;l=100">FileSystem</a> <a class="Documentation-idLink" href="#FileSystem" title="Go to FileSystem" aria-label="Go to FileSystem">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>type FileSystem interface { <span id="FileSystem.Open" data-kind="method"> Open(name <a href="/builtin#string">string</a>) (<a href="#File">File</a>, <a href="/builtin#error">error</a>) </span>}</pre> </div> <p>A FileSystem implements access to a collection of named files. The elements in a file path are separated by slash ('/', U+002F) characters, regardless of host operating system convention. See the <a href="#FileServer">FileServer</a> function to convert a FileSystem to a <a href="#Handler">Handler</a>. </p><p>This interface predates the <a href="/io/fs#FS">fs.FS</a> interface, which can be used instead: the <a href="#FS">FS</a> adapter function converts an fs.FS to a FileSystem. </p> <div class="Documentation-typeFunc"> <h4 tabindex="-1" id="FS" data-kind="function" class="Documentation-typeFuncHeader"> <span>func <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/fs.go;l=946">FS</a> <a class="Documentation-idLink" href="#FS" title="Go to FS" aria-label="Go to FS">¶</a></span> <span class="Documentation-sinceVersion"> <span class="Documentation-sinceVersionLabel">added in</span> <span class="Documentation-sinceVersionVersion">go1.16</span> </span> </h4> <div class="Documentation-declaration"> <pre>func FS(fsys <a href="/io/fs">fs</a>.<a href="/io/fs#FS">FS</a>) <a href="#FileSystem">FileSystem</a></pre> </div> <p>FS converts fsys to a <a href="#FileSystem">FileSystem</a> implementation, for use with <a href="#FileServer">FileServer</a> and <a href="#NewFileTransport">NewFileTransport</a>. The files provided by fsys must implement <a href="/io#Seeker">io.Seeker</a>. </p> </div> </div><div class="Documentation-type"> <h4 tabindex="-1" id="Flusher" data-kind="type" class="Documentation-typeHeader"> <span>type <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/server.go;l=174">Flusher</a> <a class="Documentation-idLink" href="#Flusher" title="Go to Flusher" aria-label="Go to Flusher">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>type Flusher interface { <span id="Flusher.Flush" data-kind="method"> <span class="comment">// Flush sends any buffered data to the client.</span> </span> Flush() }</pre> </div> <p>The Flusher interface is implemented by ResponseWriters that allow an HTTP handler to flush buffered data to the client. </p><p>The default HTTP/1.x and HTTP/2 <a href="#ResponseWriter">ResponseWriter</a> implementations support <a href="#Flusher">Flusher</a>, but ResponseWriter wrappers may not. Handlers should always test for this ability at runtime. </p><p>Note that even for ResponseWriters that support Flush, if the client is connected through an HTTP proxy, the buffered data may not reach the client until the response completes. </p> </div><div class="Documentation-type"> <h4 tabindex="-1" id="HTTP2Config" data-kind="type" class="Documentation-typeHeader"> <span>type <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/http.go;l=230">HTTP2Config</a> <a class="Documentation-idLink" href="#HTTP2Config" title="Go to HTTP2Config" aria-label="Go to HTTP2Config">¶</a></span> <span class="Documentation-sinceVersion"> <span class="Documentation-sinceVersionLabel">added in</span> <span class="Documentation-sinceVersionVersion">go1.24.0</span> </span> </h4> <div class="Documentation-declaration"> <pre>type HTTP2Config struct { <span id="HTTP2Config.MaxConcurrentStreams" data-kind="field"> <span class="comment">// MaxConcurrentStreams optionally specifies the number of</span> </span> <span class="comment">// concurrent streams that a peer may have open at a time.</span> <span class="comment">// If zero, MaxConcurrentStreams defaults to at least 100.</span> MaxConcurrentStreams <a href="/builtin#int">int</a> <span id="HTTP2Config.MaxDecoderHeaderTableSize" data-kind="field"> <span class="comment">// MaxDecoderHeaderTableSize optionally specifies an upper limit for the</span> </span> <span class="comment">// size of the header compression table used for decoding headers sent</span> <span class="comment">// by the peer.</span> <span class="comment">// A valid value is less than 4MiB.</span> <span class="comment">// If zero or invalid, a default value is used.</span> MaxDecoderHeaderTableSize <a href="/builtin#int">int</a> <span id="HTTP2Config.MaxEncoderHeaderTableSize" data-kind="field"> <span class="comment">// MaxEncoderHeaderTableSize optionally specifies an upper limit for the</span> </span> <span class="comment">// header compression table used for sending headers to the peer.</span> <span class="comment">// A valid value is less than 4MiB.</span> <span class="comment">// If zero or invalid, a default value is used.</span> MaxEncoderHeaderTableSize <a href="/builtin#int">int</a> <span id="HTTP2Config.MaxReadFrameSize" data-kind="field"> <span class="comment">// MaxReadFrameSize optionally specifies the largest frame</span> </span> <span class="comment">// this endpoint is willing to read.</span> <span class="comment">// A valid value is between 16KiB and 16MiB, inclusive.</span> <span class="comment">// If zero or invalid, a default value is used.</span> MaxReadFrameSize <a href="/builtin#int">int</a> <span id="HTTP2Config.MaxReceiveBufferPerConnection" data-kind="field"> <span class="comment">// MaxReceiveBufferPerConnection is the maximum size of the</span> </span> <span class="comment">// flow control window for data received on a connection.</span> <span class="comment">// A valid value is at least 64KiB and less than 4MiB.</span> <span class="comment">// If invalid, a default value is used.</span> MaxReceiveBufferPerConnection <a href="/builtin#int">int</a> <span id="HTTP2Config.MaxReceiveBufferPerStream" data-kind="field"> <span class="comment">// MaxReceiveBufferPerStream is the maximum size of</span> </span> <span class="comment">// the flow control window for data received on a stream (request).</span> <span class="comment">// A valid value is less than 4MiB.</span> <span class="comment">// If zero or invalid, a default value is used.</span> MaxReceiveBufferPerStream <a href="/builtin#int">int</a> <span id="HTTP2Config.SendPingTimeout" data-kind="field"> <span class="comment">// SendPingTimeout is the timeout after which a health check using a ping</span> </span> <span class="comment">// frame will be carried out if no frame is received on a connection.</span> <span class="comment">// If zero, no health check is performed.</span> SendPingTimeout <a href="/time">time</a>.<a href="/time#Duration">Duration</a> <span id="HTTP2Config.PingTimeout" data-kind="field"> <span class="comment">// PingTimeout is the timeout after which a connection will be closed</span> </span> <span class="comment">// if a response to a ping is not received.</span> <span class="comment">// If zero, a default of 15 seconds is used.</span> PingTimeout <a href="/time">time</a>.<a href="/time#Duration">Duration</a> <span id="HTTP2Config.WriteByteTimeout" data-kind="field"> <span class="comment">// WriteByteTimeout is the timeout after which a connection will be</span> </span> <span class="comment">// closed if no data can be written to it. The timeout begins when data is</span> <span class="comment">// available to write, and is extended whenever any bytes are written.</span> WriteByteTimeout <a href="/time">time</a>.<a href="/time#Duration">Duration</a> <span id="HTTP2Config.PermitProhibitedCipherSuites" data-kind="field"> <span class="comment">// PermitProhibitedCipherSuites, if true, permits the use of</span> </span> <span class="comment">// cipher suites prohibited by the HTTP/2 spec.</span> PermitProhibitedCipherSuites <a href="/builtin#bool">bool</a> <span id="HTTP2Config.CountError" data-kind="field"> <span class="comment">// CountError, if non-nil, is called on HTTP/2 errors.</span> </span> <span class="comment">// It is intended to increment a metric for monitoring.</span> <span class="comment">// The errType contains only lowercase letters, digits, and underscores</span> <span class="comment">// (a-z, 0-9, _).</span> CountError func(errType <a href="/builtin#string">string</a>) }</pre> </div> <p>HTTP2Config defines HTTP/2 configuration parameters common to both <a href="#Transport">Transport</a> and <a href="#Server">Server</a>. </p> </div><div class="Documentation-type"> <h4 tabindex="-1" id="Handler" data-kind="type" class="Documentation-typeHeader"> <span>type <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/server.go;l=88">Handler</a> <a class="Documentation-idLink" href="#Handler" title="Go to Handler" aria-label="Go to Handler">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>type Handler interface { <span id="Handler.ServeHTTP" data-kind="method"> ServeHTTP(<a href="#ResponseWriter">ResponseWriter</a>, *<a href="#Request">Request</a>) </span>}</pre> </div> <p>A Handler responds to an HTTP request. </p><p>[Handler.ServeHTTP] should write reply headers and data to the <a href="#ResponseWriter">ResponseWriter</a> and then return. Returning signals that the request is finished; it is not valid to use the <a href="#ResponseWriter">ResponseWriter</a> or read from the [Request.Body] after or concurrently with the completion of the ServeHTTP call. </p><p>Depending on the HTTP client software, HTTP protocol version, and any intermediaries between the client and the Go server, it may not be possible to read from the [Request.Body] after writing to the <a href="#ResponseWriter">ResponseWriter</a>. Cautious handlers should read the [Request.Body] first, and then reply. </p><p>Except for reading the body, handlers should not modify the provided Request. </p><p>If ServeHTTP panics, the server (the caller of ServeHTTP) assumes that the effect of the panic was isolated to the active request. It recovers the panic, logs a stack trace to the server error log, and either closes the network connection or sends an HTTP/2 RST_STREAM, depending on the HTTP protocol. To abort a handler so the client sees an interrupted response but the server doesn't log an error, panic with the value <a href="#ErrAbortHandler">ErrAbortHandler</a>. </p> <div class="Documentation-typeFunc"> <h4 tabindex="-1" id="AllowQuerySemicolons" data-kind="function" class="Documentation-typeFuncHeader"> <span>func <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/server.go;l=3315">AllowQuerySemicolons</a> <a class="Documentation-idLink" href="#AllowQuerySemicolons" title="Go to AllowQuerySemicolons" aria-label="Go to AllowQuerySemicolons">¶</a></span> <span class="Documentation-sinceVersion"> <span class="Documentation-sinceVersionLabel">added in</span> <span class="Documentation-sinceVersionVersion">go1.17</span> </span> </h4> <div class="Documentation-declaration"> <pre>func AllowQuerySemicolons(h <a href="#Handler">Handler</a>) <a href="#Handler">Handler</a></pre> </div> <p>AllowQuerySemicolons returns a handler that serves requests by converting any unescaped semicolons in the URL query to ampersands, and invoking the handler h. </p><p>This restores the pre-Go 1.17 behavior of splitting query parameters on both semicolons and ampersands. (See golang.org/issue/25192). Note that this behavior doesn't match that of many proxies, and the mismatch can lead to security issues. </p><p>AllowQuerySemicolons should be invoked before <a href="#Request.ParseForm">Request.ParseForm</a> is called. </p> </div><div class="Documentation-typeFunc"> <h4 tabindex="-1" id="FileServer" data-kind="function" class="Documentation-typeFuncHeader"> <span>func <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/fs.go;l=963">FileServer</a> <a class="Documentation-idLink" href="#FileServer" title="Go to FileServer" aria-label="Go to FileServer">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>func FileServer(root <a href="#FileSystem">FileSystem</a>) <a href="#Handler">Handler</a></pre> </div> <p>FileServer returns a handler that serves HTTP requests with the contents of the file system rooted at root. </p><p>As a special case, the returned file server redirects any request ending in "/index.html" to the same path, without the final "index.html". </p><p>To use the operating system's file system implementation, use <a href="#Dir">http.Dir</a>: </p><pre>http.Handle("/", http.FileServer(http.Dir("/tmp"))) </pre><p>To use an <a href="/io/fs#FS">fs.FS</a> implementation, use <a href="#FileServerFS">http.FileServerFS</a> instead. </p> <details tabindex="-1" id="example-FileServer" class="Documentation-exampleDetails js-exampleContainer"> <summary class="Documentation-exampleDetailsHeader">Example <a href="#example-FileServer" title="Go to Example" aria-label="Go to Example">¶</a></summary> <div class="Documentation-exampleDetailsBody"> <pre class="Documentation-exampleCode"> package main import ( "log" "net/http" ) func main() { // Simple static webserver: log.Fatal(http.ListenAndServe(":8080", http.FileServer(http.Dir("/usr/share/doc")))) } </pre> <pre><span class="Documentation-exampleOutputLabel">Output:</span> <span class="Documentation-exampleOutput"></span></pre> </div> <div class="Documentation-exampleButtonsContainer"> <p class="Documentation-exampleError" role="alert" aria-atomic="true"></p> <button class="Documentation-exampleShareButton" aria-label="Share Code">Share</button> <button class="Documentation-exampleFormatButton" aria-label="Format Code">Format</button> <button class="Documentation-exampleRunButton" aria-label="Run Code">Run</button> </div></details> <details tabindex="-1" id="example-FileServer-DotFileHiding" class="Documentation-exampleDetails js-exampleContainer"> <summary class="Documentation-exampleDetailsHeader">Example (DotFileHiding) <a href="#example-FileServer-DotFileHiding" title="Go to Example (DotFileHiding)" aria-label="Go to Example (DotFileHiding)">¶</a></summary> <div class="Documentation-exampleDetailsBody"> <pre class="Documentation-exampleCode"> package main import ( "io" "io/fs" "log" "net/http" "strings" ) // containsDotFile reports whether name contains a path element starting with a period. // The name is assumed to be a delimited by forward slashes, as guaranteed // by the http.FileSystem interface. func containsDotFile(name string) bool { parts := strings.Split(name, "/") for _, part := range parts { if strings.HasPrefix(part, ".") { return true } } return false } // dotFileHidingFile is the http.File use in dotFileHidingFileSystem. // It is used to wrap the Readdir method of http.File so that we can // remove files and directories that start with a period from its output. type dotFileHidingFile struct { http.File } // Readdir is a wrapper around the Readdir method of the embedded File // that filters out all files that start with a period in their name. func (f dotFileHidingFile) Readdir(n int) (fis []fs.FileInfo, err error) { files, err := f.File.Readdir(n) for _, file := range files { // Filters out the dot files if !strings.HasPrefix(file.Name(), ".") { fis = append(fis, file) } } if err == nil && n > 0 && len(fis) == 0 { err = io.EOF } return } // dotFileHidingFileSystem is an http.FileSystem that hides // hidden "dot files" from being served. type dotFileHidingFileSystem struct { http.FileSystem } // Open is a wrapper around the Open method of the embedded FileSystem // that serves a 403 permission error when name has a file or directory // with whose name starts with a period in its path. func (fsys dotFileHidingFileSystem) Open(name string) (http.File, error) { if containsDotFile(name) { // If dot file, return 403 response return nil, fs.ErrPermission } file, err := fsys.FileSystem.Open(name) if err != nil { return nil, err } return dotFileHidingFile{file}, err } func main() { fsys := dotFileHidingFileSystem{http.Dir(".")} http.Handle("/", http.FileServer(fsys)) log.Fatal(http.ListenAndServe(":8080", nil)) } </pre> <pre><span class="Documentation-exampleOutputLabel">Output:</span> <span class="Documentation-exampleOutput"></span></pre> </div> <div class="Documentation-exampleButtonsContainer"> <p class="Documentation-exampleError" role="alert" aria-atomic="true"></p> <button class="Documentation-exampleShareButton" aria-label="Share Code">Share</button> <button class="Documentation-exampleFormatButton" aria-label="Format Code">Format</button> <button class="Documentation-exampleRunButton" aria-label="Run Code">Run</button> </div></details> <details tabindex="-1" id="example-FileServer-StripPrefix" class="Documentation-exampleDetails js-exampleContainer"> <summary class="Documentation-exampleDetailsHeader">Example (StripPrefix) <a href="#example-FileServer-StripPrefix" title="Go to Example (StripPrefix)" aria-label="Go to Example (StripPrefix)">¶</a></summary> <div class="Documentation-exampleDetailsBody"> <pre class="Documentation-exampleCode"> package main import ( "net/http" ) func main() { // To serve a directory on disk (/tmp) under an alternate URL // path (/tmpfiles/), use StripPrefix to modify the request // URL's path before the FileServer sees it: http.Handle("/tmpfiles/", http.StripPrefix("/tmpfiles/", http.FileServer(http.Dir("/tmp")))) } </pre> <pre><span class="Documentation-exampleOutputLabel">Output:</span> <span class="Documentation-exampleOutput"></span></pre> </div> <div class="Documentation-exampleButtonsContainer"> <p class="Documentation-exampleError" role="alert" aria-atomic="true"></p> <button class="Documentation-exampleShareButton" aria-label="Share Code">Share</button> <button class="Documentation-exampleFormatButton" aria-label="Format Code">Format</button> <button class="Documentation-exampleRunButton" aria-label="Run Code">Run</button> </div></details> </div><div class="Documentation-typeFunc"> <h4 tabindex="-1" id="FileServerFS" data-kind="function" class="Documentation-typeFuncHeader"> <span>func <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/fs.go;l=976">FileServerFS</a> <a class="Documentation-idLink" href="#FileServerFS" title="Go to FileServerFS" aria-label="Go to FileServerFS">¶</a></span> <span class="Documentation-sinceVersion"> <span class="Documentation-sinceVersionLabel">added in</span> <span class="Documentation-sinceVersionVersion">go1.22.0</span> </span> </h4> <div class="Documentation-declaration"> <pre>func FileServerFS(root <a href="/io/fs">fs</a>.<a href="/io/fs#FS">FS</a>) <a href="#Handler">Handler</a></pre> </div> <p>FileServerFS returns a handler that serves HTTP requests with the contents of the file system fsys. The files provided by fsys must implement <a href="/io#Seeker">io.Seeker</a>. </p><p>As a special case, the returned file server redirects any request ending in "/index.html" to the same path, without the final "index.html". </p><pre>http.Handle("/", http.FileServerFS(fsys)) </pre> </div><div class="Documentation-typeFunc"> <h4 tabindex="-1" id="MaxBytesHandler" data-kind="function" class="Documentation-typeFuncHeader"> <span>func <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/server.go;l=4057">MaxBytesHandler</a> <a class="Documentation-idLink" href="#MaxBytesHandler" title="Go to MaxBytesHandler" aria-label="Go to MaxBytesHandler">¶</a></span> <span class="Documentation-sinceVersion"> <span class="Documentation-sinceVersionLabel">added in</span> <span class="Documentation-sinceVersionVersion">go1.18</span> </span> </h4> <div class="Documentation-declaration"> <pre>func MaxBytesHandler(h <a href="#Handler">Handler</a>, n <a href="/builtin#int64">int64</a>) <a href="#Handler">Handler</a></pre> </div> <p>MaxBytesHandler returns a <a href="#Handler">Handler</a> that runs h with its <a href="#ResponseWriter">ResponseWriter</a> and [Request.Body] wrapped by a MaxBytesReader. </p> </div><div class="Documentation-typeFunc"> <h4 tabindex="-1" id="NotFoundHandler" data-kind="function" class="Documentation-typeFuncHeader"> <span>func <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/server.go;l=2334">NotFoundHandler</a> <a class="Documentation-idLink" href="#NotFoundHandler" title="Go to NotFoundHandler" aria-label="Go to NotFoundHandler">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>func NotFoundHandler() <a href="#Handler">Handler</a></pre> </div> <p>NotFoundHandler returns a simple request handler that replies to each request with a “404 page not found” reply. </p> <details tabindex="-1" id="example-NotFoundHandler" class="Documentation-exampleDetails js-exampleContainer"> <summary class="Documentation-exampleDetailsHeader">Example <a href="#example-NotFoundHandler" title="Go to Example" aria-label="Go to Example">¶</a></summary> <div class="Documentation-exampleDetailsBody"> <pre class="Documentation-exampleCode"> package main import ( "fmt" "log" "net/http" ) func newPeopleHandler() http.Handler { return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { fmt.Fprintln(w, "This is the people handler.") }) } func main() { mux := http.NewServeMux() // Create sample handler to returns 404 mux.Handle("/resources", http.NotFoundHandler()) // Create sample handler that returns 200 mux.Handle("/resources/people/", newPeopleHandler()) log.Fatal(http.ListenAndServe(":8080", mux)) } </pre> <pre><span class="Documentation-exampleOutputLabel">Output:</span> <span class="Documentation-exampleOutput"></span></pre> </div> <div class="Documentation-exampleButtonsContainer"> <p class="Documentation-exampleError" role="alert" aria-atomic="true"></p> <button class="Documentation-exampleShareButton" aria-label="Share Code">Share</button> <button class="Documentation-exampleFormatButton" aria-label="Format Code">Format</button> <button class="Documentation-exampleRunButton" aria-label="Run Code">Run</button> </div></details> </div><div class="Documentation-typeFunc"> <h4 tabindex="-1" id="RedirectHandler" data-kind="function" class="Documentation-typeFuncHeader"> <span>func <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/server.go;l=2458">RedirectHandler</a> <a class="Documentation-idLink" href="#RedirectHandler" title="Go to RedirectHandler" aria-label="Go to RedirectHandler">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>func RedirectHandler(url <a href="/builtin#string">string</a>, code <a href="/builtin#int">int</a>) <a href="#Handler">Handler</a></pre> </div> <p>RedirectHandler returns a request handler that redirects each request it receives to the given url using the given status code. </p><p>The provided code should be in the 3xx range and is usually <a href="#StatusMovedPermanently">StatusMovedPermanently</a>, <a href="#StatusFound">StatusFound</a> or <a href="#StatusSeeOther">StatusSeeOther</a>. </p> </div><div class="Documentation-typeFunc"> <h4 tabindex="-1" id="StripPrefix" data-kind="function" class="Documentation-typeFuncHeader"> <span>func <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/server.go;l=2342">StripPrefix</a> <a class="Documentation-idLink" href="#StripPrefix" title="Go to StripPrefix" aria-label="Go to StripPrefix">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>func StripPrefix(prefix <a href="/builtin#string">string</a>, h <a href="#Handler">Handler</a>) <a href="#Handler">Handler</a></pre> </div> <p>StripPrefix returns a handler that serves HTTP requests by removing the given prefix from the request URL's Path (and RawPath if set) and invoking the handler h. StripPrefix handles a request for a path that doesn't begin with prefix by replying with an HTTP 404 not found error. The prefix must match exactly: if the prefix in the request contains escaped characters the reply is also an HTTP 404 not found error. </p> <details tabindex="-1" id="example-StripPrefix" class="Documentation-exampleDetails js-exampleContainer"> <summary class="Documentation-exampleDetailsHeader">Example <a href="#example-StripPrefix" title="Go to Example" aria-label="Go to Example">¶</a></summary> <div class="Documentation-exampleDetailsBody"> <pre class="Documentation-exampleCode"> package main import ( "net/http" ) func main() { // To serve a directory on disk (/tmp) under an alternate URL // path (/tmpfiles/), use StripPrefix to modify the request // URL's path before the FileServer sees it: http.Handle("/tmpfiles/", http.StripPrefix("/tmpfiles/", http.FileServer(http.Dir("/tmp")))) } </pre> <pre><span class="Documentation-exampleOutputLabel">Output:</span> <span class="Documentation-exampleOutput"></span></pre> </div> <div class="Documentation-exampleButtonsContainer"> <p class="Documentation-exampleError" role="alert" aria-atomic="true"></p> <button class="Documentation-exampleShareButton" aria-label="Share Code">Share</button> <button class="Documentation-exampleFormatButton" aria-label="Format Code">Format</button> <button class="Documentation-exampleRunButton" aria-label="Run Code">Run</button> </div></details> </div><div class="Documentation-typeFunc"> <h4 tabindex="-1" id="TimeoutHandler" data-kind="function" class="Documentation-typeFuncHeader"> <span>func <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/server.go;l=3777">TimeoutHandler</a> <a class="Documentation-idLink" href="#TimeoutHandler" title="Go to TimeoutHandler" aria-label="Go to TimeoutHandler">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>func TimeoutHandler(h <a href="#Handler">Handler</a>, dt <a href="/time">time</a>.<a href="/time#Duration">Duration</a>, msg <a href="/builtin#string">string</a>) <a href="#Handler">Handler</a></pre> </div> <p>TimeoutHandler returns a <a href="#Handler">Handler</a> that runs h with the given time limit. </p><p>The new Handler calls h.ServeHTTP to handle each request, but if a call runs for longer than its time limit, the handler responds with a 503 Service Unavailable error and the given message in its body. (If msg is empty, a suitable default message will be sent.) After such a timeout, writes by h to its <a href="#ResponseWriter">ResponseWriter</a> will return <a href="#ErrHandlerTimeout">ErrHandlerTimeout</a>. </p><p>TimeoutHandler supports the <a href="#Pusher">Pusher</a> interface but does not support the <a href="#Hijacker">Hijacker</a> or <a href="#Flusher">Flusher</a> interfaces. </p> </div> </div><div class="Documentation-type"> <h4 tabindex="-1" id="HandlerFunc" data-kind="type" class="Documentation-typeHeader"> <span>type <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/server.go;l=2290">HandlerFunc</a> <a class="Documentation-idLink" href="#HandlerFunc" title="Go to HandlerFunc" aria-label="Go to HandlerFunc">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>type HandlerFunc func(<a href="#ResponseWriter">ResponseWriter</a>, *<a href="#Request">Request</a>)</pre> </div> <p>The HandlerFunc type is an adapter to allow the use of ordinary functions as HTTP handlers. If f is a function with the appropriate signature, HandlerFunc(f) is a <a href="#Handler">Handler</a> that calls f. </p> <div class="Documentation-typeMethod"> <h4 tabindex="-1" id="HandlerFunc.ServeHTTP" data-kind="method" class="Documentation-typeMethodHeader"> <span>func (HandlerFunc) <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/server.go;l=2293">ServeHTTP</a> <a class="Documentation-idLink" href="#HandlerFunc.ServeHTTP" title="Go to HandlerFunc.ServeHTTP" aria-label="Go to HandlerFunc.ServeHTTP">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>func (f <a href="#HandlerFunc">HandlerFunc</a>) ServeHTTP(w <a href="#ResponseWriter">ResponseWriter</a>, r *<a href="#Request">Request</a>)</pre> </div> <p>ServeHTTP calls f(w, r). </p> </div> </div><div class="Documentation-type"> <h4 tabindex="-1" id="Header" data-kind="type" class="Documentation-typeHeader"> <span>type <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/header.go;l=24">Header</a> <a class="Documentation-idLink" href="#Header" title="Go to Header" aria-label="Go to Header">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>type Header map[<a href="/builtin#string">string</a>][]<a href="/builtin#string">string</a></pre> </div> <p>A Header represents the key-value pairs in an HTTP header. </p><p>The keys should be in canonical form, as returned by <a href="#CanonicalHeaderKey">CanonicalHeaderKey</a>. </p> <div class="Documentation-typeMethod"> <h4 tabindex="-1" id="Header.Add" data-kind="method" class="Documentation-typeMethodHeader"> <span>func (Header) <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/header.go;l=30">Add</a> <a class="Documentation-idLink" href="#Header.Add" title="Go to Header.Add" aria-label="Go to Header.Add">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>func (h <a href="#Header">Header</a>) Add(key, value <a href="/builtin#string">string</a>)</pre> </div> <p>Add adds the key, value pair to the header. It appends to any existing values associated with key. The key is case insensitive; it is canonicalized by <a href="#CanonicalHeaderKey">CanonicalHeaderKey</a>. </p> </div><div class="Documentation-typeMethod"> <h4 tabindex="-1" id="Header.Clone" data-kind="method" class="Documentation-typeMethodHeader"> <span>func (Header) <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/header.go;l=94">Clone</a> <a class="Documentation-idLink" href="#Header.Clone" title="Go to Header.Clone" aria-label="Go to Header.Clone">¶</a></span> <span class="Documentation-sinceVersion"> <span class="Documentation-sinceVersionLabel">added in</span> <span class="Documentation-sinceVersionVersion">go1.13</span> </span> </h4> <div class="Documentation-declaration"> <pre>func (h <a href="#Header">Header</a>) Clone() <a href="#Header">Header</a></pre> </div> <p>Clone returns a copy of h or nil if h is nil. </p> </div><div class="Documentation-typeMethod"> <h4 tabindex="-1" id="Header.Del" data-kind="method" class="Documentation-typeMethodHeader"> <span>func (Header) <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/header.go;l=80">Del</a> <a class="Documentation-idLink" href="#Header.Del" title="Go to Header.Del" aria-label="Go to Header.Del">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>func (h <a href="#Header">Header</a>) Del(key <a href="/builtin#string">string</a>)</pre> </div> <p>Del deletes the values associated with key. The key is case insensitive; it is canonicalized by <a href="#CanonicalHeaderKey">CanonicalHeaderKey</a>. </p> </div><div class="Documentation-typeMethod"> <h4 tabindex="-1" id="Header.Get" data-kind="method" class="Documentation-typeMethodHeader"> <span>func (Header) <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/header.go;l=49">Get</a> <a class="Documentation-idLink" href="#Header.Get" title="Go to Header.Get" aria-label="Go to Header.Get">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>func (h <a href="#Header">Header</a>) Get(key <a href="/builtin#string">string</a>) <a href="/builtin#string">string</a></pre> </div> <p>Get gets the first value associated with the given key. If there are no values associated with the key, Get returns "". It is case insensitive; <a href="/net/textproto#CanonicalMIMEHeaderKey">textproto.CanonicalMIMEHeaderKey</a> is used to canonicalize the provided key. Get assumes that all keys are stored in canonical form. To use non-canonical keys, access the map directly. </p> </div><div class="Documentation-typeMethod"> <h4 tabindex="-1" id="Header.Set" data-kind="method" class="Documentation-typeMethodHeader"> <span>func (Header) <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/header.go;l=39">Set</a> <a class="Documentation-idLink" href="#Header.Set" title="Go to Header.Set" aria-label="Go to Header.Set">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>func (h <a href="#Header">Header</a>) Set(key, value <a href="/builtin#string">string</a>)</pre> </div> <p>Set sets the header entries associated with key to the single element value. It replaces any existing values associated with key. The key is case insensitive; it is canonicalized by <a href="/net/textproto#CanonicalMIMEHeaderKey">textproto.CanonicalMIMEHeaderKey</a>. To use non-canonical keys, assign to the map directly. </p> </div><div class="Documentation-typeMethod"> <h4 tabindex="-1" id="Header.Values" data-kind="method" class="Documentation-typeMethodHeader"> <span>func (Header) <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/header.go;l=58">Values</a> <a class="Documentation-idLink" href="#Header.Values" title="Go to Header.Values" aria-label="Go to Header.Values">¶</a></span> <span class="Documentation-sinceVersion"> <span class="Documentation-sinceVersionLabel">added in</span> <span class="Documentation-sinceVersionVersion">go1.14</span> </span> </h4> <div class="Documentation-declaration"> <pre>func (h <a href="#Header">Header</a>) Values(key <a href="/builtin#string">string</a>) []<a href="/builtin#string">string</a></pre> </div> <p>Values returns all values associated with the given key. It is case insensitive; <a href="/net/textproto#CanonicalMIMEHeaderKey">textproto.CanonicalMIMEHeaderKey</a> is used to canonicalize the provided key. To use non-canonical keys, access the map directly. The returned slice is not a copy. </p> </div><div class="Documentation-typeMethod"> <h4 tabindex="-1" id="Header.Write" data-kind="method" class="Documentation-typeMethodHeader"> <span>func (Header) <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/header.go;l=85">Write</a> <a class="Documentation-idLink" href="#Header.Write" title="Go to Header.Write" aria-label="Go to Header.Write">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>func (h <a href="#Header">Header</a>) Write(w <a href="/io">io</a>.<a href="/io#Writer">Writer</a>) <a href="/builtin#error">error</a></pre> </div> <p>Write writes a header in wire format. </p> </div><div class="Documentation-typeMethod"> <h4 tabindex="-1" id="Header.WriteSubset" data-kind="method" class="Documentation-typeMethodHeader"> <span>func (Header) <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/header.go;l=186">WriteSubset</a> <a class="Documentation-idLink" href="#Header.WriteSubset" title="Go to Header.WriteSubset" aria-label="Go to Header.WriteSubset">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>func (h <a href="#Header">Header</a>) WriteSubset(w <a href="/io">io</a>.<a href="/io#Writer">Writer</a>, exclude map[<a href="/builtin#string">string</a>]<a href="/builtin#bool">bool</a>) <a href="/builtin#error">error</a></pre> </div> <p>WriteSubset writes a header in wire format. If exclude is not nil, keys where exclude[key] == true are not written. Keys are not canonicalized before checking the exclude map. </p> </div> </div><div class="Documentation-type"> <h4 tabindex="-1" id="Hijacker" data-kind="type" class="Documentation-typeHeader"> <span>type <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/server.go;l=186">Hijacker</a> <a class="Documentation-idLink" href="#Hijacker" title="Go to Hijacker" aria-label="Go to Hijacker">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>type Hijacker interface { <span id="Hijacker.Hijack" data-kind="method"> <span class="comment">// Hijack lets the caller take over the connection.</span> </span> <span class="comment">// After a call to Hijack the HTTP server library</span> <span class="comment">// will not do anything else with the connection.</span> <span class="comment">//</span> <span class="comment">// It becomes the caller's responsibility to manage</span> <span class="comment">// and close the connection.</span> <span class="comment">//</span> <span class="comment">// The returned net.Conn may have read or write deadlines</span> <span class="comment">// already set, depending on the configuration of the</span> <span class="comment">// Server. It is the caller's responsibility to set</span> <span class="comment">// or clear those deadlines as needed.</span> <span class="comment">//</span> <span class="comment">// The returned bufio.Reader may contain unprocessed buffered</span> <span class="comment">// data from the client.</span> <span class="comment">//</span> <span class="comment">// After a call to Hijack, the original Request.Body must not</span> <span class="comment">// be used. The original Request's Context remains valid and</span> <span class="comment">// is not canceled until the Request's ServeHTTP method</span> <span class="comment">// returns.</span> Hijack() (<a href="/net">net</a>.<a href="/net#Conn">Conn</a>, *<a href="/bufio">bufio</a>.<a href="/bufio#ReadWriter">ReadWriter</a>, <a href="/builtin#error">error</a>) }</pre> </div> <p>The Hijacker interface is implemented by ResponseWriters that allow an HTTP handler to take over the connection. </p><p>The default <a href="#ResponseWriter">ResponseWriter</a> for HTTP/1.x connections supports Hijacker, but HTTP/2 connections intentionally do not. ResponseWriter wrappers may also not support Hijacker. Handlers should always test for this ability at runtime. </p> <details tabindex="-1" id="example-Hijacker" class="Documentation-exampleDetails js-exampleContainer"> <summary class="Documentation-exampleDetailsHeader">Example <a href="#example-Hijacker" title="Go to Example" aria-label="Go to Example">¶</a></summary> <div class="Documentation-exampleDetailsBody"> <pre class="Documentation-exampleCode"> package main import ( "fmt" "log" "net/http" ) func main() { http.HandleFunc("/hijack", func(w http.ResponseWriter, r *http.Request) { hj, ok := w.(http.Hijacker) if !ok { http.Error(w, "webserver doesn't support hijacking", http.StatusInternalServerError) return } conn, bufrw, err := hj.Hijack() if err != nil { http.Error(w, err.Error(), http.StatusInternalServerError) return } // Don't forget to close the connection: defer conn.Close() bufrw.WriteString("Now we're speaking raw TCP. Say hi: ") bufrw.Flush() s, err := bufrw.ReadString('\n') if err != nil { log.Printf("error reading string: %v", err) return } fmt.Fprintf(bufrw, "You said: %q\nBye.\n", s) bufrw.Flush() }) } </pre> <pre><span class="Documentation-exampleOutputLabel">Output:</span> <span class="Documentation-exampleOutput"></span></pre> </div> <div class="Documentation-exampleButtonsContainer"> <p class="Documentation-exampleError" role="alert" aria-atomic="true"></p> <button class="Documentation-exampleShareButton" aria-label="Share Code">Share</button> <button class="Documentation-exampleFormatButton" aria-label="Format Code">Format</button> <button class="Documentation-exampleRunButton" aria-label="Run Code">Run</button> </div></details> </div><div class="Documentation-type"> <h4 tabindex="-1" id="MaxBytesError" data-kind="type" class="Documentation-typeHeader"> <span>type <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/request.go;l=1194">MaxBytesError</a> <a class="Documentation-idLink" href="#MaxBytesError" title="Go to MaxBytesError" aria-label="Go to MaxBytesError">¶</a></span> <span class="Documentation-sinceVersion"> <span class="Documentation-sinceVersionLabel">added in</span> <span class="Documentation-sinceVersionVersion">go1.19</span> </span> </h4> <div class="Documentation-declaration"> <pre>type MaxBytesError struct { <span id="MaxBytesError.Limit" data-kind="field"> Limit <a href="/builtin#int64">int64</a> </span>}</pre> </div> <p>MaxBytesError is returned by <a href="#MaxBytesReader">MaxBytesReader</a> when its read limit is exceeded. </p> <div class="Documentation-typeMethod"> <h4 tabindex="-1" id="MaxBytesError.Error" data-kind="method" class="Documentation-typeMethodHeader"> <span>func (*MaxBytesError) <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/request.go;l=1198">Error</a> <a class="Documentation-idLink" href="#MaxBytesError.Error" title="Go to MaxBytesError.Error" aria-label="Go to MaxBytesError.Error">¶</a></span> <span class="Documentation-sinceVersion"> <span class="Documentation-sinceVersionLabel">added in</span> <span class="Documentation-sinceVersionVersion">go1.19</span> </span> </h4> <div class="Documentation-declaration"> <pre>func (e *<a href="#MaxBytesError">MaxBytesError</a>) Error() <a href="/builtin#string">string</a></pre> </div> </div> </div><div class="Documentation-type"> <details class="Documentation-deprecatedDetails js-deprecatedDetails"> <summary> <h4 tabindex="-1" id="ProtocolError" data-kind="type" class="Documentation-typeHeader"> <span class="Documentation-deprecatedTitle"> type <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/request.go;l=47">ProtocolError</a> <span class="Documentation-deprecatedTag">deprecated</span> <span class="Documentation-deprecatedBody"></span> </span> <span class="Documentation-sinceVersion"> </span> </h4> </summary> <div class="go-Message go-Message--warning Documentation-deprecatedItemBody"> <div class="Documentation-declaration"> <pre>type ProtocolError struct { <span id="ProtocolError.ErrorString" data-kind="field"> ErrorString <a href="/builtin#string">string</a> </span>}</pre> </div> <p>ProtocolError represents an HTTP protocol error. </p><p>Deprecated: Not all errors in the http package related to protocol errors are of type ProtocolError. </p> <div class="Documentation-typeMethod"> <h4 tabindex="-1" id="ProtocolError.Error" data-kind="method" class="Documentation-typeMethodHeader"> <span>func (*ProtocolError) <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/request.go;l=51">Error</a> <a class="Documentation-idLink" href="#ProtocolError.Error" title="Go to ProtocolError.Error" aria-label="Go to ProtocolError.Error">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>func (pe *<a href="#ProtocolError">ProtocolError</a>) Error() <a href="/builtin#string">string</a></pre> </div> </div><div class="Documentation-typeMethod"> <h4 tabindex="-1" id="ProtocolError.Is" data-kind="method" class="Documentation-typeMethodHeader"> <span>func (*ProtocolError) <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/request.go;l=54">Is</a> <a class="Documentation-idLink" href="#ProtocolError.Is" title="Go to ProtocolError.Is" aria-label="Go to ProtocolError.Is">¶</a></span> <span class="Documentation-sinceVersion"> <span class="Documentation-sinceVersionLabel">added in</span> <span class="Documentation-sinceVersionVersion">go1.21.0</span> </span> </h4> <div class="Documentation-declaration"> <pre>func (pe *<a href="#ProtocolError">ProtocolError</a>) Is(err <a href="/builtin#error">error</a>) <a href="/builtin#bool">bool</a></pre> </div> <p>Is lets http.ErrNotSupported match errors.ErrUnsupported. </p> </div> </div> </details> </div><div class="Documentation-type"> <h4 tabindex="-1" id="Protocols" data-kind="type" class="Documentation-typeHeader"> <span>type <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/http.go;l=30">Protocols</a> <a class="Documentation-idLink" href="#Protocols" title="Go to Protocols" aria-label="Go to Protocols">¶</a></span> <span class="Documentation-sinceVersion"> <span class="Documentation-sinceVersionLabel">added in</span> <span class="Documentation-sinceVersionVersion">go1.24.0</span> </span> </h4> <div class="Documentation-declaration"> <pre>type Protocols struct { <span class="comment">// contains filtered or unexported fields</span> }</pre> </div> <p>Protocols is a set of HTTP protocols. The zero value is an empty set of protocols. </p><p>The supported protocols are: </p><ul class="Documentation-bulletList"> <li><p>HTTP1 is the HTTP/1.0 and HTTP/1.1 protocols. HTTP1 is supported on both unsecured TCP and secured TLS connections. </p></li> <li><p>HTTP2 is the HTTP/2 protcol over a TLS connection. </p></li> <li><p>UnencryptedHTTP2 is the HTTP/2 protocol over an unsecured TCP connection. </p></li> </ul> <details tabindex="-1" id="example-Protocols-Http1" class="Documentation-exampleDetails js-exampleContainer"> <summary class="Documentation-exampleDetailsHeader">Example (Http1) <a href="#example-Protocols-Http1" title="Go to Example (Http1)" aria-label="Go to Example (Http1)">¶</a></summary> <div class="Documentation-exampleDetailsBody"> <pre class="Documentation-exampleCode"> package main import ( "log" "net/http" ) func main() { srv := http.Server{ Addr: ":8443", } // Serve only HTTP/1. srv.Protocols = new(http.Protocols) srv.Protocols.SetHTTP1(true) log.Fatal(srv.ListenAndServeTLS("cert.pem", "key.pem")) } </pre> <pre><span class="Documentation-exampleOutputLabel">Output:</span> <span class="Documentation-exampleOutput"></span></pre> </div> <div class="Documentation-exampleButtonsContainer"> <p class="Documentation-exampleError" role="alert" aria-atomic="true"></p> <button class="Documentation-exampleShareButton" aria-label="Share Code">Share</button> <button class="Documentation-exampleFormatButton" aria-label="Format Code">Format</button> <button class="Documentation-exampleRunButton" aria-label="Run Code">Run</button> </div></details> <details tabindex="-1" id="example-Protocols-Http1or2" class="Documentation-exampleDetails js-exampleContainer"> <summary class="Documentation-exampleDetailsHeader">Example (Http1or2) <a href="#example-Protocols-Http1or2" title="Go to Example (Http1or2)" aria-label="Go to Example (Http1or2)">¶</a></summary> <div class="Documentation-exampleDetailsBody"> <pre class="Documentation-exampleCode"> package main import ( "log" "net/http" ) func main() { t := http.DefaultTransport.(*http.Transport).Clone() // Use either HTTP/1 and HTTP/2. t.Protocols = new(http.Protocols) t.Protocols.SetHTTP1(true) t.Protocols.SetHTTP2(true) cli := &http.Client{Transport: t} res, err := cli.Get("http://www.google.com/robots.txt") if err != nil { log.Fatal(err) } res.Body.Close() } </pre> <pre><span class="Documentation-exampleOutputLabel">Output:</span> <span class="Documentation-exampleOutput"></span></pre> </div> <div class="Documentation-exampleButtonsContainer"> <p class="Documentation-exampleError" role="alert" aria-atomic="true"></p> <button class="Documentation-exampleShareButton" aria-label="Share Code">Share</button> <button class="Documentation-exampleFormatButton" aria-label="Format Code">Format</button> <button class="Documentation-exampleRunButton" aria-label="Run Code">Run</button> </div></details> <div class="Documentation-typeMethod"> <h4 tabindex="-1" id="Protocols.HTTP1" data-kind="method" class="Documentation-typeMethodHeader"> <span>func (Protocols) <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/http.go;l=41">HTTP1</a> <a class="Documentation-idLink" href="#Protocols.HTTP1" title="Go to Protocols.HTTP1" aria-label="Go to Protocols.HTTP1">¶</a></span> <span class="Documentation-sinceVersion"> <span class="Documentation-sinceVersionLabel">added in</span> <span class="Documentation-sinceVersionVersion">go1.24.0</span> </span> </h4> <div class="Documentation-declaration"> <pre>func (p <a href="#Protocols">Protocols</a>) HTTP1() <a href="/builtin#bool">bool</a></pre> </div> <p>HTTP1 reports whether p includes HTTP/1. </p> </div><div class="Documentation-typeMethod"> <h4 tabindex="-1" id="Protocols.HTTP2" data-kind="method" class="Documentation-typeMethodHeader"> <span>func (Protocols) <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/http.go;l=47">HTTP2</a> <a class="Documentation-idLink" href="#Protocols.HTTP2" title="Go to Protocols.HTTP2" aria-label="Go to Protocols.HTTP2">¶</a></span> <span class="Documentation-sinceVersion"> <span class="Documentation-sinceVersionLabel">added in</span> <span class="Documentation-sinceVersionVersion">go1.24.0</span> </span> </h4> <div class="Documentation-declaration"> <pre>func (p <a href="#Protocols">Protocols</a>) HTTP2() <a href="/builtin#bool">bool</a></pre> </div> <p>HTTP2 reports whether p includes HTTP/2. </p> </div><div class="Documentation-typeMethod"> <h4 tabindex="-1" id="Protocols.SetHTTP1" data-kind="method" class="Documentation-typeMethodHeader"> <span>func (*Protocols) <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/http.go;l=44">SetHTTP1</a> <a class="Documentation-idLink" href="#Protocols.SetHTTP1" title="Go to Protocols.SetHTTP1" aria-label="Go to Protocols.SetHTTP1">¶</a></span> <span class="Documentation-sinceVersion"> <span class="Documentation-sinceVersionLabel">added in</span> <span class="Documentation-sinceVersionVersion">go1.24.0</span> </span> </h4> <div class="Documentation-declaration"> <pre>func (p *<a href="#Protocols">Protocols</a>) SetHTTP1(ok <a href="/builtin#bool">bool</a>)</pre> </div> <p>SetHTTP1 adds or removes HTTP/1 from p. </p> </div><div class="Documentation-typeMethod"> <h4 tabindex="-1" id="Protocols.SetHTTP2" data-kind="method" class="Documentation-typeMethodHeader"> <span>func (*Protocols) <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/http.go;l=50">SetHTTP2</a> <a class="Documentation-idLink" href="#Protocols.SetHTTP2" title="Go to Protocols.SetHTTP2" aria-label="Go to Protocols.SetHTTP2">¶</a></span> <span class="Documentation-sinceVersion"> <span class="Documentation-sinceVersionLabel">added in</span> <span class="Documentation-sinceVersionVersion">go1.24.0</span> </span> </h4> <div class="Documentation-declaration"> <pre>func (p *<a href="#Protocols">Protocols</a>) SetHTTP2(ok <a href="/builtin#bool">bool</a>)</pre> </div> <p>SetHTTP2 adds or removes HTTP/2 from p. </p> </div><div class="Documentation-typeMethod"> <h4 tabindex="-1" id="Protocols.SetUnencryptedHTTP2" data-kind="method" class="Documentation-typeMethodHeader"> <span>func (*Protocols) <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/http.go;l=56">SetUnencryptedHTTP2</a> <a class="Documentation-idLink" href="#Protocols.SetUnencryptedHTTP2" title="Go to Protocols.SetUnencryptedHTTP2" aria-label="Go to Protocols.SetUnencryptedHTTP2">¶</a></span> <span class="Documentation-sinceVersion"> <span class="Documentation-sinceVersionLabel">added in</span> <span class="Documentation-sinceVersionVersion">go1.24.0</span> </span> </h4> <div class="Documentation-declaration"> <pre>func (p *<a href="#Protocols">Protocols</a>) SetUnencryptedHTTP2(ok <a href="/builtin#bool">bool</a>)</pre> </div> <p>SetUnencryptedHTTP2 adds or removes unencrypted HTTP/2 from p. </p> </div><div class="Documentation-typeMethod"> <h4 tabindex="-1" id="Protocols.String" data-kind="method" class="Documentation-typeMethodHeader"> <span>func (Protocols) <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/http.go;l=66">String</a> <a class="Documentation-idLink" href="#Protocols.String" title="Go to Protocols.String" aria-label="Go to Protocols.String">¶</a></span> <span class="Documentation-sinceVersion"> <span class="Documentation-sinceVersionLabel">added in</span> <span class="Documentation-sinceVersionVersion">go1.24.0</span> </span> </h4> <div class="Documentation-declaration"> <pre>func (p <a href="#Protocols">Protocols</a>) String() <a href="/builtin#string">string</a></pre> </div> </div><div class="Documentation-typeMethod"> <h4 tabindex="-1" id="Protocols.UnencryptedHTTP2" data-kind="method" class="Documentation-typeMethodHeader"> <span>func (Protocols) <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/http.go;l=53">UnencryptedHTTP2</a> <a class="Documentation-idLink" href="#Protocols.UnencryptedHTTP2" title="Go to Protocols.UnencryptedHTTP2" aria-label="Go to Protocols.UnencryptedHTTP2">¶</a></span> <span class="Documentation-sinceVersion"> <span class="Documentation-sinceVersionLabel">added in</span> <span class="Documentation-sinceVersionVersion">go1.24.0</span> </span> </h4> <div class="Documentation-declaration"> <pre>func (p <a href="#Protocols">Protocols</a>) UnencryptedHTTP2() <a href="/builtin#bool">bool</a></pre> </div> <p>UnencryptedHTTP2 reports whether p includes unencrypted HTTP/2. </p> </div> </div><div class="Documentation-type"> <h4 tabindex="-1" id="PushOptions" data-kind="type" class="Documentation-typeHeader"> <span>type <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/http.go;l=186">PushOptions</a> <a class="Documentation-idLink" href="#PushOptions" title="Go to PushOptions" aria-label="Go to PushOptions">¶</a></span> <span class="Documentation-sinceVersion"> <span class="Documentation-sinceVersionLabel">added in</span> <span class="Documentation-sinceVersionVersion">go1.8</span> </span> </h4> <div class="Documentation-declaration"> <pre>type PushOptions struct { <span id="PushOptions.Method" data-kind="field"> <span class="comment">// Method specifies the HTTP method for the promised request.</span> </span> <span class="comment">// If set, it must be "GET" or "HEAD". Empty means "GET".</span> Method <a href="/builtin#string">string</a> <span id="PushOptions.Header" data-kind="field"> <span class="comment">// Header specifies additional promised request headers. This cannot</span> </span> <span class="comment">// include HTTP/2 pseudo header fields like ":path" and ":scheme",</span> <span class="comment">// which will be added automatically.</span> Header <a href="#Header">Header</a> }</pre> </div> <p>PushOptions describes options for [Pusher.Push]. </p> </div><div class="Documentation-type"> <h4 tabindex="-1" id="Pusher" data-kind="type" class="Documentation-typeHeader"> <span>type <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/http.go;l=200">Pusher</a> <a class="Documentation-idLink" href="#Pusher" title="Go to Pusher" aria-label="Go to Pusher">¶</a></span> <span class="Documentation-sinceVersion"> <span class="Documentation-sinceVersionLabel">added in</span> <span class="Documentation-sinceVersionVersion">go1.8</span> </span> </h4> <div class="Documentation-declaration"> <pre>type Pusher interface { <span id="Pusher.Push" data-kind="method"> <span class="comment">// Push initiates an HTTP/2 server push. This constructs a synthetic</span> </span> <span class="comment">// request using the given target and options, serializes that request</span> <span class="comment">// into a PUSH_PROMISE frame, then dispatches that request using the</span> <span class="comment">// server's request handler. If opts is nil, default options are used.</span> <span class="comment">//</span> <span class="comment">// The target must either be an absolute path (like "/path") or an absolute</span> <span class="comment">// URL that contains a valid host and the same scheme as the parent request.</span> <span class="comment">// If the target is a path, it will inherit the scheme and host of the</span> <span class="comment">// parent request.</span> <span class="comment">//</span> <span class="comment">// The HTTP/2 spec disallows recursive pushes and cross-authority pushes.</span> <span class="comment">// Push may or may not detect these invalid pushes; however, invalid</span> <span class="comment">// pushes will be detected and canceled by conforming clients.</span> <span class="comment">//</span> <span class="comment">// Handlers that wish to push URL X should call Push before sending any</span> <span class="comment">// data that may trigger a request for URL X. This avoids a race where the</span> <span class="comment">// client issues requests for X before receiving the PUSH_PROMISE for X.</span> <span class="comment">//</span> <span class="comment">// Push will run in a separate goroutine making the order of arrival</span> <span class="comment">// non-deterministic. Any required synchronization needs to be implemented</span> <span class="comment">// by the caller.</span> <span class="comment">//</span> <span class="comment">// Push returns ErrNotSupported if the client has disabled push or if push</span> <span class="comment">// is not supported on the underlying connection.</span> Push(target <a href="/builtin#string">string</a>, opts *<a href="#PushOptions">PushOptions</a>) <a href="/builtin#error">error</a> }</pre> </div> <p>Pusher is the interface implemented by ResponseWriters that support HTTP/2 server push. For more background, see <a href="https://tools.ietf.org/html/rfc7540#section-8.2">https://tools.ietf.org/html/rfc7540#section-8.2</a>. </p> </div><div class="Documentation-type"> <h4 tabindex="-1" id="Request" data-kind="type" class="Documentation-typeHeader"> <span>type <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/request.go;l=113">Request</a> <a class="Documentation-idLink" href="#Request" title="Go to Request" aria-label="Go to Request">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>type Request struct { <span id="Request.Method" data-kind="field"> <span class="comment">// Method specifies the HTTP method (GET, POST, PUT, etc.).</span> </span> <span class="comment">// For client requests, an empty string means GET.</span> Method <a href="/builtin#string">string</a> <span id="Request.URL" data-kind="field"> <span class="comment">// URL specifies either the URI being requested (for server</span> </span> <span class="comment">// requests) or the URL to access (for client requests).</span> <span class="comment">//</span> <span class="comment">// For server requests, the URL is parsed from the URI</span> <span class="comment">// supplied on the Request-Line as stored in RequestURI. For</span> <span class="comment">// most requests, fields other than Path and RawQuery will be</span> <span class="comment">// empty. (See <a href="https://rfc-editor.org/rfc/rfc7230.html#section-5.3">RFC 7230, Section 5.3</a>)</span> <span class="comment">//</span> <span class="comment">// For client requests, the URL's Host specifies the server to</span> <span class="comment">// connect to, while the Request's Host field optionally</span> <span class="comment">// specifies the Host header value to send in the HTTP</span> <span class="comment">// request.</span> URL *<a href="/net/url">url</a>.<a href="/net/url#URL">URL</a> <span class="comment">// The protocol version for incoming server requests.</span> <span class="comment">//</span> <span class="comment">// For client requests, these fields are ignored. The HTTP</span> <span class="comment">// client code always uses either HTTP/1.1 or HTTP/2.</span> <span class="comment">// See the docs on Transport for details.</span> <span id="Request.Proto" data-kind="field"> Proto <a href="/builtin#string">string</a> <span class="comment">// "HTTP/1.0"</span> </span><span id="Request.ProtoMajor" data-kind="field"> ProtoMajor <a href="/builtin#int">int</a> <span class="comment">// 1</span> </span><span id="Request.ProtoMinor" data-kind="field"> ProtoMinor <a href="/builtin#int">int</a> <span class="comment">// 0</span> </span> <span id="Request.Header" data-kind="field"> <span class="comment">// Header contains the request header fields either received</span> </span> <span class="comment">// by the server or to be sent by the client.</span> <span class="comment">//</span> <span class="comment">// If a server received a request with header lines,</span> <span class="comment">//</span> <span class="comment">// Host: example.com</span> <span class="comment">// accept-encoding: gzip, deflate</span> <span class="comment">// Accept-Language: en-us</span> <span class="comment">// fOO: Bar</span> <span class="comment">// foo: two</span> <span class="comment">//</span> <span class="comment">// then</span> <span class="comment">//</span> <span class="comment">// Header = map[string][]string{</span> <span class="comment">// "Accept-Encoding": {"gzip, deflate"},</span> <span class="comment">// "Accept-Language": {"en-us"},</span> <span class="comment">// "Foo": {"Bar", "two"},</span> <span class="comment">// }</span> <span class="comment">//</span> <span class="comment">// For incoming requests, the Host header is promoted to the</span> <span class="comment">// Request.Host field and removed from the Header map.</span> <span class="comment">//</span> <span class="comment">// HTTP defines that header names are case-insensitive. The</span> <span class="comment">// request parser implements this by using CanonicalHeaderKey,</span> <span class="comment">// making the first character and any characters following a</span> <span class="comment">// hyphen uppercase and the rest lowercase.</span> <span class="comment">//</span> <span class="comment">// For client requests, certain headers such as Content-Length</span> <span class="comment">// and Connection are automatically written when needed and</span> <span class="comment">// values in Header may be ignored. See the documentation</span> <span class="comment">// for the Request.Write method.</span> Header <a href="#Header">Header</a> <span id="Request.Body" data-kind="field"> <span class="comment">// Body is the request's body.</span> </span> <span class="comment">//</span> <span class="comment">// For client requests, a nil body means the request has no</span> <span class="comment">// body, such as a GET request. The HTTP Client's Transport</span> <span class="comment">// is responsible for calling the Close method.</span> <span class="comment">//</span> <span class="comment">// For server requests, the Request Body is always non-nil</span> <span class="comment">// but will return EOF immediately when no body is present.</span> <span class="comment">// The Server will close the request body. The ServeHTTP</span> <span class="comment">// Handler does not need to.</span> <span class="comment">//</span> <span class="comment">// Body must allow Read to be called concurrently with Close.</span> <span class="comment">// In particular, calling Close should unblock a Read waiting</span> <span class="comment">// for input.</span> Body <a href="/io">io</a>.<a href="/io#ReadCloser">ReadCloser</a> <span id="Request.GetBody" data-kind="field"> <span class="comment">// GetBody defines an optional func to return a new copy of</span> </span> <span class="comment">// Body. It is used for client requests when a redirect requires</span> <span class="comment">// reading the body more than once. Use of GetBody still</span> <span class="comment">// requires setting Body.</span> <span class="comment">//</span> <span class="comment">// For server requests, it is unused.</span> GetBody func() (<a href="/io">io</a>.<a href="/io#ReadCloser">ReadCloser</a>, <a href="/builtin#error">error</a>) <span id="Request.ContentLength" data-kind="field"> <span class="comment">// ContentLength records the length of the associated content.</span> </span> <span class="comment">// The value -1 indicates that the length is unknown.</span> <span class="comment">// Values >= 0 indicate that the given number of bytes may</span> <span class="comment">// be read from Body.</span> <span class="comment">//</span> <span class="comment">// For client requests, a value of 0 with a non-nil Body is</span> <span class="comment">// also treated as unknown.</span> ContentLength <a href="/builtin#int64">int64</a> <span id="Request.TransferEncoding" data-kind="field"> <span class="comment">// TransferEncoding lists the transfer encodings from outermost to</span> </span> <span class="comment">// innermost. An empty list denotes the "identity" encoding.</span> <span class="comment">// TransferEncoding can usually be ignored; chunked encoding is</span> <span class="comment">// automatically added and removed as necessary when sending and</span> <span class="comment">// receiving requests.</span> TransferEncoding []<a href="/builtin#string">string</a> <span id="Request.Close" data-kind="field"> <span class="comment">// Close indicates whether to close the connection after</span> </span> <span class="comment">// replying to this request (for servers) or after sending this</span> <span class="comment">// request and reading its response (for clients).</span> <span class="comment">//</span> <span class="comment">// For server requests, the HTTP server handles this automatically</span> <span class="comment">// and this field is not needed by Handlers.</span> <span class="comment">//</span> <span class="comment">// For client requests, setting this field prevents re-use of</span> <span class="comment">// TCP connections between requests to the same hosts, as if</span> <span class="comment">// Transport.DisableKeepAlives were set.</span> Close <a href="/builtin#bool">bool</a> <span id="Request.Host" data-kind="field"> <span class="comment">// For server requests, Host specifies the host on which the</span> </span> <span class="comment">// URL is sought. For HTTP/1 (per <a href="https://rfc-editor.org/rfc/rfc7230.html#section-5.4">RFC 7230, section 5.4</a>), this</span> <span class="comment">// is either the value of the "Host" header or the host name</span> <span class="comment">// given in the URL itself. For HTTP/2, it is the value of the</span> <span class="comment">// ":authority" pseudo-header field.</span> <span class="comment">// It may be of the form "host:port". For international domain</span> <span class="comment">// names, Host may be in Punycode or Unicode form. Use</span> <span class="comment">// golang.org/x/net/idna to convert it to either format if</span> <span class="comment">// needed.</span> <span class="comment">// To prevent DNS rebinding attacks, server Handlers should</span> <span class="comment">// validate that the Host header has a value for which the</span> <span class="comment">// Handler considers itself authoritative. The included</span> <span class="comment">// ServeMux supports patterns registered to particular host</span> <span class="comment">// names and thus protects its registered Handlers.</span> <span class="comment">//</span> <span class="comment">// For client requests, Host optionally overrides the Host</span> <span class="comment">// header to send. If empty, the Request.Write method uses</span> <span class="comment">// the value of URL.Host. Host may contain an international</span> <span class="comment">// domain name.</span> Host <a href="/builtin#string">string</a> <span id="Request.Form" data-kind="field"> <span class="comment">// Form contains the parsed form data, including both the URL</span> </span> <span class="comment">// field's query parameters and the PATCH, POST, or PUT form data.</span> <span class="comment">// This field is only available after ParseForm is called.</span> <span class="comment">// The HTTP client ignores Form and uses Body instead.</span> Form <a href="/net/url">url</a>.<a href="/net/url#Values">Values</a> <span id="Request.PostForm" data-kind="field"> <span class="comment">// PostForm contains the parsed form data from PATCH, POST</span> </span> <span class="comment">// or PUT body parameters.</span> <span class="comment">//</span> <span class="comment">// This field is only available after ParseForm is called.</span> <span class="comment">// The HTTP client ignores PostForm and uses Body instead.</span> PostForm <a href="/net/url">url</a>.<a href="/net/url#Values">Values</a> <span id="Request.MultipartForm" data-kind="field"> <span class="comment">// MultipartForm is the parsed multipart form, including file uploads.</span> </span> <span class="comment">// This field is only available after ParseMultipartForm is called.</span> <span class="comment">// The HTTP client ignores MultipartForm and uses Body instead.</span> MultipartForm *<a href="/mime/multipart">multipart</a>.<a href="/mime/multipart#Form">Form</a> <span id="Request.Trailer" data-kind="field"> <span class="comment">// Trailer specifies additional headers that are sent after the request</span> </span> <span class="comment">// body.</span> <span class="comment">//</span> <span class="comment">// For server requests, the Trailer map initially contains only the</span> <span class="comment">// trailer keys, with nil values. (The client declares which trailers it</span> <span class="comment">// will later send.) While the handler is reading from Body, it must</span> <span class="comment">// not reference Trailer. After reading from Body returns EOF, Trailer</span> <span class="comment">// can be read again and will contain non-nil values, if they were sent</span> <span class="comment">// by the client.</span> <span class="comment">//</span> <span class="comment">// For client requests, Trailer must be initialized to a map containing</span> <span class="comment">// the trailer keys to later send. The values may be nil or their final</span> <span class="comment">// values. The ContentLength must be 0 or -1, to send a chunked request.</span> <span class="comment">// After the HTTP request is sent the map values can be updated while</span> <span class="comment">// the request body is read. Once the body returns EOF, the caller must</span> <span class="comment">// not mutate Trailer.</span> <span class="comment">//</span> <span class="comment">// Few HTTP clients, servers, or proxies support HTTP trailers.</span> Trailer <a href="#Header">Header</a> <span id="Request.RemoteAddr" data-kind="field"> <span class="comment">// RemoteAddr allows HTTP servers and other software to record</span> </span> <span class="comment">// the network address that sent the request, usually for</span> <span class="comment">// logging. This field is not filled in by ReadRequest and</span> <span class="comment">// has no defined format. The HTTP server in this package</span> <span class="comment">// sets RemoteAddr to an "IP:port" address before invoking a</span> <span class="comment">// handler.</span> <span class="comment">// This field is ignored by the HTTP client.</span> RemoteAddr <a href="/builtin#string">string</a> <span id="Request.RequestURI" data-kind="field"> <span class="comment">// RequestURI is the unmodified request-target of the</span> </span> <span class="comment">// Request-Line (<a href="https://rfc-editor.org/rfc/rfc7230.html#section-3.1.1">RFC 7230, Section 3.1.1</a>) as sent by the client</span> <span class="comment">// to a server. Usually the URL field should be used instead.</span> <span class="comment">// It is an error to set this field in an HTTP client request.</span> RequestURI <a href="/builtin#string">string</a> <span id="Request.TLS" data-kind="field"> <span class="comment">// TLS allows HTTP servers and other software to record</span> </span> <span class="comment">// information about the TLS connection on which the request</span> <span class="comment">// was received. This field is not filled in by ReadRequest.</span> <span class="comment">// The HTTP server in this package sets the field for</span> <span class="comment">// TLS-enabled connections before invoking a handler;</span> <span class="comment">// otherwise it leaves the field nil.</span> <span class="comment">// This field is ignored by the HTTP client.</span> TLS *<a href="/crypto/tls">tls</a>.<a href="/crypto/tls#ConnectionState">ConnectionState</a> <span id="Request.Cancel" data-kind="field"> <span class="comment">// Cancel is an optional channel whose closure indicates that the client</span> </span> <span class="comment">// request should be regarded as canceled. Not all implementations of</span> <span class="comment">// RoundTripper may support Cancel.</span> <span class="comment">//</span> <span class="comment">// For server requests, this field is not applicable.</span> <span class="comment">//</span> <span class="comment">// Deprecated: Set the Request's context with NewRequestWithContext</span> <span class="comment">// instead. If a Request's Cancel field and context are both</span> <span class="comment">// set, it is undefined whether Cancel is respected.</span> Cancel <-chan struct{} <span id="Request.Response" data-kind="field"> <span class="comment">// Response is the redirect response which caused this request</span> </span> <span class="comment">// to be created. This field is only populated during client</span> <span class="comment">// redirects.</span> Response *<a href="#Response">Response</a> <span id="Request.Pattern" data-kind="field"> <span class="comment">// Pattern is the [ServeMux] pattern that matched the request.</span> </span> <span class="comment">// It is empty if the request was not matched against a pattern.</span> Pattern <a href="/builtin#string">string</a> <span class="comment">// contains filtered or unexported fields</span> }</pre> </div> <p>A Request represents an HTTP request received by a server or to be sent by a client. </p><p>The field semantics differ slightly between client and server usage. In addition to the notes on the fields below, see the documentation for <a href="#Request.Write">Request.Write</a> and <a href="#RoundTripper">RoundTripper</a>. </p> <div class="Documentation-typeFunc"> <h4 tabindex="-1" id="NewRequest" data-kind="function" class="Documentation-typeFuncHeader"> <span>func <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/request.go;l=862">NewRequest</a> <a class="Documentation-idLink" href="#NewRequest" title="Go to NewRequest" aria-label="Go to NewRequest">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>func NewRequest(method, url <a href="/builtin#string">string</a>, body <a href="/io">io</a>.<a href="/io#Reader">Reader</a>) (*<a href="#Request">Request</a>, <a href="/builtin#error">error</a>)</pre> </div> <p>NewRequest wraps <a href="#NewRequestWithContext">NewRequestWithContext</a> using <a href="/context#Background">context.Background</a>. </p> </div><div class="Documentation-typeFunc"> <h4 tabindex="-1" id="NewRequestWithContext" data-kind="function" class="Documentation-typeFuncHeader"> <span>func <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/request.go;l=889">NewRequestWithContext</a> <a class="Documentation-idLink" href="#NewRequestWithContext" title="Go to NewRequestWithContext" aria-label="Go to NewRequestWithContext">¶</a></span> <span class="Documentation-sinceVersion"> <span class="Documentation-sinceVersionLabel">added in</span> <span class="Documentation-sinceVersionVersion">go1.13</span> </span> </h4> <div class="Documentation-declaration"> <pre>func NewRequestWithContext(ctx <a href="/context">context</a>.<a href="/context#Context">Context</a>, method, url <a href="/builtin#string">string</a>, body <a href="/io">io</a>.<a href="/io#Reader">Reader</a>) (*<a href="#Request">Request</a>, <a href="/builtin#error">error</a>)</pre> </div> <p>NewRequestWithContext returns a new <a href="#Request">Request</a> given a method, URL, and optional body. </p><p>If the provided body is also an <a href="/io#Closer">io.Closer</a>, the returned [Request.Body] is set to body and will be closed (possibly asynchronously) by the Client methods Do, Post, and PostForm, and <a href="#Transport.RoundTrip">Transport.RoundTrip</a>. </p><p>NewRequestWithContext returns a Request suitable for use with <a href="#Client.Do">Client.Do</a> or <a href="#Transport.RoundTrip">Transport.RoundTrip</a>. To create a request for use with testing a Server Handler, either use the <a href="/net/http/httptest#NewRequest">net/http/httptest.NewRequest</a> function, use <a href="#ReadRequest">ReadRequest</a>, or manually update the Request fields. For an outgoing client request, the context controls the entire lifetime of a request and its response: obtaining a connection, sending the request, and reading the response headers and body. See the Request type's documentation for the difference between inbound and outbound request fields. </p><p>If body is of type <a href="/bytes#Buffer">*bytes.Buffer</a>, <a href="/bytes#Reader">*bytes.Reader</a>, or <a href="/strings#Reader">*strings.Reader</a>, the returned request's ContentLength is set to its exact value (instead of -1), GetBody is populated (so 307 and 308 redirects can replay the body), and Body is set to <a href="#NoBody">NoBody</a> if the ContentLength is 0. </p> </div><div class="Documentation-typeFunc"> <h4 tabindex="-1" id="ReadRequest" data-kind="function" class="Documentation-typeFuncHeader"> <span>func <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/request.go;l=1058">ReadRequest</a> <a class="Documentation-idLink" href="#ReadRequest" title="Go to ReadRequest" aria-label="Go to ReadRequest">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>func ReadRequest(b *<a href="/bufio">bufio</a>.<a href="/bufio#Reader">Reader</a>) (*<a href="#Request">Request</a>, <a href="/builtin#error">error</a>)</pre> </div> <p>ReadRequest reads and parses an incoming request from b. </p><p>ReadRequest is a low-level function and should only be used for specialized applications; most code should use the <a href="#Server">Server</a> to read requests and handle them via the <a href="#Handler">Handler</a> interface. ReadRequest only supports HTTP/1.x requests. For HTTP/2, use golang.org/x/net/http2. </p> </div><div class="Documentation-typeMethod"> <h4 tabindex="-1" id="Request.AddCookie" data-kind="method" class="Documentation-typeMethodHeader"> <span>func (*Request) <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/request.go;l=464">AddCookie</a> <a class="Documentation-idLink" href="#Request.AddCookie" title="Go to Request.AddCookie" aria-label="Go to Request.AddCookie">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>func (r *<a href="#Request">Request</a>) AddCookie(c *<a href="#Cookie">Cookie</a>)</pre> </div> <p>AddCookie adds a cookie to the request. Per <a href="https://rfc-editor.org/rfc/rfc6265.html#section-5.4">RFC 6265 section 5.4</a>, AddCookie does not attach more than one <a href="#Cookie">Cookie</a> header field. That means all cookies, if any, are written into the same line, separated by semicolon. AddCookie only sanitizes c's name and value, and does not sanitize a Cookie header already present in the request. </p> </div><div class="Documentation-typeMethod"> <h4 tabindex="-1" id="Request.BasicAuth" data-kind="method" class="Documentation-typeMethodHeader"> <span>func (*Request) <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/request.go;l=973">BasicAuth</a> <a class="Documentation-idLink" href="#Request.BasicAuth" title="Go to Request.BasicAuth" aria-label="Go to Request.BasicAuth">¶</a></span> <span class="Documentation-sinceVersion"> <span class="Documentation-sinceVersionLabel">added in</span> <span class="Documentation-sinceVersionVersion">go1.4</span> </span> </h4> <div class="Documentation-declaration"> <pre>func (r *<a href="#Request">Request</a>) BasicAuth() (username, password <a href="/builtin#string">string</a>, ok <a href="/builtin#bool">bool</a>)</pre> </div> <p>BasicAuth returns the username and password provided in the request's Authorization header, if the request uses HTTP Basic Authentication. See <a href="https://rfc-editor.org/rfc/rfc2617.html#section-2">RFC 2617, Section 2</a>. </p> </div><div class="Documentation-typeMethod"> <h4 tabindex="-1" id="Request.Clone" data-kind="method" class="Documentation-typeMethodHeader"> <span>func (*Request) <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/request.go;l=386">Clone</a> <a class="Documentation-idLink" href="#Request.Clone" title="Go to Request.Clone" aria-label="Go to Request.Clone">¶</a></span> <span class="Documentation-sinceVersion"> <span class="Documentation-sinceVersionLabel">added in</span> <span class="Documentation-sinceVersionVersion">go1.13</span> </span> </h4> <div class="Documentation-declaration"> <pre>func (r *<a href="#Request">Request</a>) Clone(ctx <a href="/context">context</a>.<a href="/context#Context">Context</a>) *<a href="#Request">Request</a></pre> </div> <p>Clone returns a deep copy of r with its context changed to ctx. The provided ctx must be non-nil. </p><p>Clone only makes a shallow copy of the Body field. </p><p>For an outgoing client request, the context controls the entire lifetime of a request and its response: obtaining a connection, sending the request, and reading the response headers and body. </p> </div><div class="Documentation-typeMethod"> <h4 tabindex="-1" id="Request.Context" data-kind="method" class="Documentation-typeMethodHeader"> <span>func (*Request) <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/request.go;l=352">Context</a> <a class="Documentation-idLink" href="#Request.Context" title="Go to Request.Context" aria-label="Go to Request.Context">¶</a></span> <span class="Documentation-sinceVersion"> <span class="Documentation-sinceVersionLabel">added in</span> <span class="Documentation-sinceVersionVersion">go1.7</span> </span> </h4> <div class="Documentation-declaration"> <pre>func (r *<a href="#Request">Request</a>) Context() <a href="/context">context</a>.<a href="/context#Context">Context</a></pre> </div> <p>Context returns the request's context. To change the context, use <a href="#Request.Clone">Request.Clone</a> or <a href="#Request.WithContext">Request.WithContext</a>. </p><p>The returned context is always non-nil; it defaults to the background context. </p><p>For outgoing client requests, the context controls cancellation. </p><p>For incoming server requests, the context is canceled when the client's connection closes, the request is canceled (with HTTP/2), or when the ServeHTTP method returns. </p> </div><div class="Documentation-typeMethod"> <h4 tabindex="-1" id="Request.Cookie" data-kind="method" class="Documentation-typeMethodHeader"> <span>func (*Request) <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/request.go;l=448">Cookie</a> <a class="Documentation-idLink" href="#Request.Cookie" title="Go to Request.Cookie" aria-label="Go to Request.Cookie">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>func (r *<a href="#Request">Request</a>) Cookie(name <a href="/builtin#string">string</a>) (*<a href="#Cookie">Cookie</a>, <a href="/builtin#error">error</a>)</pre> </div> <p>Cookie returns the named cookie provided in the request or <a href="#ErrNoCookie">ErrNoCookie</a> if not found. If multiple cookies match the given name, only one cookie will be returned. </p> </div><div class="Documentation-typeMethod"> <h4 tabindex="-1" id="Request.Cookies" data-kind="method" class="Documentation-typeMethodHeader"> <span>func (*Request) <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/request.go;l=428">Cookies</a> <a class="Documentation-idLink" href="#Request.Cookies" title="Go to Request.Cookies" aria-label="Go to Request.Cookies">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>func (r *<a href="#Request">Request</a>) Cookies() []*<a href="#Cookie">Cookie</a></pre> </div> <p>Cookies parses and returns the HTTP cookies sent with the request. </p> </div><div class="Documentation-typeMethod"> <h4 tabindex="-1" id="Request.CookiesNamed" data-kind="method" class="Documentation-typeMethodHeader"> <span>func (*Request) <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/request.go;l=434">CookiesNamed</a> <a class="Documentation-idLink" href="#Request.CookiesNamed" title="Go to Request.CookiesNamed" aria-label="Go to Request.CookiesNamed">¶</a></span> <span class="Documentation-sinceVersion"> <span class="Documentation-sinceVersionLabel">added in</span> <span class="Documentation-sinceVersionVersion">go1.23.0</span> </span> </h4> <div class="Documentation-declaration"> <pre>func (r *<a href="#Request">Request</a>) CookiesNamed(name <a href="/builtin#string">string</a>) []*<a href="#Cookie">Cookie</a></pre> </div> <p>CookiesNamed parses and returns the named HTTP cookies sent with the request or an empty slice if none matched. </p> </div><div class="Documentation-typeMethod"> <h4 tabindex="-1" id="Request.FormFile" data-kind="method" class="Documentation-typeMethodHeader"> <span>func (*Request) <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/request.go;l=1446">FormFile</a> <a class="Documentation-idLink" href="#Request.FormFile" title="Go to Request.FormFile" aria-label="Go to Request.FormFile">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>func (r *<a href="#Request">Request</a>) FormFile(key <a href="/builtin#string">string</a>) (<a href="/mime/multipart">multipart</a>.<a href="/mime/multipart#File">File</a>, *<a href="/mime/multipart">multipart</a>.<a href="/mime/multipart#FileHeader">FileHeader</a>, <a href="/builtin#error">error</a>)</pre> </div> <p>FormFile returns the first file for the provided form key. FormFile calls <a href="#Request.ParseMultipartForm">Request.ParseMultipartForm</a> and <a href="#Request.ParseForm">Request.ParseForm</a> if necessary. </p> </div><div class="Documentation-typeMethod"> <h4 tabindex="-1" id="Request.FormValue" data-kind="method" class="Documentation-typeMethodHeader"> <span>func (*Request) <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/request.go;l=1419">FormValue</a> <a class="Documentation-idLink" href="#Request.FormValue" title="Go to Request.FormValue" aria-label="Go to Request.FormValue">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>func (r *<a href="#Request">Request</a>) FormValue(key <a href="/builtin#string">string</a>) <a href="/builtin#string">string</a></pre> </div> <p>FormValue returns the first value for the named component of the query. The precedence order: </p><ol class="Documentation-numberList"> <li value="1">application/x-www-form-urlencoded form body (POST, PUT, PATCH only)</li> <li value="2">query parameters (always)</li> <li value="3">multipart/form-data form body (always)</li> </ol><p>FormValue calls <a href="#Request.ParseMultipartForm">Request.ParseMultipartForm</a> and <a href="#Request.ParseForm">Request.ParseForm</a> if necessary and ignores any errors returned by these functions. If key is not present, FormValue returns the empty string. To access multiple values of the same key, call ParseForm and then inspect [Request.Form] directly. </p> </div><div class="Documentation-typeMethod"> <h4 tabindex="-1" id="Request.MultipartReader" data-kind="method" class="Documentation-typeMethodHeader"> <span>func (*Request) <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/request.go;l=497">MultipartReader</a> <a class="Documentation-idLink" href="#Request.MultipartReader" title="Go to Request.MultipartReader" aria-label="Go to Request.MultipartReader">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>func (r *<a href="#Request">Request</a>) MultipartReader() (*<a href="/mime/multipart">multipart</a>.<a href="/mime/multipart#Reader">Reader</a>, <a href="/builtin#error">error</a>)</pre> </div> <p>MultipartReader returns a MIME multipart reader if this is a multipart/form-data or a multipart/mixed POST request, else returns nil and an error. Use this function instead of <a href="#Request.ParseMultipartForm">Request.ParseMultipartForm</a> to process the request body as a stream. </p> </div><div class="Documentation-typeMethod"> <h4 tabindex="-1" id="Request.ParseForm" data-kind="method" class="Documentation-typeMethodHeader"> <span>func (*Request) <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/request.go;l=1327">ParseForm</a> <a class="Documentation-idLink" href="#Request.ParseForm" title="Go to Request.ParseForm" aria-label="Go to Request.ParseForm">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>func (r *<a href="#Request">Request</a>) ParseForm() <a href="/builtin#error">error</a></pre> </div> <p>ParseForm populates r.Form and r.PostForm. </p><p>For all requests, ParseForm parses the raw query from the URL and updates r.Form. </p><p>For POST, PUT, and PATCH requests, it also reads the request body, parses it as a form and puts the results into both r.PostForm and r.Form. Request body parameters take precedence over URL query string values in r.Form. </p><p>If the request Body's size has not already been limited by <a href="#MaxBytesReader">MaxBytesReader</a>, the size is capped at 10MB. </p><p>For other HTTP methods, or when the Content-Type is not application/x-www-form-urlencoded, the request Body is not read, and r.PostForm is initialized to a non-nil, empty value. </p><p><a href="#Request.ParseMultipartForm">Request.ParseMultipartForm</a> calls ParseForm automatically. ParseForm is idempotent. </p> </div><div class="Documentation-typeMethod"> <h4 tabindex="-1" id="Request.ParseMultipartForm" data-kind="method" class="Documentation-typeMethodHeader"> <span>func (*Request) <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/request.go;l=1370">ParseMultipartForm</a> <a class="Documentation-idLink" href="#Request.ParseMultipartForm" title="Go to Request.ParseMultipartForm" aria-label="Go to Request.ParseMultipartForm">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>func (r *<a href="#Request">Request</a>) ParseMultipartForm(maxMemory <a href="/builtin#int64">int64</a>) <a href="/builtin#error">error</a></pre> </div> <p>ParseMultipartForm parses a request body as multipart/form-data. The whole request body is parsed and up to a total of maxMemory bytes of its file parts are stored in memory, with the remainder stored on disk in temporary files. ParseMultipartForm calls <a href="#Request.ParseForm">Request.ParseForm</a> if necessary. If ParseForm returns an error, ParseMultipartForm returns it but also continues parsing the request body. After one call to ParseMultipartForm, subsequent calls have no effect. </p> </div><div class="Documentation-typeMethod"> <h4 tabindex="-1" id="Request.PathValue" data-kind="method" class="Documentation-typeMethodHeader"> <span>func (*Request) <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/request.go;l=1469">PathValue</a> <a class="Documentation-idLink" href="#Request.PathValue" title="Go to Request.PathValue" aria-label="Go to Request.PathValue">¶</a></span> <span class="Documentation-sinceVersion"> <span class="Documentation-sinceVersionLabel">added in</span> <span class="Documentation-sinceVersionVersion">go1.22.0</span> </span> </h4> <div class="Documentation-declaration"> <pre>func (r *<a href="#Request">Request</a>) PathValue(name <a href="/builtin#string">string</a>) <a href="/builtin#string">string</a></pre> </div> <p>PathValue returns the value for the named path wildcard in the <a href="#ServeMux">ServeMux</a> pattern that matched the request. It returns the empty string if the request was not matched against a pattern or there is no such wildcard in the pattern. </p> </div><div class="Documentation-typeMethod"> <h4 tabindex="-1" id="Request.PostFormValue" data-kind="method" class="Documentation-typeMethodHeader"> <span>func (*Request) <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/request.go;l=1434">PostFormValue</a> <a class="Documentation-idLink" href="#Request.PostFormValue" title="Go to Request.PostFormValue" aria-label="Go to Request.PostFormValue">¶</a></span> <span class="Documentation-sinceVersion"> <span class="Documentation-sinceVersionLabel">added in</span> <span class="Documentation-sinceVersionVersion">go1.1</span> </span> </h4> <div class="Documentation-declaration"> <pre>func (r *<a href="#Request">Request</a>) PostFormValue(key <a href="/builtin#string">string</a>) <a href="/builtin#string">string</a></pre> </div> <p>PostFormValue returns the first value for the named component of the POST, PUT, or PATCH request body. URL query parameters are ignored. PostFormValue calls <a href="#Request.ParseMultipartForm">Request.ParseMultipartForm</a> and <a href="#Request.ParseForm">Request.ParseForm</a> if necessary and ignores any errors returned by these functions. If key is not present, PostFormValue returns the empty string. </p> </div><div class="Documentation-typeMethod"> <h4 tabindex="-1" id="Request.ProtoAtLeast" data-kind="method" class="Documentation-typeMethodHeader"> <span>func (*Request) <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/request.go;l=417">ProtoAtLeast</a> <a class="Documentation-idLink" href="#Request.ProtoAtLeast" title="Go to Request.ProtoAtLeast" aria-label="Go to Request.ProtoAtLeast">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>func (r *<a href="#Request">Request</a>) ProtoAtLeast(major, minor <a href="/builtin#int">int</a>) <a href="/builtin#bool">bool</a></pre> </div> <p>ProtoAtLeast reports whether the HTTP protocol used in the request is at least major.minor. </p> </div><div class="Documentation-typeMethod"> <h4 tabindex="-1" id="Request.Referer" data-kind="method" class="Documentation-typeMethodHeader"> <span>func (*Request) <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/request.go;l=481">Referer</a> <a class="Documentation-idLink" href="#Request.Referer" title="Go to Request.Referer" aria-label="Go to Request.Referer">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>func (r *<a href="#Request">Request</a>) Referer() <a href="/builtin#string">string</a></pre> </div> <p>Referer returns the referring URL, if sent in the request. </p><p>Referer is misspelled as in the request itself, a mistake from the earliest days of HTTP. This value can also be fetched from the <a href="#Header">Header</a> map as Header["Referer"]; the benefit of making it available as a method is that the compiler can diagnose programs that use the alternate (correct English) spelling req.Referrer() but cannot diagnose programs that use Header["Referrer"]. </p> </div><div class="Documentation-typeMethod"> <h4 tabindex="-1" id="Request.SetBasicAuth" data-kind="method" class="Documentation-typeMethodHeader"> <span>func (*Request) <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/request.go;l=1022">SetBasicAuth</a> <a class="Documentation-idLink" href="#Request.SetBasicAuth" title="Go to Request.SetBasicAuth" aria-label="Go to Request.SetBasicAuth">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>func (r *<a href="#Request">Request</a>) SetBasicAuth(username, password <a href="/builtin#string">string</a>)</pre> </div> <p>SetBasicAuth sets the request's Authorization header to use HTTP Basic Authentication with the provided username and password. </p><p>With HTTP Basic Authentication the provided username and password are not encrypted. It should generally only be used in an HTTPS request. </p><p>The username may not contain a colon. Some protocols may impose additional requirements on pre-escaping the username and password. For instance, when used with OAuth2, both arguments must be URL encoded first with <a href="/net/url#QueryEscape">url.QueryEscape</a>. </p> </div><div class="Documentation-typeMethod"> <h4 tabindex="-1" id="Request.SetPathValue" data-kind="method" class="Documentation-typeMethodHeader"> <span>func (*Request) <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/request.go;l=1478">SetPathValue</a> <a class="Documentation-idLink" href="#Request.SetPathValue" title="Go to Request.SetPathValue" aria-label="Go to Request.SetPathValue">¶</a></span> <span class="Documentation-sinceVersion"> <span class="Documentation-sinceVersionLabel">added in</span> <span class="Documentation-sinceVersionVersion">go1.22.0</span> </span> </h4> <div class="Documentation-declaration"> <pre>func (r *<a href="#Request">Request</a>) SetPathValue(name, value <a href="/builtin#string">string</a>)</pre> </div> <p>SetPathValue sets name to value, so that subsequent calls to r.PathValue(name) return value. </p> </div><div class="Documentation-typeMethod"> <h4 tabindex="-1" id="Request.UserAgent" data-kind="method" class="Documentation-typeMethodHeader"> <span>func (*Request) <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/request.go;l=423">UserAgent</a> <a class="Documentation-idLink" href="#Request.UserAgent" title="Go to Request.UserAgent" aria-label="Go to Request.UserAgent">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>func (r *<a href="#Request">Request</a>) UserAgent() <a href="/builtin#string">string</a></pre> </div> <p>UserAgent returns the client's User-Agent, if sent in the request. </p> </div><div class="Documentation-typeMethod"> <h4 tabindex="-1" id="Request.WithContext" data-kind="method" class="Documentation-typeMethodHeader"> <span>func (*Request) <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/request.go;l=368">WithContext</a> <a class="Documentation-idLink" href="#Request.WithContext" title="Go to Request.WithContext" aria-label="Go to Request.WithContext">¶</a></span> <span class="Documentation-sinceVersion"> <span class="Documentation-sinceVersionLabel">added in</span> <span class="Documentation-sinceVersionVersion">go1.7</span> </span> </h4> <div class="Documentation-declaration"> <pre>func (r *<a href="#Request">Request</a>) WithContext(ctx <a href="/context">context</a>.<a href="/context#Context">Context</a>) *<a href="#Request">Request</a></pre> </div> <p>WithContext returns a shallow copy of r with its context changed to ctx. The provided ctx must be non-nil. </p><p>For outgoing client request, the context controls the entire lifetime of a request and its response: obtaining a connection, sending the request, and reading the response headers and body. </p><p>To create a new request with a context, use <a href="#NewRequestWithContext">NewRequestWithContext</a>. To make a deep copy of a request with a new context, use <a href="#Request.Clone">Request.Clone</a>. </p> </div><div class="Documentation-typeMethod"> <h4 tabindex="-1" id="Request.Write" data-kind="method" class="Documentation-typeMethodHeader"> <span>func (*Request) <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/request.go;l=561">Write</a> <a class="Documentation-idLink" href="#Request.Write" title="Go to Request.Write" aria-label="Go to Request.Write">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>func (r *<a href="#Request">Request</a>) Write(w <a href="/io">io</a>.<a href="/io#Writer">Writer</a>) <a href="/builtin#error">error</a></pre> </div> <p>Write writes an HTTP/1.1 request, which is the header and body, in wire format. This method consults the following fields of the request: </p><pre>Host URL Method (defaults to "GET") Header ContentLength TransferEncoding Body </pre><p>If Body is present, Content-Length is <= 0 and [Request.TransferEncoding] hasn't been set to "identity", Write adds "Transfer-Encoding: chunked" to the header. Body is closed after it is sent. </p> </div><div class="Documentation-typeMethod"> <h4 tabindex="-1" id="Request.WriteProxy" data-kind="method" class="Documentation-typeMethodHeader"> <span>func (*Request) <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/request.go;l=571">WriteProxy</a> <a class="Documentation-idLink" href="#Request.WriteProxy" title="Go to Request.WriteProxy" aria-label="Go to Request.WriteProxy">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>func (r *<a href="#Request">Request</a>) WriteProxy(w <a href="/io">io</a>.<a href="/io#Writer">Writer</a>) <a href="/builtin#error">error</a></pre> </div> <p>WriteProxy is like <a href="#Request.Write">Request.Write</a> but writes the request in the form expected by an HTTP proxy. In particular, <a href="#Request.WriteProxy">Request.WriteProxy</a> writes the initial Request-URI line of the request with an absolute URI, per section 5.3 of <a href="https://rfc-editor.org/rfc/rfc7230.html">RFC 7230</a>, including the scheme and host. In either case, WriteProxy also writes a Host header, using either r.Host or r.URL.Host. </p> </div> </div><div class="Documentation-type"> <h4 tabindex="-1" id="Response" data-kind="type" class="Documentation-typeHeader"> <span>type <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/response.go;l=35">Response</a> <a class="Documentation-idLink" href="#Response" title="Go to Response" aria-label="Go to Response">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>type Response struct { <span id="Response.Status" data-kind="field"> Status <a href="/builtin#string">string</a> <span class="comment">// e.g. "200 OK"</span> </span><span id="Response.StatusCode" data-kind="field"> StatusCode <a href="/builtin#int">int</a> <span class="comment">// e.g. 200</span> </span><span id="Response.Proto" data-kind="field"> Proto <a href="/builtin#string">string</a> <span class="comment">// e.g. "HTTP/1.0"</span> </span><span id="Response.ProtoMajor" data-kind="field"> ProtoMajor <a href="/builtin#int">int</a> <span class="comment">// e.g. 1</span> </span><span id="Response.ProtoMinor" data-kind="field"> ProtoMinor <a href="/builtin#int">int</a> <span class="comment">// e.g. 0</span> </span> <span id="Response.Header" data-kind="field"> <span class="comment">// Header maps header keys to values. If the response had multiple</span> </span> <span class="comment">// headers with the same key, they may be concatenated, with comma</span> <span class="comment">// delimiters. (<a href="https://rfc-editor.org/rfc/rfc7230.html#section-3.2.2">RFC 7230, section 3.2.2</a> requires that multiple headers</span> <span class="comment">// be semantically equivalent to a comma-delimited sequence.) When</span> <span class="comment">// Header values are duplicated by other fields in this struct (e.g.,</span> <span class="comment">// ContentLength, TransferEncoding, Trailer), the field values are</span> <span class="comment">// authoritative.</span> <span class="comment">//</span> <span class="comment">// Keys in the map are canonicalized (see CanonicalHeaderKey).</span> Header <a href="#Header">Header</a> <span id="Response.Body" data-kind="field"> <span class="comment">// Body represents the response body.</span> </span> <span class="comment">//</span> <span class="comment">// The response body is streamed on demand as the Body field</span> <span class="comment">// is read. If the network connection fails or the server</span> <span class="comment">// terminates the response, Body.Read calls return an error.</span> <span class="comment">//</span> <span class="comment">// The http Client and Transport guarantee that Body is always</span> <span class="comment">// non-nil, even on responses without a body or responses with</span> <span class="comment">// a zero-length body. It is the caller's responsibility to</span> <span class="comment">// close Body. The default HTTP client's Transport may not</span> <span class="comment">// reuse HTTP/1.x "keep-alive" TCP connections if the Body is</span> <span class="comment">// not read to completion and closed.</span> <span class="comment">//</span> <span class="comment">// The Body is automatically dechunked if the server replied</span> <span class="comment">// with a "chunked" Transfer-Encoding.</span> <span class="comment">//</span> <span class="comment">// As of Go 1.12, the Body will also implement io.Writer</span> <span class="comment">// on a successful "101 Switching Protocols" response,</span> <span class="comment">// as used by WebSockets and HTTP/2's "h2c" mode.</span> Body <a href="/io">io</a>.<a href="/io#ReadCloser">ReadCloser</a> <span id="Response.ContentLength" data-kind="field"> <span class="comment">// ContentLength records the length of the associated content. The</span> </span> <span class="comment">// value -1 indicates that the length is unknown. Unless Request.Method</span> <span class="comment">// is "HEAD", values >= 0 indicate that the given number of bytes may</span> <span class="comment">// be read from Body.</span> ContentLength <a href="/builtin#int64">int64</a> <span id="Response.TransferEncoding" data-kind="field"> <span class="comment">// Contains transfer encodings from outer-most to inner-most. Value is</span> </span> <span class="comment">// nil, means that "identity" encoding is used.</span> TransferEncoding []<a href="/builtin#string">string</a> <span id="Response.Close" data-kind="field"> <span class="comment">// Close records whether the header directed that the connection be</span> </span> <span class="comment">// closed after reading Body. The value is advice for clients: neither</span> <span class="comment">// ReadResponse nor Response.Write ever closes a connection.</span> Close <a href="/builtin#bool">bool</a> <span id="Response.Uncompressed" data-kind="field"> <span class="comment">// Uncompressed reports whether the response was sent compressed but</span> </span> <span class="comment">// was decompressed by the http package. When true, reading from</span> <span class="comment">// Body yields the uncompressed content instead of the compressed</span> <span class="comment">// content actually set from the server, ContentLength is set to -1,</span> <span class="comment">// and the "Content-Length" and "Content-Encoding" fields are deleted</span> <span class="comment">// from the responseHeader. To get the original response from</span> <span class="comment">// the server, set Transport.DisableCompression to true.</span> Uncompressed <a href="/builtin#bool">bool</a> <span id="Response.Trailer" data-kind="field"> <span class="comment">// Trailer maps trailer keys to values in the same</span> </span> <span class="comment">// format as Header.</span> <span class="comment">//</span> <span class="comment">// The Trailer initially contains only nil values, one for</span> <span class="comment">// each key specified in the server's "Trailer" header</span> <span class="comment">// value. Those values are not added to Header.</span> <span class="comment">//</span> <span class="comment">// Trailer must not be accessed concurrently with Read calls</span> <span class="comment">// on the Body.</span> <span class="comment">//</span> <span class="comment">// After Body.Read has returned io.EOF, Trailer will contain</span> <span class="comment">// any trailer values sent by the server.</span> Trailer <a href="#Header">Header</a> <span id="Response.Request" data-kind="field"> <span class="comment">// Request is the request that was sent to obtain this Response.</span> </span> <span class="comment">// Request's Body is nil (having already been consumed).</span> <span class="comment">// This is only populated for Client requests.</span> Request *<a href="#Request">Request</a> <span id="Response.TLS" data-kind="field"> <span class="comment">// TLS contains information about the TLS connection on which the</span> </span> <span class="comment">// response was received. It is nil for unencrypted responses.</span> <span class="comment">// The pointer is shared between responses and should not be</span> <span class="comment">// modified.</span> TLS *<a href="/crypto/tls">tls</a>.<a href="/crypto/tls#ConnectionState">ConnectionState</a> }</pre> </div> <p>Response represents the response from an HTTP request. </p><p>The <a href="#Client">Client</a> and <a href="#Transport">Transport</a> return Responses from servers once the response headers have been received. The response body is streamed on demand as the Body field is read. </p> <div class="Documentation-typeFunc"> <h4 tabindex="-1" id="Get" data-kind="function" class="Documentation-typeFuncHeader"> <span>func <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/client.go;l=452">Get</a> <a class="Documentation-idLink" href="#Get" title="Go to Get" aria-label="Go to Get">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>func Get(url <a href="/builtin#string">string</a>) (resp *<a href="#Response">Response</a>, err <a href="/builtin#error">error</a>)</pre> </div> <p>Get issues a GET to the specified URL. If the response is one of the following redirect codes, Get follows the redirect, up to a maximum of 10 redirects: </p><pre>301 (Moved Permanently) 302 (Found) 303 (See Other) 307 (Temporary Redirect) 308 (Permanent Redirect) </pre><p>An error is returned if there were too many redirects or if there was an HTTP protocol error. A non-2xx response doesn't cause an error. Any returned error will be of type <a href="/net/url#Error">*url.Error</a>. The url.Error value's Timeout method will report true if the request timed out. </p><p>When err is nil, resp always contains a non-nil resp.Body. Caller should close resp.Body when done reading from it. </p><p>Get is a wrapper around DefaultClient.Get. </p><p>To make a request with custom headers, use <a href="#NewRequest">NewRequest</a> and DefaultClient.Do. </p><p>To make a request with a specified context.Context, use <a href="#NewRequestWithContext">NewRequestWithContext</a> and DefaultClient.Do. </p> <details tabindex="-1" id="example-Get" class="Documentation-exampleDetails js-exampleContainer"> <summary class="Documentation-exampleDetailsHeader">Example <a href="#example-Get" title="Go to Example" aria-label="Go to Example">¶</a></summary> <div class="Documentation-exampleDetailsBody"> <pre class="Documentation-exampleCode"> package main import ( "fmt" "io" "log" "net/http" ) func main() { res, err := http.Get("http://www.google.com/robots.txt") if err != nil { log.Fatal(err) } body, err := io.ReadAll(res.Body) res.Body.Close() if res.StatusCode > 299 { log.Fatalf("Response failed with status code: %d and\nbody: %s\n", res.StatusCode, body) } if err != nil { log.Fatal(err) } fmt.Printf("%s", body) } </pre> <pre><span class="Documentation-exampleOutputLabel">Output:</span> <span class="Documentation-exampleOutput"></span></pre> </div> <div class="Documentation-exampleButtonsContainer"> <p class="Documentation-exampleError" role="alert" aria-atomic="true"></p> <button class="Documentation-exampleShareButton" aria-label="Share Code">Share</button> <button class="Documentation-exampleFormatButton" aria-label="Format Code">Format</button> <button class="Documentation-exampleRunButton" aria-label="Run Code">Run</button> </div></details> </div><div class="Documentation-typeFunc"> <h4 tabindex="-1" id="Head" data-kind="function" class="Documentation-typeFuncHeader"> <span>func <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/client.go;l=920">Head</a> <a class="Documentation-idLink" href="#Head" title="Go to Head" aria-label="Go to Head">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>func Head(url <a href="/builtin#string">string</a>) (resp *<a href="#Response">Response</a>, err <a href="/builtin#error">error</a>)</pre> </div> <p>Head issues a HEAD to the specified URL. If the response is one of the following redirect codes, Head follows the redirect, up to a maximum of 10 redirects: </p><pre>301 (Moved Permanently) 302 (Found) 303 (See Other) 307 (Temporary Redirect) 308 (Permanent Redirect) </pre><p>Head is a wrapper around DefaultClient.Head. </p><p>To make a request with a specified <a href="/context#Context">context.Context</a>, use <a href="#NewRequestWithContext">NewRequestWithContext</a> and DefaultClient.Do. </p> </div><div class="Documentation-typeFunc"> <h4 tabindex="-1" id="Post" data-kind="function" class="Documentation-typeFuncHeader"> <span>func <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/client.go;l=841">Post</a> <a class="Documentation-idLink" href="#Post" title="Go to Post" aria-label="Go to Post">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>func Post(url, contentType <a href="/builtin#string">string</a>, body <a href="/io">io</a>.<a href="/io#Reader">Reader</a>) (resp *<a href="#Response">Response</a>, err <a href="/builtin#error">error</a>)</pre> </div> <p>Post issues a POST to the specified URL. </p><p>Caller should close resp.Body when done reading from it. </p><p>If the provided body is an <a href="/io#Closer">io.Closer</a>, it is closed after the request. </p><p>Post is a wrapper around DefaultClient.Post. </p><p>To set custom headers, use <a href="#NewRequest">NewRequest</a> and DefaultClient.Do. </p><p>See the <a href="#Client.Do">Client.Do</a> method documentation for details on how redirects are handled. </p><p>To make a request with a specified context.Context, use <a href="#NewRequestWithContext">NewRequestWithContext</a> and DefaultClient.Do. </p> </div><div class="Documentation-typeFunc"> <h4 tabindex="-1" id="PostForm" data-kind="function" class="Documentation-typeFuncHeader"> <span>func <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/client.go;l=884">PostForm</a> <a class="Documentation-idLink" href="#PostForm" title="Go to PostForm" aria-label="Go to PostForm">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>func PostForm(url <a href="/builtin#string">string</a>, data <a href="/net/url">url</a>.<a href="/net/url#Values">Values</a>) (resp *<a href="#Response">Response</a>, err <a href="/builtin#error">error</a>)</pre> </div> <p>PostForm issues a POST to the specified URL, with data's keys and values URL-encoded as the request body. </p><p>The Content-Type header is set to application/x-www-form-urlencoded. To set other headers, use <a href="#NewRequest">NewRequest</a> and DefaultClient.Do. </p><p>When err is nil, resp always contains a non-nil resp.Body. Caller should close resp.Body when done reading from it. </p><p>PostForm is a wrapper around DefaultClient.PostForm. </p><p>See the <a href="#Client.Do">Client.Do</a> method documentation for details on how redirects are handled. </p><p>To make a request with a specified <a href="/context#Context">context.Context</a>, use <a href="#NewRequestWithContext">NewRequestWithContext</a> and DefaultClient.Do. </p> </div><div class="Documentation-typeFunc"> <h4 tabindex="-1" id="ReadResponse" data-kind="function" class="Documentation-typeFuncHeader"> <span>func <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/response.go;l=154">ReadResponse</a> <a class="Documentation-idLink" href="#ReadResponse" title="Go to ReadResponse" aria-label="Go to ReadResponse">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>func ReadResponse(r *<a href="/bufio">bufio</a>.<a href="/bufio#Reader">Reader</a>, req *<a href="#Request">Request</a>) (*<a href="#Response">Response</a>, <a href="/builtin#error">error</a>)</pre> </div> <p>ReadResponse reads and returns an HTTP response from r. The req parameter optionally specifies the <a href="#Request">Request</a> that corresponds to this <a href="#Response">Response</a>. If nil, a GET request is assumed. Clients must call resp.Body.Close when finished reading resp.Body. After that call, clients can inspect resp.Trailer to find key/value pairs included in the response trailer. </p> </div><div class="Documentation-typeMethod"> <h4 tabindex="-1" id="Response.Cookies" data-kind="method" class="Documentation-typeMethodHeader"> <span>func (*Response) <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/response.go;l=125">Cookies</a> <a class="Documentation-idLink" href="#Response.Cookies" title="Go to Response.Cookies" aria-label="Go to Response.Cookies">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>func (r *<a href="#Response">Response</a>) Cookies() []*<a href="#Cookie">Cookie</a></pre> </div> <p>Cookies parses and returns the cookies set in the Set-Cookie headers. </p> </div><div class="Documentation-typeMethod"> <h4 tabindex="-1" id="Response.Location" data-kind="method" class="Documentation-typeMethodHeader"> <span>func (*Response) <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/response.go;l=137">Location</a> <a class="Documentation-idLink" href="#Response.Location" title="Go to Response.Location" aria-label="Go to Response.Location">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>func (r *<a href="#Response">Response</a>) Location() (*<a href="/net/url">url</a>.<a href="/net/url#URL">URL</a>, <a href="/builtin#error">error</a>)</pre> </div> <p>Location returns the URL of the response's "Location" header, if present. Relative redirects are resolved relative to [Response.Request]. <a href="#ErrNoLocation">ErrNoLocation</a> is returned if no Location header is present. </p> </div><div class="Documentation-typeMethod"> <h4 tabindex="-1" id="Response.ProtoAtLeast" data-kind="method" class="Documentation-typeMethodHeader"> <span>func (*Response) <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/response.go;l=224">ProtoAtLeast</a> <a class="Documentation-idLink" href="#Response.ProtoAtLeast" title="Go to Response.ProtoAtLeast" aria-label="Go to Response.ProtoAtLeast">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>func (r *<a href="#Response">Response</a>) ProtoAtLeast(major, minor <a href="/builtin#int">int</a>) <a href="/builtin#bool">bool</a></pre> </div> <p>ProtoAtLeast reports whether the HTTP protocol used in the response is at least major.minor. </p> </div><div class="Documentation-typeMethod"> <h4 tabindex="-1" id="Response.Write" data-kind="method" class="Documentation-typeMethodHeader"> <span>func (*Response) <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/response.go;l=245">Write</a> <a class="Documentation-idLink" href="#Response.Write" title="Go to Response.Write" aria-label="Go to Response.Write">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>func (r *<a href="#Response">Response</a>) Write(w <a href="/io">io</a>.<a href="/io#Writer">Writer</a>) <a href="/builtin#error">error</a></pre> </div> <p>Write writes r to w in the HTTP/1.x server response format, including the status line, headers, body, and optional trailer. </p><p>This method consults the following fields of the response r: </p><pre>StatusCode ProtoMajor ProtoMinor Request.Method TransferEncoding Trailer Body ContentLength Header, values for non-canonical keys will have unpredictable behavior </pre><p>The Response Body is closed after it is sent. </p> </div> </div><div class="Documentation-type"> <h4 tabindex="-1" id="ResponseController" data-kind="type" class="Documentation-typeHeader"> <span>type <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/responsecontroller.go;l=17">ResponseController</a> <a class="Documentation-idLink" href="#ResponseController" title="Go to ResponseController" aria-label="Go to ResponseController">¶</a></span> <span class="Documentation-sinceVersion"> <span class="Documentation-sinceVersionLabel">added in</span> <span class="Documentation-sinceVersionVersion">go1.20</span> </span> </h4> <div class="Documentation-declaration"> <pre>type ResponseController struct { <span class="comment">// contains filtered or unexported fields</span> }</pre> </div> <p>A ResponseController is used by an HTTP handler to control the response. </p><p>A ResponseController may not be used after the [Handler.ServeHTTP] method has returned. </p> <div class="Documentation-typeFunc"> <h4 tabindex="-1" id="NewResponseController" data-kind="function" class="Documentation-typeFuncHeader"> <span>func <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/responsecontroller.go;l=38">NewResponseController</a> <a class="Documentation-idLink" href="#NewResponseController" title="Go to NewResponseController" aria-label="Go to NewResponseController">¶</a></span> <span class="Documentation-sinceVersion"> <span class="Documentation-sinceVersionLabel">added in</span> <span class="Documentation-sinceVersionVersion">go1.20</span> </span> </h4> <div class="Documentation-declaration"> <pre>func NewResponseController(rw <a href="#ResponseWriter">ResponseWriter</a>) *<a href="#ResponseController">ResponseController</a></pre> </div> <p>NewResponseController creates a <a href="#ResponseController">ResponseController</a> for a request. </p><p>The ResponseWriter should be the original value passed to the [Handler.ServeHTTP] method, or have an Unwrap method returning the original ResponseWriter. </p><p>If the ResponseWriter implements any of the following methods, the ResponseController will call them as appropriate: </p><pre>Flush() FlushError() error // alternative Flush returning an error Hijack() (net.Conn, *bufio.ReadWriter, error) SetReadDeadline(deadline time.Time) error SetWriteDeadline(deadline time.Time) error EnableFullDuplex() error </pre><p>If the ResponseWriter does not support a method, ResponseController returns an error matching <a href="#ErrNotSupported">ErrNotSupported</a>. </p> </div><div class="Documentation-typeMethod"> <h4 tabindex="-1" id="ResponseController.EnableFullDuplex" data-kind="method" class="Documentation-typeMethodHeader"> <span>func (*ResponseController) <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/responsecontroller.go;l=129">EnableFullDuplex</a> <a class="Documentation-idLink" href="#ResponseController.EnableFullDuplex" title="Go to ResponseController.EnableFullDuplex" aria-label="Go to ResponseController.EnableFullDuplex">¶</a></span> <span class="Documentation-sinceVersion"> <span class="Documentation-sinceVersionLabel">added in</span> <span class="Documentation-sinceVersionVersion">go1.21.0</span> </span> </h4> <div class="Documentation-declaration"> <pre>func (c *<a href="#ResponseController">ResponseController</a>) EnableFullDuplex() <a href="/builtin#error">error</a></pre> </div> <p>EnableFullDuplex indicates that the request handler will interleave reads from [Request.Body] with writes to the <a href="#ResponseWriter">ResponseWriter</a>. </p><p>For HTTP/1 requests, the Go HTTP server by default consumes any unread portion of the request body before beginning to write the response, preventing handlers from concurrently reading from the request and writing the response. Calling EnableFullDuplex disables this behavior and permits handlers to continue to read from the request while concurrently writing the response. </p><p>For HTTP/2 requests, the Go HTTP server always permits concurrent reads and responses. </p> </div><div class="Documentation-typeMethod"> <h4 tabindex="-1" id="ResponseController.Flush" data-kind="method" class="Documentation-typeMethodHeader"> <span>func (*ResponseController) <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/responsecontroller.go;l=47">Flush</a> <a class="Documentation-idLink" href="#ResponseController.Flush" title="Go to ResponseController.Flush" aria-label="Go to ResponseController.Flush">¶</a></span> <span class="Documentation-sinceVersion"> <span class="Documentation-sinceVersionLabel">added in</span> <span class="Documentation-sinceVersionVersion">go1.20</span> </span> </h4> <div class="Documentation-declaration"> <pre>func (c *<a href="#ResponseController">ResponseController</a>) Flush() <a href="/builtin#error">error</a></pre> </div> <p>Flush flushes buffered data to the client. </p> </div><div class="Documentation-typeMethod"> <h4 tabindex="-1" id="ResponseController.Hijack" data-kind="method" class="Documentation-typeMethodHeader"> <span>func (*ResponseController) <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/responsecontroller.go;l=66">Hijack</a> <a class="Documentation-idLink" href="#ResponseController.Hijack" title="Go to ResponseController.Hijack" aria-label="Go to ResponseController.Hijack">¶</a></span> <span class="Documentation-sinceVersion"> <span class="Documentation-sinceVersionLabel">added in</span> <span class="Documentation-sinceVersionVersion">go1.20</span> </span> </h4> <div class="Documentation-declaration"> <pre>func (c *<a href="#ResponseController">ResponseController</a>) Hijack() (<a href="/net">net</a>.<a href="/net#Conn">Conn</a>, *<a href="/bufio">bufio</a>.<a href="/bufio#ReadWriter">ReadWriter</a>, <a href="/builtin#error">error</a>)</pre> </div> <p>Hijack lets the caller take over the connection. See the Hijacker interface for details. </p> </div><div class="Documentation-typeMethod"> <h4 tabindex="-1" id="ResponseController.SetReadDeadline" data-kind="method" class="Documentation-typeMethodHeader"> <span>func (*ResponseController) <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/responsecontroller.go;l=85">SetReadDeadline</a> <a class="Documentation-idLink" href="#ResponseController.SetReadDeadline" title="Go to ResponseController.SetReadDeadline" aria-label="Go to ResponseController.SetReadDeadline">¶</a></span> <span class="Documentation-sinceVersion"> <span class="Documentation-sinceVersionLabel">added in</span> <span class="Documentation-sinceVersionVersion">go1.20</span> </span> </h4> <div class="Documentation-declaration"> <pre>func (c *<a href="#ResponseController">ResponseController</a>) SetReadDeadline(deadline <a href="/time">time</a>.<a href="/time#Time">Time</a>) <a href="/builtin#error">error</a></pre> </div> <p>SetReadDeadline sets the deadline for reading the entire request, including the body. Reads from the request body after the deadline has been exceeded will return an error. A zero value means no deadline. </p><p>Setting the read deadline after it has been exceeded will not extend it. </p> </div><div class="Documentation-typeMethod"> <h4 tabindex="-1" id="ResponseController.SetWriteDeadline" data-kind="method" class="Documentation-typeMethodHeader"> <span>func (*ResponseController) <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/responsecontroller.go;l=105">SetWriteDeadline</a> <a class="Documentation-idLink" href="#ResponseController.SetWriteDeadline" title="Go to ResponseController.SetWriteDeadline" aria-label="Go to ResponseController.SetWriteDeadline">¶</a></span> <span class="Documentation-sinceVersion"> <span class="Documentation-sinceVersionLabel">added in</span> <span class="Documentation-sinceVersionVersion">go1.20</span> </span> </h4> <div class="Documentation-declaration"> <pre>func (c *<a href="#ResponseController">ResponseController</a>) SetWriteDeadline(deadline <a href="/time">time</a>.<a href="/time#Time">Time</a>) <a href="/builtin#error">error</a></pre> </div> <p>SetWriteDeadline sets the deadline for writing the response. Writes to the response body after the deadline has been exceeded will not block, but may succeed if the data has been buffered. A zero value means no deadline. </p><p>Setting the write deadline after it has been exceeded will not extend it. </p> </div> </div><div class="Documentation-type"> <h4 tabindex="-1" id="ResponseWriter" data-kind="type" class="Documentation-typeHeader"> <span>type <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/server.go;l=96">ResponseWriter</a> <a class="Documentation-idLink" href="#ResponseWriter" title="Go to ResponseWriter" aria-label="Go to ResponseWriter">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>type ResponseWriter interface { <span id="ResponseWriter.Header" data-kind="method"> <span class="comment">// Header returns the header map that will be sent by</span> </span> <span class="comment">// [ResponseWriter.WriteHeader]. The [Header] map also is the mechanism with which</span> <span class="comment">// [Handler] implementations can set HTTP trailers.</span> <span class="comment">//</span> <span class="comment">// Changing the header map after a call to [ResponseWriter.WriteHeader] (or</span> <span class="comment">// [ResponseWriter.Write]) has no effect unless the HTTP status code was of the</span> <span class="comment">// 1xx class or the modified headers are trailers.</span> <span class="comment">//</span> <span class="comment">// There are two ways to set Trailers. The preferred way is to</span> <span class="comment">// predeclare in the headers which trailers you will later</span> <span class="comment">// send by setting the "Trailer" header to the names of the</span> <span class="comment">// trailer keys which will come later. In this case, those</span> <span class="comment">// keys of the Header map are treated as if they were</span> <span class="comment">// trailers. See the example. The second way, for trailer</span> <span class="comment">// keys not known to the [Handler] until after the first [ResponseWriter.Write],</span> <span class="comment">// is to prefix the [Header] map keys with the [TrailerPrefix]</span> <span class="comment">// constant value.</span> <span class="comment">//</span> <span class="comment">// To suppress automatic response headers (such as "Date"), set</span> <span class="comment">// their value to nil.</span> Header() <a href="#Header">Header</a> <span id="ResponseWriter.Write" data-kind="method"> <span class="comment">// Write writes the data to the connection as part of an HTTP reply.</span> </span> <span class="comment">//</span> <span class="comment">// If [ResponseWriter.WriteHeader] has not yet been called, Write calls</span> <span class="comment">// WriteHeader(http.StatusOK) before writing the data. If the Header</span> <span class="comment">// does not contain a Content-Type line, Write adds a Content-Type set</span> <span class="comment">// to the result of passing the initial 512 bytes of written data to</span> <span class="comment">// [DetectContentType]. Additionally, if the total size of all written</span> <span class="comment">// data is under a few KB and there are no Flush calls, the</span> <span class="comment">// Content-Length header is added automatically.</span> <span class="comment">//</span> <span class="comment">// Depending on the HTTP protocol version and the client, calling</span> <span class="comment">// Write or WriteHeader may prevent future reads on the</span> <span class="comment">// Request.Body. For HTTP/1.x requests, handlers should read any</span> <span class="comment">// needed request body data before writing the response. Once the</span> <span class="comment">// headers have been flushed (due to either an explicit Flusher.Flush</span> <span class="comment">// call or writing enough data to trigger a flush), the request body</span> <span class="comment">// may be unavailable. For HTTP/2 requests, the Go HTTP server permits</span> <span class="comment">// handlers to continue to read the request body while concurrently</span> <span class="comment">// writing the response. However, such behavior may not be supported</span> <span class="comment">// by all HTTP/2 clients. Handlers should read before writing if</span> <span class="comment">// possible to maximize compatibility.</span> Write([]<a href="/builtin#byte">byte</a>) (<a href="/builtin#int">int</a>, <a href="/builtin#error">error</a>) <span id="ResponseWriter.WriteHeader" data-kind="method"> <span class="comment">// WriteHeader sends an HTTP response header with the provided</span> </span> <span class="comment">// status code.</span> <span class="comment">//</span> <span class="comment">// If WriteHeader is not called explicitly, the first call to Write</span> <span class="comment">// will trigger an implicit WriteHeader(http.StatusOK).</span> <span class="comment">// Thus explicit calls to WriteHeader are mainly used to</span> <span class="comment">// send error codes or 1xx informational responses.</span> <span class="comment">//</span> <span class="comment">// The provided code must be a valid HTTP 1xx-5xx status code.</span> <span class="comment">// Any number of 1xx headers may be written, followed by at most</span> <span class="comment">// one 2xx-5xx header. 1xx headers are sent immediately, but 2xx-5xx</span> <span class="comment">// headers may be buffered. Use the Flusher interface to send</span> <span class="comment">// buffered data. The header map is cleared when 2xx-5xx headers are</span> <span class="comment">// sent, but not with 1xx headers.</span> <span class="comment">//</span> <span class="comment">// The server will automatically send a 100 (Continue) header</span> <span class="comment">// on the first read from the request body if the request has</span> <span class="comment">// an "Expect: 100-continue" header.</span> WriteHeader(statusCode <a href="/builtin#int">int</a>) }</pre> </div> <p>A ResponseWriter interface is used by an HTTP handler to construct an HTTP response. </p><p>A ResponseWriter may not be used after [Handler.ServeHTTP] has returned. </p> <details tabindex="-1" id="example-ResponseWriter-Trailers" class="Documentation-exampleDetails js-exampleContainer"> <summary class="Documentation-exampleDetailsHeader">Example (Trailers) <a href="#example-ResponseWriter-Trailers" title="Go to Example (Trailers)" aria-label="Go to Example (Trailers)">¶</a></summary> <div class="Documentation-exampleDetailsBody"> <p>HTTP Trailers are a set of key/value pairs like headers that come after the HTTP response, instead of before. </p> <pre class="Documentation-exampleCode"> package main import ( "io" "net/http" ) func main() { mux := http.NewServeMux() mux.HandleFunc("/sendstrailers", func(w http.ResponseWriter, req *http.Request) { // Before any call to WriteHeader or Write, declare // the trailers you will set during the HTTP // response. These three headers are actually sent in // the trailer. w.Header().Set("Trailer", "AtEnd1, AtEnd2") w.Header().Add("Trailer", "AtEnd3") w.Header().Set("Content-Type", "text/plain; charset=utf-8") // normal header w.WriteHeader(http.StatusOK) w.Header().Set("AtEnd1", "value 1") io.WriteString(w, "This HTTP response has both headers before this text and trailers at the end.\n") w.Header().Set("AtEnd2", "value 2") w.Header().Set("AtEnd3", "value 3") // These will appear as trailers. }) } </pre> <pre><span class="Documentation-exampleOutputLabel">Output:</span> <span class="Documentation-exampleOutput"></span></pre> </div> <div class="Documentation-exampleButtonsContainer"> <p class="Documentation-exampleError" role="alert" aria-atomic="true"></p> <button class="Documentation-exampleShareButton" aria-label="Share Code">Share</button> <button class="Documentation-exampleFormatButton" aria-label="Format Code">Format</button> <button class="Documentation-exampleRunButton" aria-label="Run Code">Run</button> </div></details> </div><div class="Documentation-type"> <h4 tabindex="-1" id="RoundTripper" data-kind="type" class="Documentation-typeHeader"> <span>type <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/client.go;l=116">RoundTripper</a> <a class="Documentation-idLink" href="#RoundTripper" title="Go to RoundTripper" aria-label="Go to RoundTripper">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>type RoundTripper interface { <span id="RoundTripper.RoundTrip" data-kind="method"> <span class="comment">// RoundTrip executes a single HTTP transaction, returning</span> </span> <span class="comment">// a Response for the provided Request.</span> <span class="comment">//</span> <span class="comment">// RoundTrip should not attempt to interpret the response. In</span> <span class="comment">// particular, RoundTrip must return err == nil if it obtained</span> <span class="comment">// a response, regardless of the response's HTTP status code.</span> <span class="comment">// A non-nil err should be reserved for failure to obtain a</span> <span class="comment">// response. Similarly, RoundTrip should not attempt to</span> <span class="comment">// handle higher-level protocol details such as redirects,</span> <span class="comment">// authentication, or cookies.</span> <span class="comment">//</span> <span class="comment">// RoundTrip should not modify the request, except for</span> <span class="comment">// consuming and closing the Request's Body. RoundTrip may</span> <span class="comment">// read fields of the request in a separate goroutine. Callers</span> <span class="comment">// should not mutate or reuse the request until the Response's</span> <span class="comment">// Body has been closed.</span> <span class="comment">//</span> <span class="comment">// RoundTrip must always close the body, including on errors,</span> <span class="comment">// but depending on the implementation may do so in a separate</span> <span class="comment">// goroutine even after RoundTrip returns. This means that</span> <span class="comment">// callers wanting to reuse the body for subsequent requests</span> <span class="comment">// must arrange to wait for the Close call before doing so.</span> <span class="comment">//</span> <span class="comment">// The Request's URL and Header fields must be initialized.</span> RoundTrip(*<a href="#Request">Request</a>) (*<a href="#Response">Response</a>, <a href="/builtin#error">error</a>) }</pre> </div> <p>RoundTripper is an interface representing the ability to execute a single HTTP transaction, obtaining the <a href="#Response">Response</a> for a given <a href="#Request">Request</a>. </p><p>A RoundTripper must be safe for concurrent use by multiple goroutines. </p> <div class="Documentation-typeVariable"> <div class="Documentation-declaration"> <pre><span id="DefaultTransport" data-kind="variable">var DefaultTransport <a href="#RoundTripper">RoundTripper</a> = &<a href="#Transport">Transport</a>{ </span> Proxy: <a href="#ProxyFromEnvironment">ProxyFromEnvironment</a>, DialContext: defaultTransportDialContext(&<a href="/net">net</a>.<a href="/net#Dialer">Dialer</a>{ Timeout: 30 * <a href="/time">time</a>.<a href="/time#Second">Second</a>, KeepAlive: 30 * <a href="/time">time</a>.<a href="/time#Second">Second</a>, }), ForceAttemptHTTP2: <a href="/builtin#true">true</a>, MaxIdleConns: 100, IdleConnTimeout: 90 * <a href="/time">time</a>.<a href="/time#Second">Second</a>, TLSHandshakeTimeout: 10 * <a href="/time">time</a>.<a href="/time#Second">Second</a>, ExpectContinueTimeout: 1 * <a href="/time">time</a>.<a href="/time#Second">Second</a>, }</pre> </div> <p>DefaultTransport is the default implementation of <a href="#Transport">Transport</a> and is used by <a href="#DefaultClient">DefaultClient</a>. It establishes network connections as needed and caches them for reuse by subsequent calls. It uses HTTP proxies as directed by the environment variables HTTP_PROXY, HTTPS_PROXY and NO_PROXY (or the lowercase versions thereof). </p> </div><div class="Documentation-typeFunc"> <h4 tabindex="-1" id="NewFileTransport" data-kind="function" class="Documentation-typeFuncHeader"> <span>func <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/filetransport.go;l=31">NewFileTransport</a> <a class="Documentation-idLink" href="#NewFileTransport" title="Go to NewFileTransport" aria-label="Go to NewFileTransport">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>func NewFileTransport(fs <a href="#FileSystem">FileSystem</a>) <a href="#RoundTripper">RoundTripper</a></pre> </div> <p>NewFileTransport returns a new <a href="#RoundTripper">RoundTripper</a>, serving the provided <a href="#FileSystem">FileSystem</a>. The returned RoundTripper ignores the URL host in its incoming requests, as well as most other properties of the request. </p><p>The typical use case for NewFileTransport is to register the "file" protocol with a <a href="#Transport">Transport</a>, as in: </p><pre>t := &http.Transport{} t.RegisterProtocol("file", http.NewFileTransport(http.Dir("/"))) c := &http.Client{Transport: t} res, err := c.Get("file:///etc/passwd") ... </pre> </div><div class="Documentation-typeFunc"> <h4 tabindex="-1" id="NewFileTransportFS" data-kind="function" class="Documentation-typeFuncHeader"> <span>func <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/filetransport.go;l=49">NewFileTransportFS</a> <a class="Documentation-idLink" href="#NewFileTransportFS" title="Go to NewFileTransportFS" aria-label="Go to NewFileTransportFS">¶</a></span> <span class="Documentation-sinceVersion"> <span class="Documentation-sinceVersionLabel">added in</span> <span class="Documentation-sinceVersionVersion">go1.22.0</span> </span> </h4> <div class="Documentation-declaration"> <pre>func NewFileTransportFS(fsys <a href="/io/fs">fs</a>.<a href="/io/fs#FS">FS</a>) <a href="#RoundTripper">RoundTripper</a></pre> </div> <p>NewFileTransportFS returns a new <a href="#RoundTripper">RoundTripper</a>, serving the provided file system fsys. The returned RoundTripper ignores the URL host in its incoming requests, as well as most other properties of the request. The files provided by fsys must implement <a href="/io#Seeker">io.Seeker</a>. </p><p>The typical use case for NewFileTransportFS is to register the "file" protocol with a <a href="#Transport">Transport</a>, as in: </p><pre>fsys := os.DirFS("/") t := &http.Transport{} t.RegisterProtocol("file", http.NewFileTransportFS(fsys)) c := &http.Client{Transport: t} res, err := c.Get("file:///etc/passwd") ... </pre> </div> </div><div class="Documentation-type"> <h4 tabindex="-1" id="SameSite" data-kind="type" class="Documentation-typeHeader"> <span>type <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/cookie.go;l=51">SameSite</a> <a class="Documentation-idLink" href="#SameSite" title="Go to SameSite" aria-label="Go to SameSite">¶</a></span> <span class="Documentation-sinceVersion"> <span class="Documentation-sinceVersionLabel">added in</span> <span class="Documentation-sinceVersionVersion">go1.11</span> </span> </h4> <div class="Documentation-declaration"> <pre>type SameSite <a href="/builtin#int">int</a></pre> </div> <p>SameSite allows a server to define a cookie attribute making it impossible for the browser to send this cookie along with cross-site requests. The main goal is to mitigate the risk of cross-origin information leakage, and provide some protection against cross-site request forgery attacks. </p><p>See <a href="https://tools.ietf.org/html/draft-ietf-httpbis-cookie-same-site-00">https://tools.ietf.org/html/draft-ietf-httpbis-cookie-same-site-00</a> for details. </p> <div class="Documentation-typeConstant"> <div class="Documentation-declaration"> <pre>const ( <span id="SameSiteDefaultMode" data-kind="constant"> SameSiteDefaultMode <a href="#SameSite">SameSite</a> = <a href="/builtin#iota">iota</a> + 1 </span><span id="SameSiteLaxMode" data-kind="constant"> SameSiteLaxMode </span><span id="SameSiteStrictMode" data-kind="constant"> SameSiteStrictMode </span><span id="SameSiteNoneMode" data-kind="constant"> SameSiteNoneMode </span>)</pre> </div> </div> </div><div class="Documentation-type"> <h4 tabindex="-1" id="ServeMux" data-kind="type" class="Documentation-typeHeader"> <span>type <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/server.go;l=2581">ServeMux</a> <a class="Documentation-idLink" href="#ServeMux" title="Go to ServeMux" aria-label="Go to ServeMux">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>type ServeMux struct { <span class="comment">// contains filtered or unexported fields</span> }</pre> </div> <div role="navigation" aria-label="Table of Contents"> <ul class="Documentation-toc"> <li class="Documentation-tocItem"><a href="#hdr-Patterns-ServeMux">Patterns</a></li> <li class="Documentation-tocItem"><a href="#hdr-Precedence-ServeMux">Precedence</a></li> <li class="Documentation-tocItem"><a href="#hdr-Trailing_slash_redirection-ServeMux">Trailing-slash redirection</a></li> <li class="Documentation-tocItem"><a href="#hdr-Request_sanitizing-ServeMux">Request sanitizing</a></li> <li class="Documentation-tocItem"><a href="#hdr-Compatibility-ServeMux">Compatibility</a></li> </ul> </div> <p>ServeMux is an HTTP request multiplexer. It matches the URL of each incoming request against a list of registered patterns and calls the handler for the pattern that most closely matches the URL. </p><h4 id="hdr-Patterns-ServeMux">Patterns <a class="Documentation-idLink" href="#hdr-Patterns-ServeMux" title="Go to Patterns" aria-label="Go to Patterns">¶</a></h4><p>Patterns can match the method, host and path of a request. Some examples: </p><ul class="Documentation-bulletList"> <li>"/index.html" matches the path "/index.html" for any host and method.</li> <li>"GET /static/" matches a GET request whose path begins with "/static/".</li> <li>"example.com/" matches any request to the host "example.com".</li> <li>"example.com/{$}" matches requests with host "example.com" and path "/".</li> <li>"/b/{bucket}/o/{objectname...}" matches paths whose first segment is "b" and whose third segment is "o". The name "bucket" denotes the second segment and "objectname" denotes the remainder of the path.</li> </ul><p>In general, a pattern looks like </p><pre>[METHOD ][HOST]/[PATH] </pre><p>All three parts are optional; "/" is a valid pattern. If METHOD is present, it must be followed by at least one space or tab. </p><p>Literal (that is, non-wildcard) parts of a pattern match the corresponding parts of a request case-sensitively. </p><p>A pattern with no method matches every method. A pattern with the method GET matches both GET and HEAD requests. Otherwise, the method must match exactly. </p><p>A pattern with no host matches every host. A pattern with a host matches URLs on that host only. </p><p>A path can include wildcard segments of the form {NAME} or {NAME...}. For example, "/b/{bucket}/o/{objectname...}". The wildcard name must be a valid Go identifier. Wildcards must be full path segments: they must be preceded by a slash and followed by either a slash or the end of the string. For example, "/b_{bucket}" is not a valid pattern. </p><p>Normally a wildcard matches only a single path segment, ending at the next literal slash (not %2F) in the request URL. But if the "..." is present, then the wildcard matches the remainder of the URL path, including slashes. (Therefore it is invalid for a "..." wildcard to appear anywhere but at the end of a pattern.) The match for a wildcard can be obtained by calling <a href="#Request.PathValue">Request.PathValue</a> with the wildcard's name. A trailing slash in a path acts as an anonymous "..." wildcard. </p><p>The special wildcard {$} matches only the end of the URL. For example, the pattern "/{$}" matches only the path "/", whereas the pattern "/" matches every path. </p><p>For matching, both pattern paths and incoming request paths are unescaped segment by segment. So, for example, the path "/a%2Fb/100%25" is treated as having two segments, "a/b" and "100%". The pattern "/a%2fb/" matches it, but the pattern "/a/b/" does not. </p><h4 id="hdr-Precedence-ServeMux">Precedence <a class="Documentation-idLink" href="#hdr-Precedence-ServeMux" title="Go to Precedence" aria-label="Go to Precedence">¶</a></h4><p>If two or more patterns match a request, then the most specific pattern takes precedence. A pattern P1 is more specific than P2 if P1 matches a strict subset of P2’s requests; that is, if P2 matches all the requests of P1 and more. If neither is more specific, then the patterns conflict. There is one exception to this rule, for backwards compatibility: if two patterns would otherwise conflict and one has a host while the other does not, then the pattern with the host takes precedence. If a pattern passed to <a href="#ServeMux.Handle">ServeMux.Handle</a> or <a href="#ServeMux.HandleFunc">ServeMux.HandleFunc</a> conflicts with another pattern that is already registered, those functions panic. </p><p>As an example of the general rule, "/images/thumbnails/" is more specific than "/images/", so both can be registered. The former matches paths beginning with "/images/thumbnails/" and the latter will match any other path in the "/images/" subtree. </p><p>As another example, consider the patterns "GET /" and "/index.html": both match a GET request for "/index.html", but the former pattern matches all other GET and HEAD requests, while the latter matches any request for "/index.html" that uses a different method. The patterns conflict. </p><h4 id="hdr-Trailing_slash_redirection-ServeMux">Trailing-slash redirection <a class="Documentation-idLink" href="#hdr-Trailing_slash_redirection-ServeMux" title="Go to Trailing-slash redirection" aria-label="Go to Trailing-slash redirection">¶</a></h4><p>Consider a <a href="#ServeMux">ServeMux</a> with a handler for a subtree, registered using a trailing slash or "..." wildcard. If the ServeMux receives a request for the subtree root without a trailing slash, it redirects the request by adding the trailing slash. This behavior can be overridden with a separate registration for the path without the trailing slash or "..." wildcard. For example, registering "/images/" causes ServeMux to redirect a request for "/images" to "/images/", unless "/images" has been registered separately. </p><h4 id="hdr-Request_sanitizing-ServeMux">Request sanitizing <a class="Documentation-idLink" href="#hdr-Request_sanitizing-ServeMux" title="Go to Request sanitizing" aria-label="Go to Request sanitizing">¶</a></h4><p>ServeMux also takes care of sanitizing the URL request path and the Host header, stripping the port number and redirecting any request containing . or .. segments or repeated slashes to an equivalent, cleaner URL. Escaped path elements such as "%2e" for "." and "%2f" for "/" are preserved and aren't considered separators for request routing. </p><h4 id="hdr-Compatibility-ServeMux">Compatibility <a class="Documentation-idLink" href="#hdr-Compatibility-ServeMux" title="Go to Compatibility" aria-label="Go to Compatibility">¶</a></h4><p>The pattern syntax and matching behavior of ServeMux changed significantly in Go 1.22. To restore the old behavior, set the GODEBUG environment variable to "httpmuxgo121=1". This setting is read once, at program startup; changes during execution will be ignored. </p><p>The backwards-incompatible changes include: </p><ul class="Documentation-bulletList"> <li>Wildcards are just ordinary literal path segments in 1.21. For example, the pattern "/{x}" will match only that path in 1.21, but will match any one-segment path in 1.22.</li> <li>In 1.21, no pattern was rejected, unless it was empty or conflicted with an existing pattern. In 1.22, syntactically invalid patterns will cause <a href="#ServeMux.Handle">ServeMux.Handle</a> and <a href="#ServeMux.HandleFunc">ServeMux.HandleFunc</a> to panic. For example, in 1.21, the patterns "/{" and "/a{x}" match themselves, but in 1.22 they are invalid and will cause a panic when registered.</li> <li>In 1.22, each segment of a pattern is unescaped; this was not done in 1.21. For example, in 1.22 the pattern "/%61" matches the path "/a" ("%61" being the URL escape sequence for "a"), but in 1.21 it would match only the path "/%2561" (where "%25" is the escape for the percent sign).</li> <li>When matching patterns to paths, in 1.22 each segment of the path is unescaped; in 1.21, the entire path is unescaped. This change mostly affects how paths with %2F escapes adjacent to slashes are treated. See <a href="https://go.dev/issue/21955">https://go.dev/issue/21955</a> for details.</li> </ul> <div class="Documentation-typeFunc"> <h4 tabindex="-1" id="NewServeMux" data-kind="function" class="Documentation-typeFuncHeader"> <span>func <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/server.go;l=2589">NewServeMux</a> <a class="Documentation-idLink" href="#NewServeMux" title="Go to NewServeMux" aria-label="Go to NewServeMux">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>func NewServeMux() *<a href="#ServeMux">ServeMux</a></pre> </div> <p>NewServeMux allocates and returns a new <a href="#ServeMux">ServeMux</a>. </p> </div><div class="Documentation-typeMethod"> <h4 tabindex="-1" id="ServeMux.Handle" data-kind="method" class="Documentation-typeMethodHeader"> <span>func (*ServeMux) <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/server.go;l=2831">Handle</a> <a class="Documentation-idLink" href="#ServeMux.Handle" title="Go to ServeMux.Handle" aria-label="Go to ServeMux.Handle">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>func (mux *<a href="#ServeMux">ServeMux</a>) Handle(pattern <a href="/builtin#string">string</a>, handler <a href="#Handler">Handler</a>)</pre> </div> <p>Handle registers the handler for the given pattern. If the given pattern conflicts, with one that is already registered, Handle panics. </p> <details tabindex="-1" id="example-ServeMux.Handle" class="Documentation-exampleDetails js-exampleContainer"> <summary class="Documentation-exampleDetailsHeader">Example <a href="#example-ServeMux.Handle" title="Go to Example" aria-label="Go to Example">¶</a></summary> <div class="Documentation-exampleDetailsBody"> <pre class="Documentation-exampleCode"> package main import ( "fmt" "net/http" ) type apiHandler struct{} func (apiHandler) ServeHTTP(http.ResponseWriter, *http.Request) {} func main() { mux := http.NewServeMux() mux.Handle("/api/", apiHandler{}) mux.HandleFunc("/", func(w http.ResponseWriter, req *http.Request) { // The "/" pattern matches everything, so we need to check // that we're at the root here. if req.URL.Path != "/" { http.NotFound(w, req) return } fmt.Fprintf(w, "Welcome to the home page!") }) } </pre> <pre><span class="Documentation-exampleOutputLabel">Output:</span> <span class="Documentation-exampleOutput"></span></pre> </div> <div class="Documentation-exampleButtonsContainer"> <p class="Documentation-exampleError" role="alert" aria-atomic="true"></p> <button class="Documentation-exampleShareButton" aria-label="Share Code">Share</button> <button class="Documentation-exampleFormatButton" aria-label="Format Code">Format</button> <button class="Documentation-exampleRunButton" aria-label="Run Code">Run</button> </div></details> </div><div class="Documentation-typeMethod"> <h4 tabindex="-1" id="ServeMux.HandleFunc" data-kind="method" class="Documentation-typeMethodHeader"> <span>func (*ServeMux) <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/server.go;l=2842">HandleFunc</a> <a class="Documentation-idLink" href="#ServeMux.HandleFunc" title="Go to ServeMux.HandleFunc" aria-label="Go to ServeMux.HandleFunc">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>func (mux *<a href="#ServeMux">ServeMux</a>) HandleFunc(pattern <a href="/builtin#string">string</a>, handler func(<a href="#ResponseWriter">ResponseWriter</a>, *<a href="#Request">Request</a>))</pre> </div> <p>HandleFunc registers the handler function for the given pattern. If the given pattern conflicts, with one that is already registered, HandleFunc panics. </p> </div><div class="Documentation-typeMethod"> <h4 tabindex="-1" id="ServeMux.Handler" data-kind="method" class="Documentation-typeMethodHeader"> <span>func (*ServeMux) <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/server.go;l=2648">Handler</a> <a class="Documentation-idLink" href="#ServeMux.Handler" title="Go to ServeMux.Handler" aria-label="Go to ServeMux.Handler">¶</a></span> <span class="Documentation-sinceVersion"> <span class="Documentation-sinceVersionLabel">added in</span> <span class="Documentation-sinceVersionVersion">go1.1</span> </span> </h4> <div class="Documentation-declaration"> <pre>func (mux *<a href="#ServeMux">ServeMux</a>) Handler(r *<a href="#Request">Request</a>) (h <a href="#Handler">Handler</a>, pattern <a href="/builtin#string">string</a>)</pre> </div> <p>Handler returns the handler to use for the given request, consulting r.Method, r.Host, and r.URL.Path. It always returns a non-nil handler. If the path is not in its canonical form, the handler will be an internally-generated handler that redirects to the canonical path. If the host contains a port, it is ignored when matching handlers. </p><p>The path and host are used unchanged for CONNECT requests. </p><p>Handler also returns the registered pattern that matches the request or, in the case of internally-generated redirects, the path that will match after following the redirect. </p><p>If there is no registered handler that applies to the request, Handler returns a “page not found” handler and an empty pattern. </p> </div><div class="Documentation-typeMethod"> <h4 tabindex="-1" id="ServeMux.ServeHTTP" data-kind="method" class="Documentation-typeMethodHeader"> <span>func (*ServeMux) <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/server.go;l=2808">ServeHTTP</a> <a class="Documentation-idLink" href="#ServeMux.ServeHTTP" title="Go to ServeMux.ServeHTTP" aria-label="Go to ServeMux.ServeHTTP">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>func (mux *<a href="#ServeMux">ServeMux</a>) ServeHTTP(w <a href="#ResponseWriter">ResponseWriter</a>, r *<a href="#Request">Request</a>)</pre> </div> <p>ServeHTTP dispatches the request to the handler whose pattern most closely matches the request URL. </p> </div> </div><div class="Documentation-type"> <h4 tabindex="-1" id="Server" data-kind="type" class="Documentation-typeHeader"> <span>type <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/server.go;l=2954">Server</a> <a class="Documentation-idLink" href="#Server" title="Go to Server" aria-label="Go to Server">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>type Server struct { <span id="Server.Addr" data-kind="field"> <span class="comment">// Addr optionally specifies the TCP address for the server to listen on,</span> </span> <span class="comment">// in the form "host:port". If empty, ":http" (port 80) is used.</span> <span class="comment">// The service names are defined in <a href="https://rfc-editor.org/rfc/rfc6335.html">RFC 6335</a> and assigned by IANA.</span> <span class="comment">// See net.Dial for details of the address format.</span> Addr <a href="/builtin#string">string</a> <span id="Server.Handler" data-kind="field"> Handler <a href="#Handler">Handler</a> <span class="comment">// handler to invoke, http.DefaultServeMux if nil</span> </span> <span id="Server.DisableGeneralOptionsHandler" data-kind="field"> <span class="comment">// DisableGeneralOptionsHandler, if true, passes "OPTIONS *" requests to the Handler,</span> </span> <span class="comment">// otherwise responds with 200 OK and Content-Length: 0.</span> DisableGeneralOptionsHandler <a href="/builtin#bool">bool</a> <span id="Server.TLSConfig" data-kind="field"> <span class="comment">// TLSConfig optionally provides a TLS configuration for use</span> </span> <span class="comment">// by ServeTLS and ListenAndServeTLS. Note that this value is</span> <span class="comment">// cloned by ServeTLS and ListenAndServeTLS, so it's not</span> <span class="comment">// possible to modify the configuration with methods like</span> <span class="comment">// tls.Config.SetSessionTicketKeys. To use</span> <span class="comment">// SetSessionTicketKeys, use Server.Serve with a TLS Listener</span> <span class="comment">// instead.</span> TLSConfig *<a href="/crypto/tls">tls</a>.<a href="/crypto/tls#Config">Config</a> <span id="Server.ReadTimeout" data-kind="field"> <span class="comment">// ReadTimeout is the maximum duration for reading the entire</span> </span> <span class="comment">// request, including the body. A zero or negative value means</span> <span class="comment">// there will be no timeout.</span> <span class="comment">//</span> <span class="comment">// Because ReadTimeout does not let Handlers make per-request</span> <span class="comment">// decisions on each request body's acceptable deadline or</span> <span class="comment">// upload rate, most users will prefer to use</span> <span class="comment">// ReadHeaderTimeout. It is valid to use them both.</span> ReadTimeout <a href="/time">time</a>.<a href="/time#Duration">Duration</a> <span id="Server.ReadHeaderTimeout" data-kind="field"> <span class="comment">// ReadHeaderTimeout is the amount of time allowed to read</span> </span> <span class="comment">// request headers. The connection's read deadline is reset</span> <span class="comment">// after reading the headers and the Handler can decide what</span> <span class="comment">// is considered too slow for the body. If zero, the value of</span> <span class="comment">// ReadTimeout is used. If negative, or if zero and ReadTimeout</span> <span class="comment">// is zero or negative, there is no timeout.</span> ReadHeaderTimeout <a href="/time">time</a>.<a href="/time#Duration">Duration</a> <span id="Server.WriteTimeout" data-kind="field"> <span class="comment">// WriteTimeout is the maximum duration before timing out</span> </span> <span class="comment">// writes of the response. It is reset whenever a new</span> <span class="comment">// request's header is read. Like ReadTimeout, it does not</span> <span class="comment">// let Handlers make decisions on a per-request basis.</span> <span class="comment">// A zero or negative value means there will be no timeout.</span> WriteTimeout <a href="/time">time</a>.<a href="/time#Duration">Duration</a> <span id="Server.IdleTimeout" data-kind="field"> <span class="comment">// IdleTimeout is the maximum amount of time to wait for the</span> </span> <span class="comment">// next request when keep-alives are enabled. If zero, the value</span> <span class="comment">// of ReadTimeout is used. If negative, or if zero and ReadTimeout</span> <span class="comment">// is zero or negative, there is no timeout.</span> IdleTimeout <a href="/time">time</a>.<a href="/time#Duration">Duration</a> <span id="Server.MaxHeaderBytes" data-kind="field"> <span class="comment">// MaxHeaderBytes controls the maximum number of bytes the</span> </span> <span class="comment">// server will read parsing the request header's keys and</span> <span class="comment">// values, including the request line. It does not limit the</span> <span class="comment">// size of the request body.</span> <span class="comment">// If zero, DefaultMaxHeaderBytes is used.</span> MaxHeaderBytes <a href="/builtin#int">int</a> <span id="Server.TLSNextProto" data-kind="field"> <span class="comment">// TLSNextProto optionally specifies a function to take over</span> </span> <span class="comment">// ownership of the provided TLS connection when an ALPN</span> <span class="comment">// protocol upgrade has occurred. The map key is the protocol</span> <span class="comment">// name negotiated. The Handler argument should be used to</span> <span class="comment">// handle HTTP requests and will initialize the Request's TLS</span> <span class="comment">// and RemoteAddr if not already set. The connection is</span> <span class="comment">// automatically closed when the function returns.</span> <span class="comment">// If TLSNextProto is not nil, HTTP/2 support is not enabled</span> <span class="comment">// automatically.</span> TLSNextProto map[<a href="/builtin#string">string</a>]func(*<a href="#Server">Server</a>, *<a href="/crypto/tls">tls</a>.<a href="/crypto/tls#Conn">Conn</a>, <a href="#Handler">Handler</a>) <span id="Server.ConnState" data-kind="field"> <span class="comment">// ConnState specifies an optional callback function that is</span> </span> <span class="comment">// called when a client connection changes state. See the</span> <span class="comment">// ConnState type and associated constants for details.</span> ConnState func(<a href="/net">net</a>.<a href="/net#Conn">Conn</a>, <a href="#ConnState">ConnState</a>) <span id="Server.ErrorLog" data-kind="field"> <span class="comment">// ErrorLog specifies an optional logger for errors accepting</span> </span> <span class="comment">// connections, unexpected behavior from handlers, and</span> <span class="comment">// underlying FileSystem errors.</span> <span class="comment">// If nil, logging is done via the log package's standard logger.</span> ErrorLog *<a href="/log">log</a>.<a href="/log#Logger">Logger</a> <span id="Server.BaseContext" data-kind="field"> <span class="comment">// BaseContext optionally specifies a function that returns</span> </span> <span class="comment">// the base context for incoming requests on this server.</span> <span class="comment">// The provided Listener is the specific Listener that's</span> <span class="comment">// about to start accepting requests.</span> <span class="comment">// If BaseContext is nil, the default is context.Background().</span> <span class="comment">// If non-nil, it must return a non-nil context.</span> BaseContext func(<a href="/net">net</a>.<a href="/net#Listener">Listener</a>) <a href="/context">context</a>.<a href="/context#Context">Context</a> <span id="Server.ConnContext" data-kind="field"> <span class="comment">// ConnContext optionally specifies a function that modifies</span> </span> <span class="comment">// the context used for a new connection c. The provided ctx</span> <span class="comment">// is derived from the base context and has a ServerContextKey</span> <span class="comment">// value.</span> ConnContext func(ctx <a href="/context">context</a>.<a href="/context#Context">Context</a>, c <a href="/net">net</a>.<a href="/net#Conn">Conn</a>) <a href="/context">context</a>.<a href="/context#Context">Context</a> <span id="Server.HTTP2" data-kind="field"> <span class="comment">// HTTP2 configures HTTP/2 connections.</span> </span> <span class="comment">//</span> <span class="comment">// This field does not yet have any effect.</span> <span class="comment">// See <a href="https://go.dev/issue/67813">https://go.dev/issue/67813</a>.</span> HTTP2 *<a href="#HTTP2Config">HTTP2Config</a> <span id="Server.Protocols" data-kind="field"> <span class="comment">// Protocols is the set of protocols accepted by the server.</span> </span> <span class="comment">//</span> <span class="comment">// If Protocols includes UnencryptedHTTP2, the server will accept</span> <span class="comment">// unencrypted HTTP/2 connections. The server can serve both</span> <span class="comment">// HTTP/1 and unencrypted HTTP/2 on the same address and port.</span> <span class="comment">//</span> <span class="comment">// If Protocols is nil, the default is usually HTTP/1 and HTTP/2.</span> <span class="comment">// If TLSNextProto is non-nil and does not contain an "h2" entry,</span> <span class="comment">// the default is HTTP/1 only.</span> Protocols *<a href="#Protocols">Protocols</a> <span class="comment">// contains filtered or unexported fields</span> }</pre> </div> <p>A Server defines parameters for running an HTTP server. The zero value for Server is a valid configuration. </p> <div class="Documentation-typeMethod"> <h4 tabindex="-1" id="Server.Close" data-kind="method" class="Documentation-typeMethodHeader"> <span>func (*Server) <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/server.go;l=3090">Close</a> <a class="Documentation-idLink" href="#Server.Close" title="Go to Server.Close" aria-label="Go to Server.Close">¶</a></span> <span class="Documentation-sinceVersion"> <span class="Documentation-sinceVersionLabel">added in</span> <span class="Documentation-sinceVersionVersion">go1.8</span> </span> </h4> <div class="Documentation-declaration"> <pre>func (s *<a href="#Server">Server</a>) Close() <a href="/builtin#error">error</a></pre> </div> <p>Close immediately closes all active net.Listeners and any connections in state <a href="#StateNew">StateNew</a>, <a href="#StateActive">StateActive</a>, or <a href="#StateIdle">StateIdle</a>. For a graceful shutdown, use <a href="#Server.Shutdown">Server.Shutdown</a>. </p><p>Close does not attempt to close (and does not even know about) any hijacked connections, such as WebSockets. </p><p>Close returns any error returned from closing the <a href="#Server">Server</a>'s underlying Listener(s). </p> </div><div class="Documentation-typeMethod"> <h4 tabindex="-1" id="Server.ListenAndServe" data-kind="method" class="Documentation-typeMethodHeader"> <span>func (*Server) <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/server.go;l=3338">ListenAndServe</a> <a class="Documentation-idLink" href="#Server.ListenAndServe" title="Go to Server.ListenAndServe" aria-label="Go to Server.ListenAndServe">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>func (s *<a href="#Server">Server</a>) ListenAndServe() <a href="/builtin#error">error</a></pre> </div> <p>ListenAndServe listens on the TCP network address s.Addr and then calls <a href="#Serve">Serve</a> to handle requests on incoming connections. Accepted connections are configured to enable TCP keep-alives. </p><p>If s.Addr is blank, ":http" is used. </p><p>ListenAndServe always returns a non-nil error. After <a href="#Server.Shutdown">Server.Shutdown</a> or <a href="#Server.Close">Server.Close</a>, the returned error is <a href="#ErrServerClosed">ErrServerClosed</a>. </p> </div><div class="Documentation-typeMethod"> <h4 tabindex="-1" id="Server.ListenAndServeTLS" data-kind="method" class="Documentation-typeMethodHeader"> <span>func (*Server) <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/server.go;l=3693">ListenAndServeTLS</a> <a class="Documentation-idLink" href="#Server.ListenAndServeTLS" title="Go to Server.ListenAndServeTLS" aria-label="Go to Server.ListenAndServeTLS">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>func (s *<a href="#Server">Server</a>) ListenAndServeTLS(certFile, keyFile <a href="/builtin#string">string</a>) <a href="/builtin#error">error</a></pre> </div> <p>ListenAndServeTLS listens on the TCP network address s.Addr and then calls <a href="#ServeTLS">ServeTLS</a> to handle requests on incoming TLS connections. Accepted connections are configured to enable TCP keep-alives. </p><p>Filenames containing a certificate and matching private key for the server must be provided if neither the <a href="#Server">Server</a>'s TLSConfig.Certificates nor TLSConfig.GetCertificate are populated. If the certificate is signed by a certificate authority, the certFile should be the concatenation of the server's certificate, any intermediates, and the CA's certificate. </p><p>If s.Addr is blank, ":https" is used. </p><p>ListenAndServeTLS always returns a non-nil error. After <a href="#Server.Shutdown">Server.Shutdown</a> or <a href="#Server.Close">Server.Close</a>, the returned error is <a href="#ErrServerClosed">ErrServerClosed</a>. </p> </div><div class="Documentation-typeMethod"> <h4 tabindex="-1" id="Server.RegisterOnShutdown" data-kind="method" class="Documentation-typeMethodHeader"> <span>func (*Server) <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/server.go;l=3183">RegisterOnShutdown</a> <a class="Documentation-idLink" href="#Server.RegisterOnShutdown" title="Go to Server.RegisterOnShutdown" aria-label="Go to Server.RegisterOnShutdown">¶</a></span> <span class="Documentation-sinceVersion"> <span class="Documentation-sinceVersionLabel">added in</span> <span class="Documentation-sinceVersionVersion">go1.9</span> </span> </h4> <div class="Documentation-declaration"> <pre>func (s *<a href="#Server">Server</a>) RegisterOnShutdown(f func())</pre> </div> <p>RegisterOnShutdown registers a function to call on <a href="#Server.Shutdown">Server.Shutdown</a>. This can be used to gracefully shutdown connections that have undergone ALPN protocol upgrade or that have been hijacked. This function should start protocol-specific graceful shutdown, but should not wait for shutdown to complete. </p> </div><div class="Documentation-typeMethod"> <h4 tabindex="-1" id="Server.Serve" data-kind="method" class="Documentation-typeMethodHeader"> <span>func (*Server) <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/server.go;l=3394">Serve</a> <a class="Documentation-idLink" href="#Server.Serve" title="Go to Server.Serve" aria-label="Go to Server.Serve">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>func (s *<a href="#Server">Server</a>) Serve(l <a href="/net">net</a>.<a href="/net#Listener">Listener</a>) <a href="/builtin#error">error</a></pre> </div> <p>Serve accepts incoming connections on the Listener l, creating a new service goroutine for each. The service goroutines read requests and then call s.Handler to reply to them. </p><p>HTTP/2 support is only enabled if the Listener returns <a href="/crypto/tls#Conn">*tls.Conn</a> connections and they were configured with "h2" in the TLS Config.NextProtos. </p><p>Serve always returns a non-nil error and closes l. After <a href="#Server.Shutdown">Server.Shutdown</a> or <a href="#Server.Close">Server.Close</a>, the returned error is <a href="#ErrServerClosed">ErrServerClosed</a>. </p> </div><div class="Documentation-typeMethod"> <h4 tabindex="-1" id="Server.ServeTLS" data-kind="method" class="Documentation-typeMethodHeader"> <span>func (*Server) <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/server.go;l=3472">ServeTLS</a> <a class="Documentation-idLink" href="#Server.ServeTLS" title="Go to Server.ServeTLS" aria-label="Go to Server.ServeTLS">¶</a></span> <span class="Documentation-sinceVersion"> <span class="Documentation-sinceVersionLabel">added in</span> <span class="Documentation-sinceVersionVersion">go1.9</span> </span> </h4> <div class="Documentation-declaration"> <pre>func (s *<a href="#Server">Server</a>) ServeTLS(l <a href="/net">net</a>.<a href="/net#Listener">Listener</a>, certFile, keyFile <a href="/builtin#string">string</a>) <a href="/builtin#error">error</a></pre> </div> <p>ServeTLS accepts incoming connections on the Listener l, creating a new service goroutine for each. The service goroutines perform TLS setup and then read requests, calling s.Handler to reply to them. </p><p>Files containing a certificate and matching private key for the server must be provided if neither the <a href="#Server">Server</a>'s TLSConfig.Certificates, TLSConfig.GetCertificate nor config.GetConfigForClient are populated. If the certificate is signed by a certificate authority, the certFile should be the concatenation of the server's certificate, any intermediates, and the CA's certificate. </p><p>ServeTLS always returns a non-nil error. After <a href="#Server.Shutdown">Server.Shutdown</a> or <a href="#Server.Close">Server.Close</a>, the returned error is <a href="#ErrServerClosed">ErrServerClosed</a>. </p> </div><div class="Documentation-typeMethod"> <h4 tabindex="-1" id="Server.SetKeepAlivesEnabled" data-kind="method" class="Documentation-typeMethodHeader"> <span>func (*Server) <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/server.go;l=3623">SetKeepAlivesEnabled</a> <a class="Documentation-idLink" href="#Server.SetKeepAlivesEnabled" title="Go to Server.SetKeepAlivesEnabled" aria-label="Go to Server.SetKeepAlivesEnabled">¶</a></span> <span class="Documentation-sinceVersion"> <span class="Documentation-sinceVersionLabel">added in</span> <span class="Documentation-sinceVersionVersion">go1.3</span> </span> </h4> <div class="Documentation-declaration"> <pre>func (s *<a href="#Server">Server</a>) SetKeepAlivesEnabled(v <a href="/builtin#bool">bool</a>)</pre> </div> <p>SetKeepAlivesEnabled controls whether HTTP keep-alives are enabled. By default, keep-alives are always enabled. Only very resource-constrained environments or servers in the process of shutting down should disable them. </p> </div><div class="Documentation-typeMethod"> <h4 tabindex="-1" id="Server.Shutdown" data-kind="method" class="Documentation-typeMethodHeader"> <span>func (*Server) <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/server.go;l=3140">Shutdown</a> <a class="Documentation-idLink" href="#Server.Shutdown" title="Go to Server.Shutdown" aria-label="Go to Server.Shutdown">¶</a></span> <span class="Documentation-sinceVersion"> <span class="Documentation-sinceVersionLabel">added in</span> <span class="Documentation-sinceVersionVersion">go1.8</span> </span> </h4> <div class="Documentation-declaration"> <pre>func (s *<a href="#Server">Server</a>) Shutdown(ctx <a href="/context">context</a>.<a href="/context#Context">Context</a>) <a href="/builtin#error">error</a></pre> </div> <p>Shutdown gracefully shuts down the server without interrupting any active connections. Shutdown works by first closing all open listeners, then closing all idle connections, and then waiting indefinitely for connections to return to idle and then shut down. If the provided context expires before the shutdown is complete, Shutdown returns the context's error, otherwise it returns any error returned from closing the <a href="#Server">Server</a>'s underlying Listener(s). </p><p>When Shutdown is called, <a href="#Serve">Serve</a>, <a href="#ListenAndServe">ListenAndServe</a>, and <a href="#ListenAndServeTLS">ListenAndServeTLS</a> immediately return <a href="#ErrServerClosed">ErrServerClosed</a>. Make sure the program doesn't exit and waits instead for Shutdown to return. </p><p>Shutdown does not attempt to close nor wait for hijacked connections such as WebSockets. The caller of Shutdown should separately notify such long-lived connections of shutdown and wait for them to close, if desired. See <a href="#Server.RegisterOnShutdown">Server.RegisterOnShutdown</a> for a way to register shutdown notification functions. </p><p>Once Shutdown has been called on a server, it may not be reused; future calls to methods such as Serve will return ErrServerClosed. </p> <details tabindex="-1" id="example-Server.Shutdown" class="Documentation-exampleDetails js-exampleContainer"> <summary class="Documentation-exampleDetailsHeader">Example <a href="#example-Server.Shutdown" title="Go to Example" aria-label="Go to Example">¶</a></summary> <div class="Documentation-exampleDetailsBody"> <pre class="Documentation-exampleCode"> package main import ( "context" "log" "net/http" "os" "os/signal" ) func main() { var srv http.Server idleConnsClosed := make(chan struct{}) go func() { sigint := make(chan os.Signal, 1) signal.Notify(sigint, os.Interrupt) <-sigint // We received an interrupt signal, shut down. if err := srv.Shutdown(context.Background()); err != nil { // Error from closing listeners, or context timeout: log.Printf("HTTP server Shutdown: %v", err) } close(idleConnsClosed) }() if err := srv.ListenAndServe(); err != http.ErrServerClosed { // Error starting or closing listener: log.Fatalf("HTTP server ListenAndServe: %v", err) } <-idleConnsClosed } </pre> <pre><span class="Documentation-exampleOutputLabel">Output:</span> <span class="Documentation-exampleOutput"></span></pre> </div> <div class="Documentation-exampleButtonsContainer"> <p class="Documentation-exampleError" role="alert" aria-atomic="true"></p> <button class="Documentation-exampleShareButton" aria-label="Share Code">Share</button> <button class="Documentation-exampleFormatButton" aria-label="Format Code">Format</button> <button class="Documentation-exampleRunButton" aria-label="Run Code">Run</button> </div></details> </div> </div><div class="Documentation-type"> <h4 tabindex="-1" id="Transport" data-kind="type" class="Documentation-typeHeader"> <span>type <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/transport.go;l=96">Transport</a> <a class="Documentation-idLink" href="#Transport" title="Go to Transport" aria-label="Go to Transport">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>type Transport struct { <span id="Transport.Proxy" data-kind="field"> <span class="comment">// Proxy specifies a function to return a proxy for a given</span> </span> <span class="comment">// Request. If the function returns a non-nil error, the</span> <span class="comment">// request is aborted with the provided error.</span> <span class="comment">//</span> <span class="comment">// The proxy type is determined by the URL scheme. "http",</span> <span class="comment">// "https", "socks5", and "socks5h" are supported. If the scheme is empty,</span> <span class="comment">// "http" is assumed.</span> <span class="comment">// "socks5" is treated the same as "socks5h".</span> <span class="comment">//</span> <span class="comment">// If the proxy URL contains a userinfo subcomponent,</span> <span class="comment">// the proxy request will pass the username and password</span> <span class="comment">// in a Proxy-Authorization header.</span> <span class="comment">//</span> <span class="comment">// If Proxy is nil or returns a nil *URL, no proxy is used.</span> Proxy func(*<a href="#Request">Request</a>) (*<a href="/net/url">url</a>.<a href="/net/url#URL">URL</a>, <a href="/builtin#error">error</a>) <span id="Transport.OnProxyConnectResponse" data-kind="field"> <span class="comment">// OnProxyConnectResponse is called when the Transport gets an HTTP response from</span> </span> <span class="comment">// a proxy for a CONNECT request. It's called before the check for a 200 OK response.</span> <span class="comment">// If it returns an error, the request fails with that error.</span> OnProxyConnectResponse func(ctx <a href="/context">context</a>.<a href="/context#Context">Context</a>, proxyURL *<a href="/net/url">url</a>.<a href="/net/url#URL">URL</a>, connectReq *<a href="#Request">Request</a>, connectRes *<a href="#Response">Response</a>) <a href="/builtin#error">error</a> <span id="Transport.DialContext" data-kind="field"> <span class="comment">// DialContext specifies the dial function for creating unencrypted TCP connections.</span> </span> <span class="comment">// If DialContext is nil (and the deprecated Dial below is also nil),</span> <span class="comment">// then the transport dials using package net.</span> <span class="comment">//</span> <span class="comment">// DialContext runs concurrently with calls to RoundTrip.</span> <span class="comment">// A RoundTrip call that initiates a dial may end up using</span> <span class="comment">// a connection dialed previously when the earlier connection</span> <span class="comment">// becomes idle before the later DialContext completes.</span> DialContext func(ctx <a href="/context">context</a>.<a href="/context#Context">Context</a>, network, addr <a href="/builtin#string">string</a>) (<a href="/net">net</a>.<a href="/net#Conn">Conn</a>, <a href="/builtin#error">error</a>) <span id="Transport.Dial" data-kind="field"> <span class="comment">// Dial specifies the dial function for creating unencrypted TCP connections.</span> </span> <span class="comment">//</span> <span class="comment">// Dial runs concurrently with calls to RoundTrip.</span> <span class="comment">// A RoundTrip call that initiates a dial may end up using</span> <span class="comment">// a connection dialed previously when the earlier connection</span> <span class="comment">// becomes idle before the later Dial completes.</span> <span class="comment">//</span> <span class="comment">// Deprecated: Use DialContext instead, which allows the transport</span> <span class="comment">// to cancel dials as soon as they are no longer needed.</span> <span class="comment">// If both are set, DialContext takes priority.</span> Dial func(network, addr <a href="/builtin#string">string</a>) (<a href="/net">net</a>.<a href="/net#Conn">Conn</a>, <a href="/builtin#error">error</a>) <span id="Transport.DialTLSContext" data-kind="field"> <span class="comment">// DialTLSContext specifies an optional dial function for creating</span> </span> <span class="comment">// TLS connections for non-proxied HTTPS requests.</span> <span class="comment">//</span> <span class="comment">// If DialTLSContext is nil (and the deprecated DialTLS below is also nil),</span> <span class="comment">// DialContext and TLSClientConfig are used.</span> <span class="comment">//</span> <span class="comment">// If DialTLSContext is set, the Dial and DialContext hooks are not used for HTTPS</span> <span class="comment">// requests and the TLSClientConfig and TLSHandshakeTimeout</span> <span class="comment">// are ignored. The returned net.Conn is assumed to already be</span> <span class="comment">// past the TLS handshake.</span> DialTLSContext func(ctx <a href="/context">context</a>.<a href="/context#Context">Context</a>, network, addr <a href="/builtin#string">string</a>) (<a href="/net">net</a>.<a href="/net#Conn">Conn</a>, <a href="/builtin#error">error</a>) <span id="Transport.DialTLS" data-kind="field"> <span class="comment">// DialTLS specifies an optional dial function for creating</span> </span> <span class="comment">// TLS connections for non-proxied HTTPS requests.</span> <span class="comment">//</span> <span class="comment">// Deprecated: Use DialTLSContext instead, which allows the transport</span> <span class="comment">// to cancel dials as soon as they are no longer needed.</span> <span class="comment">// If both are set, DialTLSContext takes priority.</span> DialTLS func(network, addr <a href="/builtin#string">string</a>) (<a href="/net">net</a>.<a href="/net#Conn">Conn</a>, <a href="/builtin#error">error</a>) <span id="Transport.TLSClientConfig" data-kind="field"> <span class="comment">// TLSClientConfig specifies the TLS configuration to use with</span> </span> <span class="comment">// tls.Client.</span> <span class="comment">// If nil, the default configuration is used.</span> <span class="comment">// If non-nil, HTTP/2 support may not be enabled by default.</span> TLSClientConfig *<a href="/crypto/tls">tls</a>.<a href="/crypto/tls#Config">Config</a> <span id="Transport.TLSHandshakeTimeout" data-kind="field"> <span class="comment">// TLSHandshakeTimeout specifies the maximum amount of time to</span> </span> <span class="comment">// wait for a TLS handshake. Zero means no timeout.</span> TLSHandshakeTimeout <a href="/time">time</a>.<a href="/time#Duration">Duration</a> <span id="Transport.DisableKeepAlives" data-kind="field"> <span class="comment">// DisableKeepAlives, if true, disables HTTP keep-alives and</span> </span> <span class="comment">// will only use the connection to the server for a single</span> <span class="comment">// HTTP request.</span> <span class="comment">//</span> <span class="comment">// This is unrelated to the similarly named TCP keep-alives.</span> DisableKeepAlives <a href="/builtin#bool">bool</a> <span id="Transport.DisableCompression" data-kind="field"> <span class="comment">// DisableCompression, if true, prevents the Transport from</span> </span> <span class="comment">// requesting compression with an "Accept-Encoding: gzip"</span> <span class="comment">// request header when the Request contains no existing</span> <span class="comment">// Accept-Encoding value. If the Transport requests gzip on</span> <span class="comment">// its own and gets a gzipped response, it's transparently</span> <span class="comment">// decoded in the Response.Body. However, if the user</span> <span class="comment">// explicitly requested gzip it is not automatically</span> <span class="comment">// uncompressed.</span> DisableCompression <a href="/builtin#bool">bool</a> <span id="Transport.MaxIdleConns" data-kind="field"> <span class="comment">// MaxIdleConns controls the maximum number of idle (keep-alive)</span> </span> <span class="comment">// connections across all hosts. Zero means no limit.</span> MaxIdleConns <a href="/builtin#int">int</a> <span id="Transport.MaxIdleConnsPerHost" data-kind="field"> <span class="comment">// MaxIdleConnsPerHost, if non-zero, controls the maximum idle</span> </span> <span class="comment">// (keep-alive) connections to keep per-host. If zero,</span> <span class="comment">// DefaultMaxIdleConnsPerHost is used.</span> MaxIdleConnsPerHost <a href="/builtin#int">int</a> <span id="Transport.MaxConnsPerHost" data-kind="field"> <span class="comment">// MaxConnsPerHost optionally limits the total number of</span> </span> <span class="comment">// connections per host, including connections in the dialing,</span> <span class="comment">// active, and idle states. On limit violation, dials will block.</span> <span class="comment">//</span> <span class="comment">// Zero means no limit.</span> MaxConnsPerHost <a href="/builtin#int">int</a> <span id="Transport.IdleConnTimeout" data-kind="field"> <span class="comment">// IdleConnTimeout is the maximum amount of time an idle</span> </span> <span class="comment">// (keep-alive) connection will remain idle before closing</span> <span class="comment">// itself.</span> <span class="comment">// Zero means no limit.</span> IdleConnTimeout <a href="/time">time</a>.<a href="/time#Duration">Duration</a> <span id="Transport.ResponseHeaderTimeout" data-kind="field"> <span class="comment">// ResponseHeaderTimeout, if non-zero, specifies the amount of</span> </span> <span class="comment">// time to wait for a server's response headers after fully</span> <span class="comment">// writing the request (including its body, if any). This</span> <span class="comment">// time does not include the time to read the response body.</span> ResponseHeaderTimeout <a href="/time">time</a>.<a href="/time#Duration">Duration</a> <span id="Transport.ExpectContinueTimeout" data-kind="field"> <span class="comment">// ExpectContinueTimeout, if non-zero, specifies the amount of</span> </span> <span class="comment">// time to wait for a server's first response headers after fully</span> <span class="comment">// writing the request headers if the request has an</span> <span class="comment">// "Expect: 100-continue" header. Zero means no timeout and</span> <span class="comment">// causes the body to be sent immediately, without</span> <span class="comment">// waiting for the server to approve.</span> <span class="comment">// This time does not include the time to send the request header.</span> ExpectContinueTimeout <a href="/time">time</a>.<a href="/time#Duration">Duration</a> <span id="Transport.TLSNextProto" data-kind="field"> <span class="comment">// TLSNextProto specifies how the Transport switches to an</span> </span> <span class="comment">// alternate protocol (such as HTTP/2) after a TLS ALPN</span> <span class="comment">// protocol negotiation. If Transport dials a TLS connection</span> <span class="comment">// with a non-empty protocol name and TLSNextProto contains a</span> <span class="comment">// map entry for that key (such as "h2"), then the func is</span> <span class="comment">// called with the request's authority (such as "example.com"</span> <span class="comment">// or "example.com:1234") and the TLS connection. The function</span> <span class="comment">// must return a RoundTripper that then handles the request.</span> <span class="comment">// If TLSNextProto is not nil, HTTP/2 support is not enabled</span> <span class="comment">// automatically.</span> TLSNextProto map[<a href="/builtin#string">string</a>]func(authority <a href="/builtin#string">string</a>, c *<a href="/crypto/tls">tls</a>.<a href="/crypto/tls#Conn">Conn</a>) <a href="#RoundTripper">RoundTripper</a> <span id="Transport.ProxyConnectHeader" data-kind="field"> <span class="comment">// ProxyConnectHeader optionally specifies headers to send to</span> </span> <span class="comment">// proxies during CONNECT requests.</span> <span class="comment">// To set the header dynamically, see GetProxyConnectHeader.</span> ProxyConnectHeader <a href="#Header">Header</a> <span id="Transport.GetProxyConnectHeader" data-kind="field"> <span class="comment">// GetProxyConnectHeader optionally specifies a func to return</span> </span> <span class="comment">// headers to send to proxyURL during a CONNECT request to the</span> <span class="comment">// ip:port target.</span> <span class="comment">// If it returns an error, the Transport's RoundTrip fails with</span> <span class="comment">// that error. It can return (nil, nil) to not add headers.</span> <span class="comment">// If GetProxyConnectHeader is non-nil, ProxyConnectHeader is</span> <span class="comment">// ignored.</span> GetProxyConnectHeader func(ctx <a href="/context">context</a>.<a href="/context#Context">Context</a>, proxyURL *<a href="/net/url">url</a>.<a href="/net/url#URL">URL</a>, target <a href="/builtin#string">string</a>) (<a href="#Header">Header</a>, <a href="/builtin#error">error</a>) <span id="Transport.MaxResponseHeaderBytes" data-kind="field"> <span class="comment">// MaxResponseHeaderBytes specifies a limit on how many</span> </span> <span class="comment">// response bytes are allowed in the server's response</span> <span class="comment">// header.</span> <span class="comment">//</span> <span class="comment">// Zero means to use a default limit.</span> MaxResponseHeaderBytes <a href="/builtin#int64">int64</a> <span id="Transport.WriteBufferSize" data-kind="field"> <span class="comment">// WriteBufferSize specifies the size of the write buffer used</span> </span> <span class="comment">// when writing to the transport.</span> <span class="comment">// If zero, a default (currently 4KB) is used.</span> WriteBufferSize <a href="/builtin#int">int</a> <span id="Transport.ReadBufferSize" data-kind="field"> <span class="comment">// ReadBufferSize specifies the size of the read buffer used</span> </span> <span class="comment">// when reading from the transport.</span> <span class="comment">// If zero, a default (currently 4KB) is used.</span> ReadBufferSize <a href="/builtin#int">int</a> <span id="Transport.ForceAttemptHTTP2" data-kind="field"> <span class="comment">// ForceAttemptHTTP2 controls whether HTTP/2 is enabled when a non-zero</span> </span> <span class="comment">// Dial, DialTLS, or DialContext func or TLSClientConfig is provided.</span> <span class="comment">// By default, use of any those fields conservatively disables HTTP/2.</span> <span class="comment">// To use a custom dialer or TLS config and still attempt HTTP/2</span> <span class="comment">// upgrades, set this to true.</span> ForceAttemptHTTP2 <a href="/builtin#bool">bool</a> <span id="Transport.HTTP2" data-kind="field"> <span class="comment">// HTTP2 configures HTTP/2 connections.</span> </span> <span class="comment">//</span> <span class="comment">// This field does not yet have any effect.</span> <span class="comment">// See <a href="https://go.dev/issue/67813">https://go.dev/issue/67813</a>.</span> HTTP2 *<a href="#HTTP2Config">HTTP2Config</a> <span id="Transport.Protocols" data-kind="field"> <span class="comment">// Protocols is the set of protocols supported by the transport.</span> </span> <span class="comment">//</span> <span class="comment">// If Protocols includes UnencryptedHTTP2 and does not include HTTP1,</span> <span class="comment">// the transport will use unencrypted HTTP/2 for requests for http:// URLs.</span> <span class="comment">//</span> <span class="comment">// If Protocols is nil, the default is usually HTTP/1 only.</span> <span class="comment">// If ForceAttemptHTTP2 is true, or if TLSNextProto contains an "h2" entry,</span> <span class="comment">// the default is HTTP/1 and HTTP/2.</span> Protocols *<a href="#Protocols">Protocols</a> <span class="comment">// contains filtered or unexported fields</span> }</pre> </div> <p>Transport is an implementation of <a href="#RoundTripper">RoundTripper</a> that supports HTTP, HTTPS, and HTTP proxies (for either HTTP or HTTPS with CONNECT). </p><p>By default, Transport caches connections for future re-use. This may leave many open connections when accessing many hosts. This behavior can be managed using <a href="#Transport.CloseIdleConnections">Transport.CloseIdleConnections</a> method and the [Transport.MaxIdleConnsPerHost] and [Transport.DisableKeepAlives] fields. </p><p>Transports should be reused instead of created as needed. Transports are safe for concurrent use by multiple goroutines. </p><p>A Transport is a low-level primitive for making HTTP and HTTPS requests. For high-level functionality, such as cookies and redirects, see <a href="#Client">Client</a>. </p><p>Transport uses HTTP/1.1 for HTTP URLs and either HTTP/1.1 or HTTP/2 for HTTPS URLs, depending on whether the server supports HTTP/2, and how the Transport is configured. The <a href="#DefaultTransport">DefaultTransport</a> supports HTTP/2. To explicitly enable HTTP/2 on a transport, set [Transport.Protocols]. </p><p>Responses with status codes in the 1xx range are either handled automatically (100 expect-continue) or ignored. The one exception is HTTP status code 101 (Switching Protocols), which is considered a terminal status and returned by <a href="#Transport.RoundTrip">Transport.RoundTrip</a>. To see the ignored 1xx responses, use the httptrace trace package's ClientTrace.Got1xxResponse. </p><p>Transport only retries a request upon encountering a network error if the connection has been already been used successfully and if the request is idempotent and either has no body or has its [Request.GetBody] defined. HTTP requests are considered idempotent if they have HTTP methods GET, HEAD, OPTIONS, or TRACE; or if their <a href="#Header">Header</a> map contains an "Idempotency-Key" or "X-Idempotency-Key" entry. If the idempotency key value is a zero-length slice, the request is treated as idempotent but the header is not sent on the wire. </p> <div class="Documentation-typeMethod"> <details class="Documentation-deprecatedDetails js-deprecatedDetails"> <summary> <h4 tabindex="-1" id="Transport.CancelRequest" data-kind="method" class="Documentation-typeMethodHeader"> <span class="Documentation-deprecatedTitle"> func (*Transport) <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/transport.go;l=941">CancelRequest</a> <span class="Documentation-deprecatedTag">deprecated</span> <span class="Documentation-deprecatedBody"></span> </span> <span class="Documentation-sinceVersion"> <span class="Documentation-sinceVersionLabel">added in</span> <span class="Documentation-sinceVersionVersion">go1.1</span> </span> </h4> </summary> <div class="go-Message go-Message--warning Documentation-deprecatedItemBody"> <div class="Documentation-declaration"> <pre>func (t *<a href="#Transport">Transport</a>) CancelRequest(req *<a href="#Request">Request</a>)</pre> </div> <p>CancelRequest cancels an in-flight request by closing its connection. CancelRequest should only be called after <a href="#Transport.RoundTrip">Transport.RoundTrip</a> has returned. </p><p>Deprecated: Use <a href="#Request.WithContext">Request.WithContext</a> to create a request with a cancelable context instead. CancelRequest cannot cancel HTTP/2 requests. This may become a no-op in a future release of Go. </p> </div> </details> </div><div class="Documentation-typeMethod"> <h4 tabindex="-1" id="Transport.Clone" data-kind="method" class="Documentation-typeMethodHeader"> <span>func (*Transport) <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/transport.go;l=329">Clone</a> <a class="Documentation-idLink" href="#Transport.Clone" title="Go to Transport.Clone" aria-label="Go to Transport.Clone">¶</a></span> <span class="Documentation-sinceVersion"> <span class="Documentation-sinceVersionLabel">added in</span> <span class="Documentation-sinceVersionVersion">go1.13</span> </span> </h4> <div class="Documentation-declaration"> <pre>func (t *<a href="#Transport">Transport</a>) Clone() *<a href="#Transport">Transport</a></pre> </div> <p>Clone returns a deep copy of t's exported fields. </p> </div><div class="Documentation-typeMethod"> <h4 tabindex="-1" id="Transport.CloseIdleConnections" data-kind="method" class="Documentation-typeMethodHeader"> <span>func (*Transport) <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/transport.go;l=887">CloseIdleConnections</a> <a class="Documentation-idLink" href="#Transport.CloseIdleConnections" title="Go to Transport.CloseIdleConnections" aria-label="Go to Transport.CloseIdleConnections">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>func (t *<a href="#Transport">Transport</a>) CloseIdleConnections()</pre> </div> <p>CloseIdleConnections closes any connections which were previously connected from previous requests but are now sitting idle in a "keep-alive" state. It does not interrupt any connections currently in use. </p> </div><div class="Documentation-typeMethod"> <h4 tabindex="-1" id="Transport.RegisterProtocol" data-kind="method" class="Documentation-typeMethodHeader"> <span>func (*Transport) <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/transport.go;l=868">RegisterProtocol</a> <a class="Documentation-idLink" href="#Transport.RegisterProtocol" title="Go to Transport.RegisterProtocol" aria-label="Go to Transport.RegisterProtocol">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>func (t *<a href="#Transport">Transport</a>) RegisterProtocol(scheme <a href="/builtin#string">string</a>, rt <a href="#RoundTripper">RoundTripper</a>)</pre> </div> <p>RegisterProtocol registers a new protocol with scheme. The <a href="#Transport">Transport</a> will pass requests using the given scheme to rt. It is rt's responsibility to simulate HTTP request semantics. </p><p>RegisterProtocol can be used by other packages to provide implementations of protocol schemes like "ftp" or "file". </p><p>If rt.RoundTrip returns <a href="#ErrSkipAltProtocol">ErrSkipAltProtocol</a>, the Transport will handle the <a href="#Transport.RoundTrip">Transport.RoundTrip</a> itself for that one request, as if the protocol were not registered. </p> </div><div class="Documentation-typeMethod"> <h4 tabindex="-1" id="Transport.RoundTrip" data-kind="method" class="Documentation-typeMethodHeader"> <span>func (*Transport) <a class="Documentation-source" href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/roundtrip.go;l=29">RoundTrip</a> <a class="Documentation-idLink" href="#Transport.RoundTrip" title="Go to Transport.RoundTrip" aria-label="Go to Transport.RoundTrip">¶</a></span> <span class="Documentation-sinceVersion"> </span> </h4> <div class="Documentation-declaration"> <pre>func (t *<a href="#Transport">Transport</a>) RoundTrip(req *<a href="#Request">Request</a>) (*<a href="#Response">Response</a>, <a href="/builtin#error">error</a>)</pre> </div> <p>RoundTrip implements the <a href="#RoundTripper">RoundTripper</a> interface. </p><p>For higher-level HTTP client support (such as handling of cookies and redirects), see <a href="#Get">Get</a>, <a href="#Post">Post</a>, and the <a href="#Client">Client</a> type. </p><p>Like the RoundTripper interface, the error types returned by RoundTrip are unspecified. </p> </div> </div></section></div> </div> </div> <div class="UnitFiles js-unitFiles"> <h2 class="UnitFiles-title" id="section-sourcefiles"> <img class="go-Icon" height="24" width="24" src="/static/shared/icon/insert_drive_file_gm_grey_24dp.svg" alt=""> Source Files <a class="UnitFiles-idLink" href="#section-sourcefiles" title="Go to Source Files" aria-label="Go to Source Files">¶</a> </h2> <div class="UnitFiles-titleLink"> <a href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http" target="_blank" rel="noopener">View all Source files</a> </div> <div> <ul class="UnitFiles-fileList"><li> <a href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/client.go" target="_blank" rel="noopener" title="client.go">client.go</a> </li><li> <a href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/clone.go" target="_blank" rel="noopener" title="clone.go">clone.go</a> </li><li> <a href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/cookie.go" target="_blank" rel="noopener" title="cookie.go">cookie.go</a> </li><li> <a href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/doc.go" target="_blank" rel="noopener" title="doc.go">doc.go</a> </li><li> <a href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/filetransport.go" target="_blank" rel="noopener" title="filetransport.go">filetransport.go</a> </li><li> <a href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/fs.go" target="_blank" rel="noopener" title="fs.go">fs.go</a> </li><li> <a href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/h2_bundle.go" target="_blank" rel="noopener" title="h2_bundle.go">h2_bundle.go</a> </li><li> <a href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/h2_error.go" target="_blank" rel="noopener" title="h2_error.go">h2_error.go</a> </li><li> <a href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/header.go" target="_blank" rel="noopener" title="header.go">header.go</a> </li><li> <a href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/http.go" target="_blank" rel="noopener" title="http.go">http.go</a> </li><li> <a href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/jar.go" target="_blank" rel="noopener" title="jar.go">jar.go</a> </li><li> <a href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/mapping.go" target="_blank" rel="noopener" title="mapping.go">mapping.go</a> </li><li> <a href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/method.go" target="_blank" rel="noopener" title="method.go">method.go</a> </li><li> <a href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/pattern.go" target="_blank" rel="noopener" title="pattern.go">pattern.go</a> </li><li> <a href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/request.go" target="_blank" rel="noopener" title="request.go">request.go</a> </li><li> <a href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/response.go" target="_blank" rel="noopener" title="response.go">response.go</a> </li><li> <a href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/responsecontroller.go" target="_blank" rel="noopener" title="responsecontroller.go">responsecontroller.go</a> </li><li> <a href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/roundtrip.go" target="_blank" rel="noopener" title="roundtrip.go">roundtrip.go</a> </li><li> <a href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/routing_index.go" target="_blank" rel="noopener" title="routing_index.go">routing_index.go</a> </li><li> <a href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/routing_tree.go" target="_blank" rel="noopener" title="routing_tree.go">routing_tree.go</a> </li><li> <a href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/servemux121.go" target="_blank" rel="noopener" title="servemux121.go">servemux121.go</a> </li><li> <a href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/server.go" target="_blank" rel="noopener" title="server.go">server.go</a> </li><li> <a href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/sniff.go" target="_blank" rel="noopener" title="sniff.go">sniff.go</a> </li><li> <a href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/socks_bundle.go" target="_blank" rel="noopener" title="socks_bundle.go">socks_bundle.go</a> </li><li> <a href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/status.go" target="_blank" rel="noopener" title="status.go">status.go</a> </li><li> <a href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/transfer.go" target="_blank" rel="noopener" title="transfer.go">transfer.go</a> </li><li> <a href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/transport.go" target="_blank" rel="noopener" title="transport.go">transport.go</a> </li><li> <a href="https://cs.opensource.google/go/go/+/go1.24.2:src/net/http/transport_default_other.go" target="_blank" rel="noopener" title="transport_default_other.go">transport_default_other.go</a> </li></ul> </div> </div> <div class="UnitDirectories js-unitDirectories"> <h2 class="UnitDirectories-title" id="section-directories"> <img class="go-Icon" height="24" width="24" src="/static/shared/icon/folder_gm_grey_24dp.svg" alt=""> Directories <a class="UnitDirectories-idLink" href="#section-directories" title="Go to Directories" aria-label="Go to Directories">¶</a> </h2> <div class="UnitDirectories-toggles"> <div class="UnitDirectories-toggleButtons"> <button class="js-showInternalDirectories" data-test-id="internal-directories-toggle" data-gtmc="directories button" aria-label="Show Internal Directories"> Show internal </button> <button class="js-expandAllDirectories" data-test-id="directories-toggle" data-gtmc="directories button" aria-label="Expand All Directories"> Expand all </button> </div> </div> <table class="UnitDirectories-table UnitDirectories-table--tree js-expandableTable" data-test-id="UnitDirectories-table"> <tr class="UnitDirectories-tableHeader UnitDirectories-tableHeader--tree"> <th>Path</th> <th class="UnitDirectories-desktopSynopsis">Synopsis</th> </tr> <tr class=""> <td data-id="cgi" data-aria-owns=""> <div class="UnitDirectories-pathCell"> <div><a href="/net/http/cgi@go1.24.2">cgi</a> </div> <div class="UnitDirectories-mobileSynopsis">Package cgi implements CGI (Common Gateway Interface) as specified in RFC 3875.</div> </div> </td> <td class="UnitDirectories-desktopSynopsis">Package cgi implements CGI (Common Gateway Interface) as specified in RFC 3875.</td></tr></tr> <tr class=""> <td data-id="cookiejar" data-aria-owns=""> <div class="UnitDirectories-pathCell"> <div><a href="/net/http/cookiejar@go1.24.2">cookiejar</a> </div> <div class="UnitDirectories-mobileSynopsis">Package cookiejar implements an in-memory RFC 6265-compliant http.CookieJar.</div> </div> </td> <td class="UnitDirectories-desktopSynopsis">Package cookiejar implements an in-memory RFC 6265-compliant http.CookieJar.</td></tr></tr> <tr class=""> <td data-id="fcgi" data-aria-owns=""> <div class="UnitDirectories-pathCell"> <div><a href="/net/http/fcgi@go1.24.2">fcgi</a> </div> <div class="UnitDirectories-mobileSynopsis">Package fcgi implements the FastCGI protocol.</div> </div> </td> <td class="UnitDirectories-desktopSynopsis">Package fcgi implements the FastCGI protocol.</td></tr></tr> <tr class=""> <td data-id="httptest" data-aria-owns=""> <div class="UnitDirectories-pathCell"> <div><a href="/net/http/httptest@go1.24.2">httptest</a> </div> <div class="UnitDirectories-mobileSynopsis">Package httptest provides utilities for HTTP testing.</div> </div> </td> <td class="UnitDirectories-desktopSynopsis">Package httptest provides utilities for HTTP testing.</td></tr></tr> <tr class=""> <td data-id="httptrace" data-aria-owns=""> <div class="UnitDirectories-pathCell"> <div><a href="/net/http/httptrace@go1.24.2">httptrace</a> </div> <div class="UnitDirectories-mobileSynopsis">Package httptrace provides mechanisms to trace the events within HTTP client requests.</div> </div> </td> <td class="UnitDirectories-desktopSynopsis">Package httptrace provides mechanisms to trace the events within HTTP client requests.</td></tr></tr> <tr class=""> <td data-id="httputil" data-aria-owns=""> <div class="UnitDirectories-pathCell"> <div><a href="/net/http/httputil@go1.24.2">httputil</a> </div> <div class="UnitDirectories-mobileSynopsis">Package httputil provides HTTP utility functions, complementing the more common ones in the net/http package.</div> </div> </td> <td class="UnitDirectories-desktopSynopsis">Package httputil provides HTTP utility functions, complementing the more common ones in the net/http package.</td></tr></tr> <tr data-aria-controls="internal-ascii internal-testcert " class="UnitDirectories-internal"> <td data-id="internal" data-aria-owns="internal-ascii internal-testcert "> <div class="UnitDirectories-pathCell"> <div><button type="button" class="go-Button go-Button--inline UnitDirectories-toggleButton" aria-expanded="false" aria-label="2 more from" data-aria-controls="internal-ascii internal-testcert " data-aria-labelledby="internal-button internal" data-id="internal-button"> <img class="go-Icon" height="24" width="24" src="/static/shared/icon/arrow_right_gm_grey_24dp.svg" alt=""> </button><a href="/net/http/internal@go1.24.2">internal</a> </div> <div class="UnitDirectories-mobileSynopsis">Package internal contains HTTP internals shared by net/http and net/http/httputil.</div> </div> </td> <td class="UnitDirectories-desktopSynopsis">Package internal contains HTTP internals shared by net/http and net/http/httputil.</td></tr><tr data-id="internal-ascii" class="UnitDirectories-internal"> <td> <div class="UnitDirectories-subdirectory"> <span> <a href="/net/http/internal/ascii@go1.24.2">ascii</a> </span> <div class="UnitDirectories-mobileSynopsis"></div> </div> </td> <td class="UnitDirectories-desktopSynopsis"></td><tr data-id="internal-testcert" class="UnitDirectories-internal"> <td> <div class="UnitDirectories-subdirectory"> <span> <a href="/net/http/internal/testcert@go1.24.2">testcert</a> </span> <div class="UnitDirectories-mobileSynopsis">Package testcert contains a test-only localhost certificate.</div> </div> </td> <td class="UnitDirectories-desktopSynopsis">Package testcert contains a test-only localhost certificate.</td></tr> <tr class=""> <td data-id="pprof" data-aria-owns=""> <div class="UnitDirectories-pathCell"> <div><a href="/net/http/pprof@go1.24.2">pprof</a> </div> <div class="UnitDirectories-mobileSynopsis">Package pprof serves via its HTTP server runtime profiling data in the format expected by the pprof visualization tool.</div> </div> </td> <td class="UnitDirectories-desktopSynopsis">Package pprof serves via its HTTP server runtime profiling data in the format expected by the pprof visualization tool.</td></tr></tr> </table> </div> </div> </div> <div id="showInternal-description" hidden> Click to show internal directories. </div> <div id="hideInternal-description" hidden> Click to hide internal directories. </div> </article> <footer class="go-Main-footer"></footer> </main> <footer class="go-Footer"> <div class="go-Footer-links"> <div class="go-Footer-linkColumn"> <a href="https://go.dev/solutions" class="go-Footer-link go-Footer-link--primary" data-gtmc="footer link"> Why Go </a> <a href="https://go.dev/solutions#use-cases" class="go-Footer-link" data-gtmc="footer link"> Use Cases </a> <a href="https://go.dev/solutions#case-studies" class="go-Footer-link" data-gtmc="footer link"> Case Studies </a> </div> <div class="go-Footer-linkColumn"> <a href="https://learn.go.dev/" class="go-Footer-link go-Footer-link--primary" data-gtmc="footer link"> Get Started </a> <a href="https://play.golang.org" class="go-Footer-link" data-gtmc="footer link"> Playground </a> <a href="https://tour.golang.org" class="go-Footer-link" data-gtmc="footer link"> Tour </a> <a href="https://stackoverflow.com/questions/tagged/go?tab=Newest" class="go-Footer-link" data-gtmc="footer link"> Stack Overflow </a> <a href="https://go.dev/help" class="go-Footer-link" data-gtmc="footer link"> Help </a> </div> <div class="go-Footer-linkColumn"> <a href="https://pkg.go.dev" class="go-Footer-link go-Footer-link--primary" data-gtmc="footer link"> Packages </a> <a href="/std" class="go-Footer-link" data-gtmc="footer link"> Standard Library </a> <a href="/golang.org/x" class="go-Footer-link" data-gtmc="footer link"> Sub-repositories </a> <a href="https://pkg.go.dev/about" class="go-Footer-link" data-gtmc="footer link"> About Go Packages </a> </div> <div class="go-Footer-linkColumn"> <a href="https://go.dev/project" class="go-Footer-link go-Footer-link--primary" data-gtmc="footer link"> About </a> <a href="https://go.dev/dl/" class="go-Footer-link" data-gtmc="footer link">Download</a> <a href="https://go.dev/blog" class="go-Footer-link" data-gtmc="footer link">Blog</a> <a href="https://github.com/golang/go/issues" class="go-Footer-link" data-gtmc="footer link"> Issue Tracker </a> <a href="https://go.dev/doc/devel/release.html" class="go-Footer-link" data-gtmc="footer link"> Release Notes </a> <a href="https://blog.golang.org/go-brand" class="go-Footer-link" data-gtmc="footer link"> Brand Guidelines </a> <a href="https://go.dev/conduct" class="go-Footer-link" data-gtmc="footer link"> Code of Conduct </a> </div> <div class="go-Footer-linkColumn"> <a href="https://www.twitter.com/golang" class="go-Footer-link go-Footer-link--primary" data-gtmc="footer link"> Connect </a> <a href="https://www.twitter.com/golang" class="go-Footer-link" data-gtmc="footer link"> Twitter </a> <a href="https://github.com/golang" class="go-Footer-link" data-gtmc="footer link">GitHub</a> <a href="https://invite.slack.golangbridge.org/" class="go-Footer-link" data-gtmc="footer link"> Slack </a> <a href="https://reddit.com/r/golang" class="go-Footer-link" data-gtmc="footer link"> r/golang </a> <a href="https://www.meetup.com/pro/go" class="go-Footer-link" data-gtmc="footer link"> Meetup </a> <a href="https://golangweekly.com/" class="go-Footer-link" data-gtmc="footer link"> Golang Weekly </a> </div> </div> <div class="go-Footer-bottom"> <img class="go-Footer-gopher" width="1431" height="901" src="/static/shared/gopher/pilot-bust-1431x901.svg" alt="Gopher in flight goggles"> <ul class="go-Footer-listRow"> <li class="go-Footer-listItem"> <a href="https://go.dev/copyright" data-gtmc="footer link">Copyright</a> </li> <li class="go-Footer-listItem"> <a href="https://go.dev/tos" data-gtmc="footer link">Terms of Service</a> </li> <li class="go-Footer-listItem"> <a href="http://www.google.com/intl/en/policies/privacy/" data-gtmc="footer link" target="_blank" rel="noopener"> Privacy Policy </a> </li> <li class="go-Footer-listItem"> <a href="https://go.dev/s/pkgsite-feedback" target="_blank" rel="noopener" data-gtmc="footer link"> Report an Issue </a> </li> <li class="go-Footer-listItem"> <button class="go-Button go-Button--text go-Footer-toggleTheme js-toggleTheme" aria-label="Theme Toggle"> <img data-value="auto" class="go-Icon go-Icon--inverted" height="24" width="24" src="/static/shared/icon/brightness_6_gm_grey_24dp.svg" alt="System theme"> <img data-value="dark" class="go-Icon go-Icon--inverted" height="24" width="24" src="/static/shared/icon/brightness_2_gm_grey_24dp.svg" alt="Dark theme"> <img data-value="light" class="go-Icon go-Icon--inverted" height="24" width="24" src="/static/shared/icon/light_mode_gm_grey_24dp.svg" alt="Light theme"> <p> Theme Toggle </p> </button> </li> <li class="go-Footer-listItem"> <button class="go-Button go-Button--text go-Footer-keyboard js-openShortcuts" aria-label="Shorcuts Modal"> <img class="go-Icon go-Icon--inverted" height="24" width="24" src="/static/shared/icon/keyboard_grey_24dp.svg" alt=""> <p> Shortcuts Modal </p> </button> </li> </ul> <a class="go-Footer-googleLogo" href="https://google.com" target="_blank"rel="noopener" data-gtmc="footer link"> <img class="go-Footer-googleLogoImg" height="24" width="72" src="/static/shared/logo/google-white.svg" alt="Google logo"> </a> </div> </footer> <dialog id="jump-to-modal" class="JumpDialog go-Modal go-Modal--md js-modal"> <form method="dialog" data-gmtc="jump to form" aria-label="Jump to Identifier"> <div class="Dialog-title go-Modal-header"> <h2>Jump to</h2> <button class="go-Button go-Button--inline" type="button" data-modal-close data-gtmc="modal button" aria-label="Close" > <img class="go-Icon" height="24" width="24" src="/static/shared/icon/close_gm_grey_24dp.svg" alt="" /> </button> </div> <div class="JumpDialog-filter"> <input class="JumpDialog-input go-Input" autocomplete="off" type="text"> </div> <div class="JumpDialog-body go-Modal-body"> <div class="JumpDialog-list"></div> </div> <div class="go-Modal-actions"> <button class="go-Button" data-test-id="close-dialog">Close</button> </div> </form> </dialog> <dialog class="ShortcutsDialog go-Modal go-Modal--sm js-modal"> <form method="dialog"> <div class="go-Modal-header"> <h2>Keyboard shortcuts</h2> <button class="go-Button go-Button--inline" type="button" data-modal-close data-gtmc="modal button" aria-label="Close" > <img class="go-Icon" height="24" width="24" src="/static/shared/icon/close_gm_grey_24dp.svg" alt="" /> </button> </div> <div class="go-Modal-body"> <table> <tbody> <tr><td class="ShortcutsDialog-key"> <strong>?</strong></td><td> : This menu</td> </tr> <tr><td class="ShortcutsDialog-key"> <strong>/</strong></td><td> : Search site</td> </tr> <tr><td class="ShortcutsDialog-key"> <strong>f</strong> or <strong>F</strong></td><td> : Jump to</td> </tr> <tr> <td class="ShortcutsDialog-key"><strong>y</strong> or <strong>Y</strong></td> <td> : Canonical URL</td> </tr> </tbody> </table> </div> <div class="go-Modal-actions"> <button class="go-Button" data-test-id="close-dialog">Close</button> </div> </form> </dialog> <section class="Cookie-notice js-cookieNotice"> <div>go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. <a target=_blank href="https://policies.google.com/technologies/cookies">Learn more.</a></div> <div><button class="go-Button">Okay</button></div> </section> <script> // this will throw if the querySelector can’t find the element const gtmId = document.querySelector('.js-gtmID').dataset.gtmid; if (!gtmId) { throw new Error('Google Tag Manager ID not found'); } loadScript(`https://www.googletagmanager.com/gtm.js?id=${gtmId}`); </script> <noscript> <iframe src="https://www.googletagmanager.com/ns.html?id=GTM-W8MVQXG" height="0" width="0" style="display:none;visibility:hidden"> </iframe> </noscript> <div class="js-canonicalURLPath" data-canonical-url-path="/net/http@go1.24.2" hidden></div> <div class="js-playgroundVars" data-modulepath="std" data-version="v1.24.2" hidden></div> <script> loadScript('/static/frontend/unit/main/main.js') </script> <script> loadScript('/static/frontend/unit/unit.js') </script> </body> </html>

CINXE.COM

http package - net/http - Go Packages