| Skip to content | https://nodejs.org/api/https.html#apicontent |
|
Node.js
| https://nodejs.org/ |
| About this documentation | https://nodejs.org/api/documentation.html |
| Usage and example | https://nodejs.org/api/synopsis.html |
| Assertion testing | https://nodejs.org/api/assert.html |
| Asynchronous context tracking | https://nodejs.org/api/async_context.html |
| Async hooks | https://nodejs.org/api/async_hooks.html |
| Buffer | https://nodejs.org/api/buffer.html |
| C++ addons | https://nodejs.org/api/addons.html |
| C/C++ addons with Node-API | https://nodejs.org/api/n-api.html |
| C++ embedder API | https://nodejs.org/api/embedding.html |
| Child processes | https://nodejs.org/api/child_process.html |
| Cluster | https://nodejs.org/api/cluster.html |
| Command-line options | https://nodejs.org/api/cli.html |
| Console | https://nodejs.org/api/console.html |
| Crypto | https://nodejs.org/api/crypto.html |
| Debugger | https://nodejs.org/api/debugger.html |
| Deprecated APIs | https://nodejs.org/api/deprecations.html |
| Diagnostics Channel | https://nodejs.org/api/diagnostics_channel.html |
| DNS | https://nodejs.org/api/dns.html |
| Domain | https://nodejs.org/api/domain.html |
| Environment Variables | https://nodejs.org/api/environment_variables.html |
| Errors | https://nodejs.org/api/errors.html |
| Events | https://nodejs.org/api/events.html |
| File system | https://nodejs.org/api/fs.html |
| Globals | https://nodejs.org/api/globals.html |
| HTTP | https://nodejs.org/api/http.html |
| HTTP/2 | https://nodejs.org/api/http2.html |
| HTTPS | https://nodejs.org/api/https.html |
| Inspector | https://nodejs.org/api/inspector.html |
| Internationalization | https://nodejs.org/api/intl.html |
| Modules: CommonJS modules | https://nodejs.org/api/modules.html |
| Modules: ECMAScript modules | https://nodejs.org/api/esm.html |
| Modules: node:module API | https://nodejs.org/api/module.html |
| Modules: Packages | https://nodejs.org/api/packages.html |
| Modules: TypeScript | https://nodejs.org/api/typescript.html |
| Net | https://nodejs.org/api/net.html |
| OS | https://nodejs.org/api/os.html |
| Path | https://nodejs.org/api/path.html |
| Performance hooks | https://nodejs.org/api/perf_hooks.html |
| Permissions | https://nodejs.org/api/permissions.html |
| Process | https://nodejs.org/api/process.html |
| Punycode | https://nodejs.org/api/punycode.html |
| Query strings | https://nodejs.org/api/querystring.html |
| Readline | https://nodejs.org/api/readline.html |
| REPL | https://nodejs.org/api/repl.html |
| Report | https://nodejs.org/api/report.html |
| Single executable applications | https://nodejs.org/api/single-executable-applications.html |
| SQLite | https://nodejs.org/api/sqlite.html |
| Stream | https://nodejs.org/api/stream.html |
| String decoder | https://nodejs.org/api/string_decoder.html |
| Test runner | https://nodejs.org/api/test.html |
| Timers | https://nodejs.org/api/timers.html |
| TLS/SSL | https://nodejs.org/api/tls.html |
| Trace events | https://nodejs.org/api/tracing.html |
| TTY | https://nodejs.org/api/tty.html |
| UDP/datagram | https://nodejs.org/api/dgram.html |
| URL | https://nodejs.org/api/url.html |
| Utilities | https://nodejs.org/api/util.html |
| V8 | https://nodejs.org/api/v8.html |
| VM | https://nodejs.org/api/vm.html |
| WASI | https://nodejs.org/api/wasi.html |
| Web Crypto API | https://nodejs.org/api/webcrypto.html |
| Web Streams API | https://nodejs.org/api/webstreams.html |
| Worker threads | https://nodejs.org/api/worker_threads.html |
| Zlib | https://nodejs.org/api/zlib.html |
| Code repository and issue tracker | https://github.com/nodejs/node |
|
Table of contents
| https://nodejs.org/api/https.html#toc-picker |
| HTTPS | https://nodejs.org/api/https.html#https |
| Determining if crypto support is unavailable | https://nodejs.org/api/https.html#determining-if-crypto-support-is-unavailable |
| Class: https.Agent | https://nodejs.org/api/https.html#class-httpsagent |
| new Agent([options]) | https://nodejs.org/api/https.html#new-agentoptions |
| Event: 'keylog' | https://nodejs.org/api/https.html#event-keylog |
| Class: https.Server | https://nodejs.org/api/https.html#class-httpsserver |
| server.close([callback]) | https://nodejs.org/api/https.html#serverclosecallback |
| server[Symbol.asyncDispose]() | https://nodejs.org/api/https.html#serversymbolasyncdispose |
| server.closeAllConnections() | https://nodejs.org/api/https.html#servercloseallconnections |
| server.closeIdleConnections() | https://nodejs.org/api/https.html#servercloseidleconnections |
| server.headersTimeout | https://nodejs.org/api/https.html#serverheaderstimeout |
| server.listen() | https://nodejs.org/api/https.html#serverlisten |
| server.maxHeadersCount | https://nodejs.org/api/https.html#servermaxheaderscount |
| server.requestTimeout | https://nodejs.org/api/https.html#serverrequesttimeout |
| server.setTimeout([msecs][, callback]) | https://nodejs.org/api/https.html#serversettimeoutmsecs-callback |
| server.timeout | https://nodejs.org/api/https.html#servertimeout |
| server.keepAliveTimeout | https://nodejs.org/api/https.html#serverkeepalivetimeout |
| https.createServer([options][, requestListener]) | https://nodejs.org/api/https.html#httpscreateserveroptions-requestlistener |
| https.get(options[, callback]) | https://nodejs.org/api/https.html#httpsgetoptions-callback |
| https.get(url[, options][, callback]) | https://nodejs.org/api/https.html#httpsgeturl-options-callback |
| https.globalAgent | https://nodejs.org/api/https.html#httpsglobalagent |
| https.request(options[, callback]) | https://nodejs.org/api/https.html#httpsrequestoptions-callback |
| https.request(url[, options][, callback]) | https://nodejs.org/api/https.html#httpsrequesturl-options-callback |
|
Index
| https://nodejs.org/api/https.html#gtoc-picker |
| About this documentation | https://nodejs.org/api/documentation.html |
| Usage and example | https://nodejs.org/api/synopsis.html |
| Index | https://nodejs.org/api/index.html |
| Assertion testing | https://nodejs.org/api/assert.html |
| Asynchronous context tracking | https://nodejs.org/api/async_context.html |
| Async hooks | https://nodejs.org/api/async_hooks.html |
| Buffer | https://nodejs.org/api/buffer.html |
| C++ addons | https://nodejs.org/api/addons.html |
| C/C++ addons with Node-API | https://nodejs.org/api/n-api.html |
| C++ embedder API | https://nodejs.org/api/embedding.html |
| Child processes | https://nodejs.org/api/child_process.html |
| Cluster | https://nodejs.org/api/cluster.html |
| Command-line options | https://nodejs.org/api/cli.html |
| Console | https://nodejs.org/api/console.html |
| Crypto | https://nodejs.org/api/crypto.html |
| Debugger | https://nodejs.org/api/debugger.html |
| Deprecated APIs | https://nodejs.org/api/deprecations.html |
| Diagnostics Channel | https://nodejs.org/api/diagnostics_channel.html |
| DNS | https://nodejs.org/api/dns.html |
| Domain | https://nodejs.org/api/domain.html |
| Environment Variables | https://nodejs.org/api/environment_variables.html |
| Errors | https://nodejs.org/api/errors.html |
| Events | https://nodejs.org/api/events.html |
| File system | https://nodejs.org/api/fs.html |
| Globals | https://nodejs.org/api/globals.html |
| HTTP | https://nodejs.org/api/http.html |
| HTTP/2 | https://nodejs.org/api/http2.html |
| HTTPS | https://nodejs.org/api/https.html |
| Inspector | https://nodejs.org/api/inspector.html |
| Internationalization | https://nodejs.org/api/intl.html |
| Modules: CommonJS modules | https://nodejs.org/api/modules.html |
| Modules: ECMAScript modules | https://nodejs.org/api/esm.html |
| Modules: node:module API | https://nodejs.org/api/module.html |
| Modules: Packages | https://nodejs.org/api/packages.html |
| Modules: TypeScript | https://nodejs.org/api/typescript.html |
| Net | https://nodejs.org/api/net.html |
| OS | https://nodejs.org/api/os.html |
| Path | https://nodejs.org/api/path.html |
| Performance hooks | https://nodejs.org/api/perf_hooks.html |
| Permissions | https://nodejs.org/api/permissions.html |
| Process | https://nodejs.org/api/process.html |
| Punycode | https://nodejs.org/api/punycode.html |
| Query strings | https://nodejs.org/api/querystring.html |
| Readline | https://nodejs.org/api/readline.html |
| REPL | https://nodejs.org/api/repl.html |
| Report | https://nodejs.org/api/report.html |
| Single executable applications | https://nodejs.org/api/single-executable-applications.html |
| SQLite | https://nodejs.org/api/sqlite.html |
| Stream | https://nodejs.org/api/stream.html |
| String decoder | https://nodejs.org/api/string_decoder.html |
| Test runner | https://nodejs.org/api/test.html |
| Timers | https://nodejs.org/api/timers.html |
| TLS/SSL | https://nodejs.org/api/tls.html |
| Trace events | https://nodejs.org/api/tracing.html |
| TTY | https://nodejs.org/api/tty.html |
| UDP/datagram | https://nodejs.org/api/dgram.html |
| URL | https://nodejs.org/api/url.html |
| Utilities | https://nodejs.org/api/util.html |
| V8 | https://nodejs.org/api/v8.html |
| VM | https://nodejs.org/api/vm.html |
| WASI | https://nodejs.org/api/wasi.html |
| Web Crypto API | https://nodejs.org/api/webcrypto.html |
| Web Streams API | https://nodejs.org/api/webstreams.html |
| Worker threads | https://nodejs.org/api/worker_threads.html |
| Zlib | https://nodejs.org/api/zlib.html |
| Code repository and issue tracker | https://github.com/nodejs/node |
|
Other versions
| https://nodejs.org/api/https.html#alt-docs |
| 25.x | https://nodejs.org/docs/latest-v25.x/api/https.html |
| 24.x LTS | https://nodejs.org/docs/latest-v24.x/api/https.html |
| 23.x | https://nodejs.org/docs/latest-v23.x/api/https.html |
| 22.x LTS | https://nodejs.org/docs/latest-v22.x/api/https.html |
| 21.x | https://nodejs.org/docs/latest-v21.x/api/https.html |
| 20.x LTS | https://nodejs.org/docs/latest-v20.x/api/https.html |
| 19.x | https://nodejs.org/docs/latest-v19.x/api/https.html |
| 18.x | https://nodejs.org/docs/latest-v18.x/api/https.html |
| 17.x | https://nodejs.org/docs/latest-v17.x/api/https.html |
| 16.x | https://nodejs.org/docs/latest-v16.x/api/https.html |
| 15.x | https://nodejs.org/docs/latest-v15.x/api/https.html |
| 14.x | https://nodejs.org/docs/latest-v14.x/api/https.html |
| 13.x | https://nodejs.org/docs/latest-v13.x/api/https.html |
| 12.x | https://nodejs.org/docs/latest-v12.x/api/https.html |
| 11.x | https://nodejs.org/docs/latest-v11.x/api/https.html |
| 10.x | https://nodejs.org/docs/latest-v10.x/api/https.html |
| 9.x | https://nodejs.org/docs/latest-v9.x/api/https.html |
| 8.x | https://nodejs.org/docs/latest-v8.x/api/https.html |
| 7.x | https://nodejs.org/docs/latest-v7.x/api/https.html |
| 6.x | https://nodejs.org/docs/latest-v6.x/api/https.html |
| 5.x | https://nodejs.org/docs/latest-v5.x/api/https.html |
| 4.x | https://nodejs.org/docs/latest-v4.x/api/https.html |
| 0.12.x | https://nodejs.org/docs/latest-v0.12.x/api/https.html |
| 0.10.x | https://nodejs.org/docs/latest-v0.10.x/api/https.html |
|
Options
| https://nodejs.org/api/https.html#options-picker |
| View on single page | https://nodejs.org/api/all.html |
| View as JSON | https://nodejs.org/api/https.json |
| Edit on GitHub | https://github.com/nodejs/node/edit/main/doc/api/https.md |
| HTTPS | https://nodejs.org/api/https.html#https |
| Determining if crypto support is unavailable | https://nodejs.org/api/https.html#determining-if-crypto-support-is-unavailable |
| Class: https.Agent | https://nodejs.org/api/https.html#class-httpsagent |
| new Agent([options]) | https://nodejs.org/api/https.html#new-agentoptions |
| Event: 'keylog' | https://nodejs.org/api/https.html#event-keylog |
| Class: https.Server | https://nodejs.org/api/https.html#class-httpsserver |
| server.close([callback]) | https://nodejs.org/api/https.html#serverclosecallback |
| server[Symbol.asyncDispose]() | https://nodejs.org/api/https.html#serversymbolasyncdispose |
| server.closeAllConnections() | https://nodejs.org/api/https.html#servercloseallconnections |
| server.closeIdleConnections() | https://nodejs.org/api/https.html#servercloseidleconnections |
| server.headersTimeout | https://nodejs.org/api/https.html#serverheaderstimeout |
| server.listen() | https://nodejs.org/api/https.html#serverlisten |
| server.maxHeadersCount | https://nodejs.org/api/https.html#servermaxheaderscount |
| server.requestTimeout | https://nodejs.org/api/https.html#serverrequesttimeout |
| server.setTimeout([msecs][, callback]) | https://nodejs.org/api/https.html#serversettimeoutmsecs-callback |
| server.timeout | https://nodejs.org/api/https.html#servertimeout |
| server.keepAliveTimeout | https://nodejs.org/api/https.html#serverkeepalivetimeout |
| https.createServer([options][, requestListener]) | https://nodejs.org/api/https.html#httpscreateserveroptions-requestlistener |
| https.get(options[, callback]) | https://nodejs.org/api/https.html#httpsgetoptions-callback |
| https.get(url[, options][, callback]) | https://nodejs.org/api/https.html#httpsgeturl-options-callback |
| https.globalAgent | https://nodejs.org/api/https.html#httpsglobalagent |
| https.request(options[, callback]) | https://nodejs.org/api/https.html#httpsrequestoptions-callback |
| https.request(url[, options][, callback]) | https://nodejs.org/api/https.html#httpsrequesturl-options-callback |
| # | https://nodejs.org/api/https.html#https |
| Stability: 2 | https://nodejs.org/api/documentation.html#stability-index |
| lib/https.js | https://github.com/nodejs/node/blob/v25.2.1/lib/https.js |
| # | https://nodejs.org/api/https.html#determining-if-crypto-support-is-unavailable |
| import() | https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/import |
| # | https://nodejs.org/api/https.html#class-httpsagent |
| Agent | https://nodejs.org/api/https.html#class-httpsagent |
| http.Agent | https://nodejs.org/api/http.html#class-httpagent |
| https.request() | https://nodejs.org/api/https.html#httpsrequestoptions-callback |
| agent.createConnection() | https://nodejs.org/api/http.html#agentcreateconnectionoptions-callback |
| # | https://nodejs.org/api/https.html#new-agentoptions |
| https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object |
| http.Agent(options) | https://nodejs.org/api/http.html#new-agentoptions |
| https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#number_type |
| https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#string_type |
| Server Name Indication extension | https://en.wikipedia.org/wiki/Server_Name_Indication |
| Session Resumption | https://nodejs.org/api/tls.html#session-resumption |
| # | https://nodejs.org/api/https.html#event-keylog |
| https://nodejs.org/api/buffer.html#class-buffer |
| https://nodejs.org/api/tls.html#class-tlstlssocket |
| # | https://nodejs.org/api/https.html#class-httpsserver |
| https://nodejs.org/api/tls.html#class-tlsserver |
| http.Server | https://nodejs.org/api/http.html#class-httpserver |
| # | https://nodejs.org/api/https.html#serverclosecallback |
| https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function |
| https://nodejs.org/api/https.html#class-httpsserver |
| server.close() | https://nodejs.org/api/http.html#serverclosecallback |
| # | https://nodejs.org/api/https.html#serversymbolasyncdispose |
| server.close() | https://nodejs.org/api/https.html#serverclosecallback |
| # | https://nodejs.org/api/https.html#servercloseallconnections |
| server.closeAllConnections() | https://nodejs.org/api/http.html#servercloseallconnections |
| # | https://nodejs.org/api/https.html#servercloseidleconnections |
| server.closeIdleConnections() | https://nodejs.org/api/http.html#servercloseidleconnections |
| # | https://nodejs.org/api/https.html#serverheaderstimeout |
| https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#number_type |
| server.headersTimeout | https://nodejs.org/api/http.html#serverheaderstimeout |
| # | https://nodejs.org/api/https.html#serverlisten |
| server.listen() | https://nodejs.org/api/net.html#serverlisten |
| net.Server | https://nodejs.org/api/net.html#class-netserver |
| # | https://nodejs.org/api/https.html#servermaxheaderscount |
| https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#number_type |
| server.maxHeadersCount | https://nodejs.org/api/http.html#servermaxheaderscount |
| # | https://nodejs.org/api/https.html#serverrequesttimeout |
| https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#number_type |
| server.requestTimeout | https://nodejs.org/api/http.html#serverrequesttimeout |
| # | https://nodejs.org/api/https.html#serversettimeoutmsecs-callback |
| https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#number_type |
| https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function |
| https://nodejs.org/api/https.html#class-httpsserver |
| server.setTimeout() | https://nodejs.org/api/http.html#serversettimeoutmsecs-callback |
| # | https://nodejs.org/api/https.html#servertimeout |
| https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#number_type |
| server.timeout | https://nodejs.org/api/http.html#servertimeout |
| # | https://nodejs.org/api/https.html#serverkeepalivetimeout |
| https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#number_type |
| server.keepAliveTimeout | https://nodejs.org/api/http.html#serverkeepalivetimeout |
| # | https://nodejs.org/api/https.html#httpscreateserveroptions-requestlistener |
| https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object |
| tls.createServer() | https://nodejs.org/api/tls.html#tlscreateserveroptions-secureconnectionlistener |
| tls.createSecureContext() | https://nodejs.org/api/tls.html#tlscreatesecurecontextoptions |
| http.createServer() | https://nodejs.org/api/http.html#httpcreateserveroptions-requestlistener |
| https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function |
| https://nodejs.org/api/https.html#class-httpsserver |
| # | https://nodejs.org/api/https.html#httpsgetoptions-callback |
| # | https://nodejs.org/api/https.html#httpsgeturl-options-callback |
| https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#string_type |
| https://nodejs.org/api/url.html#the-whatwg-url-api |
| https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object |
| https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#string_type |
| https://nodejs.org/api/url.html#the-whatwg-url-api |
| https.request() | https://nodejs.org/api/https.html#httpsrequestoptions-callback |
| https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function |
| https://nodejs.org/api/http.html#class-httpclientrequest |
| http.get() | https://nodejs.org/api/http.html#httpgetoptions-callback |
| URL | https://nodejs.org/api/url.html#the-whatwg-url-api |
| new URL() | https://nodejs.org/api/url.html#new-urlinput-base |
| URL | https://nodejs.org/api/url.html#the-whatwg-url-api |
| # | https://nodejs.org/api/https.html#httpsglobalagent |
| https.Agent | https://nodejs.org/api/https.html#class-httpsagent |
| https.Agent | https://nodejs.org/api/https.html#class-httpsagent |
| # | https://nodejs.org/api/https.html#httpsrequestoptions-callback |
| # | https://nodejs.org/api/https.html#httpsrequesturl-options-callback |
| https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#string_type |
| https://nodejs.org/api/url.html#the-whatwg-url-api |
| https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object |
| https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#string_type |
| https://nodejs.org/api/url.html#the-whatwg-url-api |
| http.request() | https://nodejs.org/api/http.html#httprequestoptions-callback |
| https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function |
| https://nodejs.org/api/http.html#class-httpclientrequest |
| tls.connect() | https://nodejs.org/api/tls.html#tlsconnectoptions-callback |
| URL | https://nodejs.org/api/url.html#the-whatwg-url-api |
| new URL() | https://nodejs.org/api/url.html#new-urlinput-base |
| URL | https://nodejs.org/api/url.html#the-whatwg-url-api |
| http.ClientRequest | https://nodejs.org/api/http.html#class-httpclientrequest |
| tls.connect() | https://nodejs.org/api/tls.html#tlsconnectoptions-callback |
| Agent | https://nodejs.org/api/https.html#class-httpsagent |
| URL | https://nodejs.org/api/url.html#the-whatwg-url-api |