Curl
Curl
NAME
curl - transfer a URL
SYNOPSIS
curl [options / URLs]
DESCRIPTION
curl is a tool for transferring data from or to a server using URLs. It supports these protocols: DICT, FILE,
FTP, FTPS, GOPHER, GOPHERS, HTTP, HTTPS, IMAP, IMAPS, LDAP, LDAPS, MQTT, POP3, POP3S,
RTMP, RTMPS, RTSP, SCP, SFTP, SMB, SMBS, SMTP, SMTPS, TELNET, TFTP, WS and WSS.
curl is powered by libcurl for all transfer-related features. See libcurl(3) for details.
URL
The URL syntax is protocol-dependent. You find a detailed description in RFC 3986.
If you provide a URL without a leading protocol:// scheme, curl guesses what protocol you want. It then
defaults to HTTP but assumes others based on often-used hostname prefixes. For example, for hostnames
starting with "ftp." curl assumes you want FTP.
You can specify any amount of URLs on the command line. They are fetched in a sequential manner in the
specified order unless you use -Z, --parallel. You can specify command line options and URLs mixed
and in any order on the command line.
curl attempts to reuse connections when doing multiple transfers, so that getting many files from the same
server do not use multiple connects and setup handshakes. This improves speed. Connection reuse can only
be done for URLs specified for a single command line invocation and cannot be performed between sepa-
rate curl runs.
Provide an IPv6 zone id in the URL with an escaped percentage sign. Like in
"http://[fe80::3%25eth0]/"
Everything provided on the command line that is not a command line option or its argument, curl assumes
is a URL and treats it as such.
GLOBBING
You can specify multiple URLs or parts of URLs by writing lists within braces or ranges within brackets.
We call this "globbing".
"http://site.{one,two,three}.com"
"ftp://ftp.example.com/file[1-100].txt"
"ftp://ftp.example.com/file[001-100].txt"
"ftp://ftp.example.com/file[a-z].txt"
Nested sequences are not supported, but you can use several ones next to each other:
"http://example.com/archive[1996-1999]/vol[1-4]/part{a,b,c}.html"
You can specify a step counter for the ranges to get every Nth number or letter:
"http://example.com/file[1-100:10].txt"
"http://example.com/file[a-z:2].txt"
When using [] or {} sequences when invoked from a command line prompt, you probably have to put the
full URL within double quotes to avoid the shell from interfering with it. This also goes for other characters
treated special, like for example '&', '?' and '*'.
Variable contents can be expanded in option parameters using "{{name}}" if the option name is prefixed
with "--expand-". This gets the contents of the variable "name" inserted, or a blank if the name does not
exist as a variable. Insert "{{" verbatim in the string by prefixing it with a backslash, like "\{{".
You access and expand environment variables by first importing them. You select to either require the envi-
ronment variable to be set or you can provide a default value in case it is not already set. Plain "--variable
%name" imports the variable called "name" but exits with an error if that environment variable is not al-
ready set. To provide a default value if it is not set, use "--variable %name=content" or "--variable
%name@content".
Example. Get the USER environment variable into the URL, fail if USER is not set:
--variable '%USER'
--expand-url = "https://example.com/api/{{USER}}/method"
When expanding variables, curl supports a set of functions that can make the variable contents more conve-
nient to use. It can trim leading and trailing white space with "trim", it can output the contents as a JSON
quoted string with "json", URL encode the string with "url", base64 encode it with "b64" and base64 de-
code it with "64dec". To apply functions to a variable expansion, add them colon separated to the right side
of the variable. Variable content holding null bytes that are not encoded when expanded causes an error.
Example: get the contents of a file called $HOME/.secret into a variable called "fix". Make sure that the
content is trimmed and percent-encoded when sent as POST data:
--variable %HOME
--expand-variable fix@{{HOME}}/.secret
--expand-data "{{fix:trim:url}}"
https://example.com/
curl does not parse or otherwise "understand" the content it gets or writes as output. It does no encoding or
decoding, unless explicitly asked to with dedicated command line options.
PROTOCOLS
curl supports numerous protocols, or put in URL terms: schemes. Your particular build may not support
them all.
DICT Lets you lookup words using online dictionaries.
FILE Read or write local files. curl does not support accessing file:// URL remotely, but when running
on Microsoft Windows using the native UNC approach works.
FTP(S) curl supports the File Transfer Protocol with a lot of tweaks and levers. With or without using
TLS.
GOPHER(S)
Retrieve files.
HTTP(S)
curl supports HTTP with numerous options and variations. It can speak HTTP version 0.9, 1.0,
1.1, 2 and 3 depending on build options and the correct command line options.
IMAP(S)
Using the mail reading protocol, curl can download emails for you. With or without using TLS.
LDAP(S)
curl can do directory lookups for you, with or without TLS.
MQTT curl supports MQTT version 3. Downloading over MQTT equals subscribing to a topic while up-
loading/posting equals publishing on a topic. MQTT over TLS is not supported (yet).
POP3(S)
Downloading from a pop3 server means getting an email. With or without using TLS.
RTMP(S)
The Realtime Messaging Protocol is primarily used to serve streaming media and curl can down-
load it.
RTSP curl supports RTSP 1.0 downloads.
SCP curl supports SSH version 2 scp transfers.
SFTP curl supports SFTP (draft 5) done over SSH version 2.
SMB(S)
curl supports SMB version 1 for upload and download.
SMTP(S)
Uploading contents to an SMTP server means sending an email. With or without TLS.
TELNET
Fetching a telnet URL starts an interactive session where it sends what it reads on stdin and out-
puts what the server sends it.
TFTP curl can do TFTP downloads and uploads.
WS(S) WebSocket done over HTTP/1. WSS implies that it works over HTTPS.
PROGRESS METER
curl normally displays a progress meter during operations, indicating the amount of transferred data, trans-
fer speeds and estimated time left, etc. The progress meter displays the transfer rate in bytes per second.
The suffixes (k, M, G, T, P) are 1024 based. For example 1k is 1024 bytes. 1M is 1048576 bytes.
curl displays this data to the terminal by default, so if you invoke curl to do an operation and it is about to
write data to the terminal, it disables the progress meter as otherwise it would mess up the output mixing
progress meter and response data.
If you want a progress meter for HTTP POST or PUT requests, you need to redirect the response output to
a file, using shell redirect (>), -o, --output or similar.
This does not apply to FTP upload as that operation does not spit out any response data to the terminal.
If you prefer a progress bar instead of the regular meter, -#, --progress-bar is your friend. You can also
disable the progress meter completely with the -s, --silent option.
VERSION
This man page describes curl 8.14.1. If you use a later version, chances are this man page does not fully
document it. If you use an earlier version, this document tries to include version information about which
specific version that introduced changes.
You can always learn which the latest curl version is by running
curl https://curl.se/info
The online version of this man page is always showing the latest incarnation: https://curl.se/docs/man-
page.html
OPTIONS
Options start with one or two dashes. Many of the options require an additional value next to them. If pro-
vided text does not start with a dash, it is presumed to be and treated as a URL.
The short "single-dash" form of the options, -d for example, may be used with or without a space between
it and its value, although a space is a recommended separator. The long double-dash form, -d, --data for
example, requires a space between it and its value.
Short version options that do not need any additional values can be used immediately next to each other,
like for example you can specify all the options -O, -L and -v at once as -OLv.
In general, all boolean options are enabled with --option and yet again disabled with --no-option. That is,
you use the same option name but prefix it with "no-". However, in this list we mostly only list and show
the --option version of them.
When -:, --next is used, it resets the parser state and you start again with a clean option state, except for
the options that are global. Global options retain their values and meaning even after -:, --next.
The first argument that is exactly two dashes ("--"), marks the end of options; any argument after the end of
options is interpreted as a URL argument even if it starts with a dash.
The following options are global: --fail-early, --libcurl, --parallel-immediate, --parallel-max, -Z,
--parallel, -#, --progress-bar, --rate, -S, --show-error, --stderr, --styled-output,
--trace-ascii, --trace-config, --trace-ids, --trace-time, --trace and -v, --verbose.
ALL OPTIONS
--abstract-unix-socket <path>
(HTTP) Connect through an abstract Unix domain socket, instead of using the network. Note: net-
stat shows the path of an abstract socket prefixed with "@", however the <path> argument should
not have this leading character.
Example:
curl --abstract-unix-socket socketpath https://example.com
--alt-svc <filename>
(HTTPS) Enable the alt-svc parser. If the filename points to an existing alt-svc cache file, that
gets used. After a completed transfer, the cache is saved to the filename again if it has been modi-
fied.
Specify a "" filename (zero length) to avoid loading/saving and make curl just handle the cache in
memory.
If this option is used several times, curl loads contents from all the files but the last one is used for
saving.
Example:
curl --alt-svc svc.txt https://example.com
Using --anyauth is not recommended if you do uploads from stdin, since it may require data to
be sent twice and then the client must be able to rewind. If the need should arise when uploading
from stdin, the upload operation fails.
Example:
curl --anyauth --user me:pwd https://example.com
Providing --append multiple times has no extra effect. Disable it again with --no-append.
Example:
curl --upload-file local --append ftp://example.com/
The provider argument is a string that is used by the algorithm when creating outgoing authentica-
tion headers.
The region argument is a string that points to a geographic area of a resources collection
The service argument is a string that points to a function provided by a cloud (service-code) when
the service name is omitted from the endpoint.
Example:
curl --aws-sigv4 "aws:amz:us-east-2:es" --user "key:secret" https://example.com
Example:
curl -u name:password --basic https://example.com
This option is independent of other CA certificate locations set at run time or build time. Those lo-
cations are searched in addition to the native CA store.
This option works with OpenSSL and its forks (LibreSSL, BoringSSL, etc) on Windows. (Added
in 7.71.0)
This option works with wolfSSL on Windows, Linux (Debian, Ubuntu, Gentoo, Fedora, RHEL),
macOS, Android and iOS. (Added in 8.3.0)
This option works with rustls on Windows, macOS, Android and iOS. On Linux it is equivalent to
using the Mozilla CA certificate bundle. When used with rustls _only_ the native CA store is con-
sulted, not other locations set at run time or build time. (Added in 8.13.0)
This option currently has no effect for Schannel or Secure Transport. Those are native TLS li-
braries from Microsoft and Apple, respectively, that by default use the native CA store for verifica-
tion unless overridden by a CA certificate location setting.
Providing --ca-native multiple times has no extra effect. Disable it again with --no-ca-native.
Example:
curl --ca-native https://example.com
Added in 8.2.0. See also --cacert, --capath, --dump-ca-embed, -k, --insecure and
--proxy-ca-native.
--cacert <file>
(TLS) Use the specified certificate file to verify the peer. The file may contain multiple CA certifi-
cates. The certificate(s) must be in PEM format. Normally curl is built to use a default file for this,
so this option is typically used to alter that default file.
curl recognizes the environment variable named 'CURL_CA_BUNDLE' if it is set and the TLS
backend is not Schannel, and uses the given path as a path to a CA cert bundle. This option over-
rides that variable.
(Windows) curl automatically looks for a CA certs file named 'curl-ca-bundle.crt', either in the
same directory as curl.exe, or in the Current Working Directory, or in any folder along your PATH.
curl 8.11.0 added a build-time option to disable this search behavior, and another option to restrict
search to the application's directory.
(iOS and macOS only) If curl is built against Secure Transport, then this option is supported for
backward compatibility with other SSL engines, but it should not be set. If the option is not set,
then curl uses the certificates in the system and user Keychain to verify the peer, which is the pre-
ferred method of verifying the peer's certificate chain.
(Schannel only) This option is supported for Schannel in Windows 7 or later (added in 7.60.0).
This option is supported for backward compatibility with other SSL engines; instead it is recom-
mended to use Windows' store of root certificates (the default for Schannel).
Example:
curl --cacert CA-file.txt https://example.com
Example:
curl --capath /local/directory https://example.com
In the <certificate> portion of the argument, you must escape the character ":" as "\:" so that it is
not recognized as the password delimiter. Similarly, you must escape the double quote character as
\" so that it is not recognized as an escape character.
If curl is built against OpenSSL, and the engine pkcs11 or pkcs11 provider is available, then a
PKCS#11 URI (RFC 7512) can be used to specify a certificate located in a PKCS#11 device. A
string beginning with "pkcs11:" is interpreted as a PKCS#11 URI. If a PKCS#11 URI is provided,
then the --engine option is set as "pkcs11" if none was provided and the --cert-type option is
set as "ENG" or "PROV" if none was provided (depending on OpenSSL version).
If curl is built against GnuTLS, a PKCS#11 URI can be used to specify a certificate located in a
PKCS#11 device. A string beginning with "pkcs11:" is interpreted as a PKCS#11 URI.
(iOS and macOS only) If curl is built against Secure Transport, then the certificate string can either
be the name of a certificate/private key in the system or user keychain, or the path to a
PKCS#12-encoded certificate and private key. If you want to use a file from the current directory,
please precede it with "./" prefix, in order to avoid confusion with a nickname.
(Schannel only) Client certificates must be specified by a path expression to a certificate store.
(Loading PFX is not supported; you can import it to a store first). You can use "<store loca-
tion>\<store name>\<thumbprint>" to refer to a certificate in the system certificates store, for ex-
ample, "CurrentUser\MY\934a7ac6f8a5d579285a74fa61e19f23ddfe8d7a". Thumbprint is usually
a SHA-1 hex string which you can see in certificate details. Following store locations are sup-
ported: CurrentUser, LocalMachine, CurrentService, Services, CurrentUserGroupPolicy, Local-
MachineGroupPolicy and LocalMachineEnterprise.
Example:
curl --cert certfile --key keyfile https://example.com
If this option is enabled and the server sends an invalid (e.g. expired) response, if the response sug-
gests that the server certificate has been revoked, or no response at all is received, the verification
fails.
This support is currently only implemented in the OpenSSL and GnuTLS backends.
Providing --cert-status multiple times has no extra effect. Disable it again with --no-cert-status.
Example:
curl --cert-status https://example.com
The default type depends on the TLS backend and is usually PEM, however for Secure Transport
and Schannel it is P12. If -E, --cert is a pkcs11: URI then ENG or PROV is the default type (de-
pending on OpenSSL version).
Example:
curl --cert-type PEM --cert file https://example.com
https://curl.se/docs/ssl-ciphers.html
Example:
curl --ciphers ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256 https://example
Response headers are not modified when saved, so if they are "interpreted" separately again at a
later point they might appear to be saying that the content is (still) compressed; while in fact it has
already been decompressed.
If this option is used and the server sends an unsupported encoding, curl reports an error. This is a
request, not an order; the server may or may not deliver data compressed.
Providing --compressed multiple times has no extra effect. Disable it again with --no-com-
pressed.
Example:
curl --compressed https://example.com
Providing --compressed-ssh multiple times has no extra effect. Disable it again with --no-com-
pressed-ssh.
Example:
curl --compressed-ssh sftp://example.com/
Options and their parameters must be specified on the same line in the file, separated by white-
space, colon, or the equals sign. Long option names can optionally be given in the config file
without the initial double dashes and if so, the colon or equals characters can be used as separa-
tors. If the option is specified with one or two dashes, there can be no colon or equals character be-
tween the option and its parameter.
If the parameter contains whitespace or starts with a colon (:) or equals sign (=), it must be speci-
fied enclosed within double quotes ("like this"). Within double quotes the following escape se-
quences are available: \\, \", \t, \n, \r and \v. A backslash preceding any other letter is ignored.
If the first non-blank column of a config line is a '#' character, that line is treated as a comment.
Only write one option per physical line in the config file. A single line is required to be no more
than 10 megabytes (since 8.2.0).
Specify the filename to -K, --config as minus "-" to make curl read the file from stdin.
Note that to be able to specify a URL in the config file, you need to specify it using the --url op-
tion, and not by simply writing the URL on its own line. So, it could look similar to this:
url = "https://curl.se/docs/"
When curl is invoked, it (unless -q, --disable is used) checks for a default config file and uses it
if found, even when -K, --config is used. The default config file is checked for in the following
places in this order:
1) "$CURL_HOME/.curlrc"
3) "$HOME/.curlrc"
4) Windows: "%USERPROFILE%\.curlrc"
5) Windows: "%APPDATA%\.curlrc"
8) On Windows, if it finds no .curlrc file in the sequence described above, it checks for one in the
same directory the curl executable is placed.
On Windows two filenames are checked per location: .curlrc and _curlrc, preferring the former.
Example:
curl --config file.txt https://example.com
This option accepts decimal values. The decimal value needs to be provided using a dot (.) as deci-
mal separator - not the local version even if it might be using another separator.
The connection phase is considered complete when the DNS lookup and requested TCP, TLS or
QUIC handshakes are done.
Examples:
curl --connect-timeout 20 https://example.com
curl --connect-timeout 3.14 https://example.com
"HOST1" and "PORT1" may be empty strings, meaning any host or any port number. "HOST2"
and "PORT2" may also be empty strings, meaning use the request's original hostname and port
number.
A hostname specified to this option is compared as a string, so it needs to match the name used in
the request URL. It can be either numerical such as "127.0.0.1" or the full host name such as "ex-
ample.org".
Example: redirect connects from the example.com hostname to 127.0.0.1 independently of port
number:
Example: redirect connects from all hostnames to 127.0.0.1 independently of port number:
Example:
curl --connect-to example.com:443:example.net:8443 https://example.com
Use "-C -" to instruct curl to automatically find out where/how to resume the transfer. It then uses
the given output/input files to figure that out.
When using this option for HTTP uploads using POST or PUT, functionality is not guaranteed.
The HTTP protocol has no standard interoperable resume upload and curl uses a set of headers for
this purpose that once proved working for some servers and have been left for those who find that
useful.
This command line option is mutually exclusive with -r, --range: you can only use one of them
for a single transfer.
The --no-clobber and --remove-on-error options cannot be used together with -C, --con-
tinue-at.
Examples:
curl -C - https://example.com
curl -C 400 https://example.com
Either: pass the exact data to send to the HTTP server in the Cookie header. It is supposedly data
previously received from the server in a "Set-Cookie:" line. The data should be in the format
"NAME1=VALUE1; NAME2=VALUE2". When given a set of specific cookies, curl populates its
cookie header with this content explicitly in all outgoing request(s). If multiple requests are done
due to authentication, followed redirects or similar, they all get this cookie header passed on.
Or: If no "=" symbol is used in the argument, it is instead treated as a filename to read previously
stored cookie from. This option also activates the cookie engine which makes curl record incom-
ing cookies, which may be handy if you are using this in combination with the -L, --location op-
tion or do multiple URL transfers on the same invoke.
If the filename is a single minus ("-"), curl reads the contents from stdin. If the filename is an
empty string ("") and is the only cookie input, curl activates the cookie engine without any cook-
ies.
The file format of the file to read cookies from should be plain HTTP headers (Set-Cookie style)
or the Netscape/Mozilla cookie file format.
The file specified with -b, --cookie is only used as input. No cookies are written to that file. To
store cookies, use the -c, --cookie-jar option.
If you use the Set-Cookie file format and do not specify a domain then the cookie is not sent since
the domain never matches. To address this, set a domain in Set-Cookie line (doing that includes
subdomains) or preferably: use the Netscape format.
Users often want to both read cookies from a file and write updated cookies back to a file, so using
both -b, --cookie and -c, --cookie-jar in the same command line is common.
If curl is built with PSL (Public Suffix List) support, it detects and discards cookies that are speci-
fied for such suffix domains that should not be allowed to have cookies. If curl is not built with
PSL support, it has no ability to stop super cookies.
Examples:
curl -b "" https://example.com
curl -b cookiefile https://example.com
curl -b cookiefile -c cookiefile https://example.com
curl -b name=Jane https://example.com
The file specified with -c, --cookie-jar is only used for output. No cookies are read from the
file. To read cookies, use the -b, --cookie option. Both options can specify the same file.
This command line option activates the cookie engine that makes curl record and use cookies. The
-b, --cookie option also activates it.
If the cookie jar cannot be created or written to, the whole curl operation does not fail or even re-
port an error clearly. Using -v, --verbose gets a warning displayed, but that is the only visible
feedback you get about this possibly lethal situation.
Examples:
curl -c store-here.txt https://example.com
curl -c store-here.txt -b read-these https://example.com
Created directories are made with mode 0750 on Unix-style file systems.
Providing --create-dirs multiple times has no extra effect. Disable it again with --no-create-dirs.
Example:
curl --create-dirs --output local/dir/file https://example.com
Example:
curl --create-file-mode 0777 -T localfile sftp://example.com/new
Providing --crlf multiple times has no extra effect. Disable it again with --no-crlf.
Example:
curl --crlf -T file ftp://example.com/
Example:
curl --crlfile rejects.txt https://example.com
--curves allows a OpenSSL powered curl to make SSL-connections with exactly the (EC) curve
requested by the client, avoiding nontransparent client/server negotiations.
If this option is set, the default curves list built into OpenSSL are ignored.
Example:
curl --curves X25519 https://example.com
option makes curl pass the data to the server using the content-type application/x-www-form-ur-
lencoded. Compared to -F, --form.
--data-raw is almost the same but does not have a special interpretation of the @ character. To
post data purely binary, you should instead use the --data-binary option. To URL-encode the
value of a form field you may use --data-urlencode.
If any of these options is used more than once on the same command line, the data pieces specified
are merged with a separating &-symbol. Thus, using '-d name=daniel -d skill=lousy' would gen-
erate a post chunk that looks like 'name=daniel&skill=lousy'.
If you start the data with the letter @, the rest should be a filename to read the data from, or - if
you want curl to read the data from stdin. Posting data from a file named 'foobar' would thus be
done with -d, --data @foobar. When -d, --data is told to read from a file like that, carriage re-
turns, newlines and null bytes are stripped out. If you do not want the @ character to have a spe-
cial interpretation use --data-raw instead.
The data for this option is passed on to the server exactly as provided on the command line. curl
does not convert, change or improve it. It is up to the user to provide the data in the correct form.
Examples:
curl -d "name=curl" https://example.com
curl -d "name=curl" -d "tool=cmdline" https://example.com
curl -d @filename https://example.com
This option is mutually exclusive with -F, --form, -I, --head and -T, --upload-file. See also
--data-binary, --data-urlencode and --data-raw.
--data-ascii <data>
(HTTP) This option is just an alias for -d, --data.
Example:
curl --data-ascii @file https://example.com
If you start the data with the letter @, the rest should be a filename. "@-" makes curl read the
data from stdin. Data is posted in a similar manner as -d, --data does, except that newlines and
carriage returns are preserved and conversions are never done.
Like -d, --data the default content-type sent to the server is application/x-www-form-urlen-
coded. If you want the data to be treated as arbitrary binary data by the server then set the con-
tent-type to octet-stream: -H "Content-Type: application/octet-stream".
If this option is used several times, the ones following the first append data as described in -d,
--data.
Example:
curl --data-binary @filename https://example.com
Examples:
curl --data-raw "hello" https://example.com
curl --data-raw "@at@at@" https://example.com
To be CGI-compliant, the <data> part should begin with a name followed by a separator and a
content specification. The <data> part can be passed to curl using one of the following syntaxes:
content URL-encode the content and pass that on. Just be careful so that the content does not
contain any "=" or "@" symbols, as that makes the syntax match one of the other cases
below.
=content
URL-encode the content and pass that on. The preceding "=" symbol is not included in
the data.
name=content
URL-encode the content part and pass that on. Note that the name part is expected to be
URL-encoded already.
@filename
load data from the given file (including any newlines), URL-encode that data and pass it
on in the POST. Using "@-" makes curl read the data from stdin.
name@filename
load data from the given file (including any newlines), URL-encode that data and pass it
on in the POST. The name part gets an equal sign appended, resulting in name=urlen-
coded-file-content. Note that the name is expected to be URL-encoded already.
--data-urlencode can be used several times in a command line
Examples:
curl --data-urlencode name=val https://example.com
curl --data-urlencode =encodethis https://example.com
curl --data-urlencode name@file https://example.com
curl --data-urlencode @fileonly https://example.com
Example:
curl --delegation "none" https://example.com
Providing --digest multiple times has no extra effect. Disable it again with --no-digest.
Example:
curl -u name:password --digest https://example.com
This option is mutually exclusive with --basic, --ntlm and --negotiate. See also -u, --user,
--proxy-digest and --anyauth.
-q, --disable
If used as the first parameter on the command line, the curlrc config file is not read or used. See
the -K, --config for details on the default config file search path.
Providing --disable multiple times has no extra effect. Disable it again with --no-disable.
Example:
curl -q https://example.com
--eprt can be used to explicitly enable EPRT again and --no-eprt is an alias for --dis-
able-eprt.
If the server is accessed using IPv6, this option has no effect as EPRT is necessary then.
Disabling EPRT only changes the active behavior. If you want to switch to passive mode you need
to not use -P, --ftp-port or force it with --ftp-pasv.
Providing --disable-eprt multiple times has no extra effect. Disable it again with --no-disable-
eprt.
Example:
curl --disable-eprt ftp://example.com/
--epsv can be used to explicitly enable EPSV again and --no-epsv is an alias for --dis-
able-epsv.
If the server is an IPv6 host, this option has no effect as EPSV is necessary then.
Disabling EPSV only changes the passive behavior. If you want to switch to active mode you need
to use -P, --ftp-port.
Providing --disable-epsv multiple times has no extra effect. Disable it again with --no-disable-
epsv.
Example:
curl --disable-epsv ftp://example.com/
Providing --disallow-username-in-url multiple times has no extra effect. Disable it again with
--no-disallow-username-in-url.
Example:
curl --disallow-username-in-url https://example.com
Example:
curl --dns-interface eth0 https://example.com
--dns-interface requires that libcurl is built to support c-ares. See also --dns-ipv4-addr and
--dns-ipv6-addr.
--dns-ipv4-addr <address>
(DNS) Bind to a specific IP address when making IPv4 DNS requests, so that the DNS requests
originate from this address. The argument should be a single IPv4 address.
Example:
curl --dns-ipv4-addr 10.1.2.3 https://example.com
--dns-ipv4-addr requires that libcurl is built to support c-ares. See also --dns-interface and
--dns-ipv6-addr.
--dns-ipv6-addr <address>
(DNS) Bind to a specific IP address when making IPv6 DNS requests, so that the DNS requests
originate from this address. The argument should be a single IPv6 address.
Example:
curl --dns-ipv6-addr 2a04:4e42::561 https://example.com
--dns-ipv6-addr requires that libcurl is built to support c-ares. See also --dns-interface and
--dns-ipv4-addr.
--dns-servers <addresses>
(DNS) Set the list of DNS servers to be used instead of the system default. The list of IP addresses
should be separated with commas. Port numbers may also optionally be given, appended to the IP
address separated with a colon.
Examples:
curl --dns-servers 192.168.0.1,192.168.0.2 https://example.com
curl --dns-servers 10.0.0.1:53 https://example.com
--dns-servers requires that libcurl is built to support c-ares. See also --dns-interface and
--dns-ipv4-addr.
--doh-cert-status
Same as --cert-status but used for DoH (DNS-over-HTTPS).
Verify the status of the DoH servers' certificate by using the Certificate Status Request (aka. OCSP
stapling) TLS extension.
If this option is enabled and the DoH server sends an invalid (e.g. expired) response, if the re-
sponse suggests that the server certificate has been revoked, or no response at all is received, the
verification fails.
This support is currently only implemented in the OpenSSL and GnuTLS backends.
Providing --doh-cert-status multiple times has no extra effect. Disable it again with --no-doh-
cert-status.
Example:
curl --doh-cert-status --doh-url https://doh.example https://example.com
WARNING: using this option makes the DoH transfer and name resolution insecure.
This option is equivalent to -k, --insecure and --proxy-insecure but used for DoH
(DNS-over-HTTPS) only.
Providing --doh-insecure multiple times has no extra effect. Disable it again with --no-doh-inse-
cure.
Example:
curl --doh-insecure --doh-url https://doh.example https://example.com
Some SSL options that you set for your transfer also apply to DoH since the name lookups take
place over SSL. However, the certificate verification settings are not inherited but are controlled
separately via --doh-insecure and --doh-cert-status.
By default, DoH is bypassed when initially looking up DNS records of the DoH server. You can
specify the IP address(es) of the DoH server with --resolve to avoid this.
This option is unset if an empty string "" is used as the URL. (Added in 7.85.0)
Examples:
curl --doh-url https://doh.example https://example.com
curl --doh-url https://doh.example --resolve doh.example:443:192.0.2.1 https://example.com
If curl was not built with a default CA bundle embedded, the output is empty.
Providing --dump-ca-embed multiple times has no extra effect. Disable it again with --no-dump-
ca-embed.
Example:
curl --dump-ca-embed
Starting in curl 8.10.0, specify "%" (a single percent sign) as filename writes the output to stderr.
When used in FTP, the FTP server response lines are considered being "headers" and thus are
saved there.
Starting in curl 8.11.0, using the --create-dirs option can also create missing directory compo-
nents for the path provided in -D, --dump-header.
Having multiple transfers in one set of operations (i.e. the URLs in one -:, --next clause), ap-
pends them to the same file, separated by a blank line.
Examples:
curl --dump-header store.txt https://example.com
curl --dump-header - https://example.com -o save
Example:
curl --ech true https://example.com
Specify the path name to the Entropy Gathering Daemon socket. The socket is used to seed the
random engine for SSL connections.
Example:
curl --egd-file /random/here https://example.com
Example:
curl --engine flavor https://example.com
For correct results, make sure that the specified file contains only a single line with the desired
ETag. A non-existing or empty file is treated as an empty ETag.
Use the option --etag-save to first save the ETag from a response, and then use this option to
compare against the saved ETag in a subsequent request.
Example:
curl --etag-compare etag.txt https://example.com
In many situations you want to use an existing etag in the request to avoid downloading the same
resource again but also save the new etag if it has indeed changed, by using both etag options
--etag-save and --etag-compare with the same filename, in the same command line.
Starting in curl 8.12.0, using the --create-dirs option can also create missing directory compo-
nents for the path provided in --etag-save.
Example:
curl --etag-save storetag.txt https://example.com
The decimal value needs to be provided using a dot (".") as decimal separator - not the local ver-
sion even if it might be using another separator.
Example:
curl --expect100-timeout 2.5 -T file https://example.com
In normal cases when an HTTP server fails to deliver a document, it returns a body of text stating
so (which often also describes why and more) and a 4xx HTTP response code. This command line
option prevents curl from outputting that data and instead returns error 22 early. By default, curl
does not consider HTTP response codes to indicate failure.
To get both the error code and also save the content, use --fail-with-body instead.
This method is not fail-safe and there are occasions where non-successful response codes slip
through, especially when authentication is involved (response codes 401 and 407).
Providing --fail multiple times has no extra effect. Disable it again with --no-fail.
Example:
curl --fail https://example.com
This option is mutually exclusive with --fail-with-body. See also --fail-with-body and
--fail-early.
--fail-early
Fail and exit on the first detected transfer error.
When curl is used to do multiple transfers on the command line, it attempts to operate on each
given URL, one by one. By default, it ignores errors if there are more URLs given and the last
URL's success determines the error code curl returns. Early failures are "hidden" by subsequent
successful transfers.
Using this option, curl instead returns an error on the first transfer that fails, independent of the
amount of URLs that are given on the command line. This way, no transfer failures go undetected
by scripts and similar.
This option does not imply -f, --fail, which causes transfers to fail due to the server's HTTP sta-
tus code. You can combine the two options, however note -f, --fail is not global and is therefore
contained by -:, --next.
This option is global and does not need to be specified for each use of --next.
Providing --fail-early multiple times has no extra effect. Disable it again with --no-fail-early.
Example:
curl --fail-early https://example.com https://two.example
This is an alternative option to -f, --fail which makes curl fail for the same circumstances but
without saving the content.
Providing --fail-with-body multiple times has no extra effect. Disable it again with --no-fail-
with-body.
Example:
curl --fail-with-body https://example.com
This option is mutually exclusive with -f, --fail. Added in 7.76.0. See also -f, --fail and
--fail-early.
--false-start
(TLS) Use false start during the TLS handshake. False start is a mode where a TLS client starts
sending application data before verifying the server's Finished message, thus saving a round trip
when performing a full handshake.
This functionality is currently only implemented in the Secure Transport (on iOS 7.0 or later, or
macOS 10.9 or later) backend.
Providing --false-start multiple times has no extra effect. Disable it again with --no-false-start.
Example:
curl --false-start https://example.com
For SMTP and IMAP protocols, this composes a multipart mail message to transmit.
This enables uploading of binary files etc. To force the 'content' part to be a file, prefix the file-
name with an @ sign. To just get the content part from a file, prefix the filename with the symbol
<. The difference between @ and < is then that @ makes a file get attached in the post as a file up-
load, while the < makes a text field and just gets the contents for that text field from a file.
Read content from stdin instead of a file by using a single "-" as filename. This goes for both @
and < constructs. When stdin is used, the contents is buffered in memory first by curl to determine
its size and allow a possible resend. Defining a part's data from a named non-regular file (such as
a named pipe or similar) is not subject to buffering and is instead read at transmission time; since
the full size is unknown before the transfer starts, such data is sent as chunks by HTTP and re-
jected by IMAP.
Example: send an image to an HTTP server, where 'profile' is the name of the form-field to which
the file portrait.jpg is the input:
Example: send your name and shoe size in two text fields to the server:
Example: send your essay in a text field to the server. Send it as a plain text field, but get the con-
tents for it from a local file:
You can also instruct curl what Content-Type to use by using "type=", in a manner similar to:
or
You can also explicitly change the name field of a file upload part by setting filename=, like this:
curl -F "file=@\"local,file\";filename=\"name;in;post\"" \
https://example.com
or
curl -F 'file=@"local,file";filename="name;in;post"' \
https://example.com
Note that if a filename/path is quoted by double-quotes, any double-quote or backslash within the
filename must be escaped by backslash.
Quoting must also be applied to non-file data if it contains semicolons, leading/trailing spaces or
leading double quotes:
You can add custom headers to the field by setting headers=, like
or
The headers= keyword may appear more than once and above notes about quoting apply. When
headers are read from a file, empty lines and lines starting with '#' are ignored; each header can be
folded by splitting between two words and starting the continuation line with a space; embedded
carriage-returns and trailing spaces are stripped. Here is an example of a header file contents:
another header
- name can be omitted: the equal sign is the first character of the argument,
- if data starts with '(', this signals to start a new multipart: it can be followed by a content type
specification.
Example: the following command sends an SMTP mime email consisting in an inline part in two
alternative formats: plain text and HTML. It attaches a text file:
curl -F '=(;type=multipart/alternative' \
-F '=plain text message' \
-F '= <body>HTML message</body>;type=text/html' \
-F '=)' -F '[email protected]' ... smtp://example.com
Data can be encoded for transfer using encoder=. Available encodings are binary and 8bit that do
nothing else than adding the corresponding Content-Transfer-Encoding header, 7bit that only re-
jects 8-bit characters with a transfer error, quoted-printable and base64 that encodes data accord-
ing to the corresponding schemes, limiting lines length to 76 characters.
Example: send multipart mail with a quoted-printable text message and a base64 attached file:
Example:
curl --form "name=curl" --form "file=@loadthis" https://example.com
This option is mutually exclusive with -d, --data, -I, --head and -T, --upload-file. See also
-d, --data, --form-string and --form-escape.
--form-escape
(HTTP imap smtp) Pass on names of multipart form fields and files using backslash-escaping in-
stead of percent-encoding.
Example:
curl --form-escape -F ’field\name=curl’ -F ’file=@load"this’ https://example.com
Example:
curl --form-string "name=data" https://example.com
Example:
curl --ftp-account "mr.robot" ftp://example.com/
Example:
curl --ftp-alternative-to-user "U53r" ftp://example.com
Providing --ftp-create-dirs multiple times has no extra effect. Disable it again with --no-ftp-cre-
ate-dirs.
Example:
curl --ftp-create-dirs -T file ftp://example.com/remote/path/file
Examples:
curl --ftp-method multicwd ftp://example.com/dir1/dir2/file
curl --ftp-method nocwd ftp://example.com/dir1/dir2/file
curl --ftp-method singlecwd ftp://example.com/dir1/dir2/file
Reversing an enforced passive really is not doable but you must then instead enforce the correct
-P, --ftp-port again.
Passive mode means that curl tries the EPSV command first and then PASV, unless --dis-
able-epsv is used.
Providing --ftp-pasv multiple times has no extra effect. Disable it again with --no-ftp-pasv.
Example:
curl --ftp-pasv ftp://example.com/
You can also append ":[start]-[end]" to the right of the address, to tell curl what TCP port range to
use. That means you specify a port range, from a lower to a higher number. A single number
works as well, but do note that it increases the risk of failure since the port may not be available.
Examples:
curl -P - ftp:/example.com
curl -P eth0 ftp:/example.com
curl -P 192.168.0.2 ftp:/example.com
Providing --ftp-pret multiple times has no extra effect. Disable it again with --no-ftp-pret.
Example:
curl --ftp-pret ftp://example.com/
This option has no effect if PORT, EPRT or EPSV is used instead of PASV.
Providing --ftp-skip-pasv-ip multiple times has no extra effect. Disable it again with --no-ftp-
skip-pasv-ip.
Example:
curl --ftp-skip-pasv-ip ftp://example.com/
Providing --ftp-ssl-ccc multiple times has no extra effect. Disable it again with --no-ftp-ssl-ccc.
Example:
curl --ftp-ssl-ccc ftps://example.com/
Providing --ftp-ssl-ccc-mode multiple times has no extra effect. Disable it again with --no-ftp-
ssl-ccc-mode.
Example:
curl --ftp-ssl-ccc-mode active --ftp-ssl-ccc ftps://example.com/
--ftp-ssl-control
(FTP) Require SSL/TLS for the FTP login, clear for transfer. Allows secure authentication, but
non-encrypted data transfers for efficiency. Fails the transfer if the server does not support
SSL/TLS.
Providing --ftp-ssl-control multiple times has no extra effect. Disable it again with --no-ftp-ssl-
control.
Example:
curl --ftp-ssl-control ftp://example.com
If used in combination with -I, --head, the POST data is instead appended to the URL with a
HEAD request.
Providing --get multiple times has no extra effect. Disable it again with --no-get.
Examples:
curl --get https://example.com
curl --get -d "tool=curl" -d "age=old" https://example.com
curl --get -I -d "tool=curl" https://example.com
Providing --globoff multiple times has no extra effect. Disable it again with --no-globoff.
Example:
curl -g "https://example.com/{[]}}}}"
Happy Eyeballs is an algorithm that attempts to connect to both IPv4 and IPv6 addresses for
dual-stack hosts, giving IPv6 a head-start of the specified number of milliseconds. If the IPv6 ad-
dress cannot be connected to within that time, then a connection attempt is made to the IPv4 ad-
dress in parallel. The first connection to be established is the one that is used.
The range of suggested useful values is limited. Happy Eyeballs RFC 6555 says "It is RECOM-
MENDED that connection attempts be paced 150-250 ms apart to balance human factors against
network load." libcurl currently defaults to 200 ms. Firefox and Chrome currently default to 300
ms.
Example:
curl --happy-eyeballs-timeout-ms 500 https://example.com
For valid requests, IPv4 addresses must be indicated as a series of exactly 4 integers in the range
[0..255] inclusive written in decimal representation separated by exactly one dot between each
other. Heading zeroes are not permitted in front of numbers in order to avoid any possible confu-
sion with octal numbers. IPv6 addresses must be indicated as series of 4 hexadecimal digits (upper
or lower case) delimited by colons between each other, with the acceptance of one double colon
sequence to replace the largest acceptable range of consecutive zeroes. The total number of de-
coded bits must be exactly 128.
Otherwise, any string can be accepted for the client IP and get sent.
Example:
curl --haproxy-clientip $IP
This option is primarily useful when sending test requests to a service that expects this header.
Providing --haproxy-protocol multiple times has no extra effect. Disable it again with --no-
haproxy-protocol.
Example:
curl --haproxy-protocol https://example.com
Providing --head multiple times has no extra effect. Disable it again with --no-head.
Example:
curl -I https://example.com
For an IMAP or SMTP MIME uploaded mail built with -F, --form options, it is prepended to the
resulting MIME document, effectively including it at the mail global level. It does not affect raw
uploaded mails.
You may specify any number of extra headers. Note that if you should add a custom header that
has the same name as one of the internal ones curl would use, your externally set header is used in-
stead of the internal one. This allows you to make even trickier stuff than curl would normally do.
You should not replace internally set headers without knowing perfectly well what you are doing.
Remove an internal header by giving a replacement without content on the right side of the colon,
as in: -H "Host:". If you send the custom header with no-value then its header must be terminated
with a semicolon, such as -H "X-Custom-Header;" to send "X-Custom-Header:".
curl makes sure that each header you add/replace is sent with the proper end-of-line marker, you
should thus not add that as a part of the header content: do not add newlines or carriage returns,
they only mess things up for you. curl passes on the verbatim string you give it without any filter
or other safe guards. That includes white space and control characters.
This option can take an argument in @filename style, which then adds a header for each line in the
input file. Using @- makes curl read the header file from stdin.
Please note that most anti-spam utilities check the presence and value of several MIME mail
headers: these are "From:", "To:", "Date:" and "Subject:" among others and should be added with
this option.
You need --proxy-header to send custom headers intended for an HTTP proxy.
Passing on a "Transfer-Encoding: chunked" header when doing an HTTP request with a request
body, makes curl send the data using chunked encoding.
WARNING: headers set with this option are set in all HTTP requests - even after redirects are
followed, like when told with -L, --location. This can lead to the header being sent to other hosts
than the original host, so sensitive headers should be used with caution combined with following
redirects.
"Authorization:" and "Cookie:" headers are explicitly not passed on in HTTP requests when fol-
lowing redirects to other origins, unless --location-trusted is used.
Examples:
curl -H "X-First-Name: Joe" https://example.com
curl -H "User-Agent: yes-please/2000" https://example.com
curl -H "Host:" https://example.com
curl -H @headers.txt https://example.com
If no argument is provided, curl displays the most important command line arguments.
The argument can either be a category or a command line option. When a category is provided,
curl shows all command line options within the given category. Specify category "all" to list all
available options.
If the provided subject is instead an existing command line option, specified either in its short
form with a single dash and a single letter, or in the long form with two dashes and a longer name,
curl displays a help text for that option in the terminal.
If the provided command line option is not known, curl says so.
Examples:
curl --help all
curl --help --insecure
curl --help -f
Example:
curl --hostpubmd5 e5c1c49020640a5ab0f2034854c321a8 sftp://example.com/
This feature requires libcurl to be built with libssh2 and does not work with other SSH backends.
Example:
curl --hostpubsha256 NDVkMTQxMGQ1ODdmMjQ3MjczYjAyOTY5MmRkMjVmNDQ= sftp://example.com/
If curl is told to use HTTP:// for a transfer involving a hostname that exists in the HSTS cache, it
upgrades the transfer to use HTTPS. Each HSTS cache entry has an individual lifetime after which
the upgrade is no longer performed.
Specify a "" filename (zero length) to avoid loading/saving and make curl just handle HSTS in
memory.
If this option is used several times, curl loads contents from all the files but the last one is used for
saving.
Example:
curl --hsts cache.txt https://example.com
HTTP/0.9 is a response without headers and therefore you can also connect with this to
non-HTTP servers and still get a response since curl simply transparently downgrades - if al-
lowed.
Providing --http0.9 multiple times has no extra effect. Disable it again with --no-http0.9.
Example:
curl --http0.9 https://example.com
Example:
curl --http1.0 https://example.com
Example:
curl --http1.1 https://example.com
For HTTPS, this means curl negotiates HTTP/2 in the TLS handshake. curl does this by default.
For HTTP, this means curl attempts to upgrade the request to HTTP/2 using the Upgrade: request
header.
When curl uses HTTP/2 over HTTPS, it does not itself insist on TLS 1.2 or higher even though
that is required by the specification. A user can add this version requirement with --tlsv1.2.
Example:
curl --http2 https://example.com
--http2 requires that libcurl is built to support HTTP/2. This option is mutually exclusive with
--http1.1, --http1.0, --http2-prior-knowledge and --http3. See also --http1.1, --http3
and --no-alpn.
--http2-prior-knowledge
(HTTP) Issue a non-TLS HTTP request using HTTP/2 directly without HTTP/1.1 Upgrade. It re-
quires prior knowledge that the server supports HTTP/2 straight away. HTTPS requests still do
HTTP/2 the standard way with negotiated protocol versions in the TLS handshake.
Since 8.10.0 if this option is set for an HTTPS request then the application layer protocol version
(ALPN) offered to the server is only HTTP/2. Prior to that both HTTP/1.1 and HTTP/2 were of-
fered.
Providing --http2-prior-knowledge multiple times has no extra effect. Disable it again with --no-
http2-prior-knowledge.
Example:
curl --http2-prior-knowledge https://example.com
--http2-prior-knowledge requires that libcurl is built to support HTTP/2. This option is mutu-
ally exclusive with --http1.1, --http1.0, --http2 and --http3. See also --http2 and --http3.
--http3
(HTTP) Attempt HTTP/3 to the host in the URL, but fallback to earlier HTTP versions if the
HTTP/3 connection establishment fails or is slow. HTTP/3 is only available for HTTPS and not for
HTTP URLs.
This option allows a user to avoid using the Alt-Svc method of upgrading to HTTP/3 when you
know or suspect that the target speaks HTTP/3 on the given host and port.
When asked to use HTTP/3, curl issues a separate attempt to use older HTTP versions with a
slight delay, so if the HTTP/3 transfer fails or is slow, curl still tries to proceed with an older
HTTP version. The fallback performs the regular negotiation between HTTP/1 and HTTP/2.
Example:
curl --http3 https://example.com
--http3 requires that libcurl is built to support HTTP/3. This option is mutually exclusive with
--http1.1, --http1.0, --http2, --http2-prior-knowledge and --http3-only. Added in 7.66.0.
See also --http1.1 and --http2.
--http3-only
(HTTP) Instruct curl to use HTTP/3 to the host in the URL, with no fallback to earlier HTTP ver-
sions. HTTP/3 can only be used for HTTPS and not for HTTP URLs. For HTTP, this option trig-
gers an error.
This option allows a user to avoid using the Alt-Svc method of upgrading to HTTP/3 when you
know that the target speaks HTTP/3 on the given host and port.
This option makes curl fail if a QUIC connection cannot be established, it does not attempt any
other HTTP versions on its own. Use --http3 for similar functionality with a fallback.
Example:
curl --http3-only https://example.com
--http3-only requires that libcurl is built to support HTTP/3. This option is mutually exclusive
with --http1.1, --http1.0, --http2, --http2-prior-knowledge and --http3. Added in 7.88.0.
See also --http1.1, --http2 and --http3.
--ignore-content-length
(FTP HTTP) For HTTP, ignore the Content-Length header. This is particularly useful for servers
running Apache 1.x, which reports incorrect Content-Length for files larger than 2 gigabytes.
For FTP, this makes curl skip the SIZE command to figure out the size before downloading a file.
Providing --ignore-content-length multiple times has no extra effect. Disable it again with --no-
ignore-content-length.
Example:
curl --ignore-content-length https://example.com
When this option is not used for protocols using TLS, curl verifies the server's TLS certificate be-
fore it continues: that the certificate contains the right name which matches the hostname used in
the URL and that the certificate has been signed by a CA certificate present in the cert store. See
this online resource for further details: https://curl.se/docs/sslcerts.html
For SFTP and SCP, this option makes curl skip the known_hosts verification. known_hosts is a file
normally stored in the user's home directory in the ".ssh" subdirectory, which contains hostnames
and their public keys.
When curl uses secure protocols it trusts responses and allows for example HSTS and Alt-Svc in-
formation to be stored and used subsequently. Using -k, --insecure can make curl trust and use
such information from malicious servers.
Providing --insecure multiple times has no extra effect. Disable it again with --no-insecure.
Example:
curl --insecure https://example.com
--interface <name>
Perform the operation using a specified interface. You can enter interface name, IP address or host-
name. If you prefer to be specific, you can use the following special syntax:
if!<name>
Interface name. If the provided name does not match an existing interface, curl returns
with error 45.
host!<name>
IP address or hostname.
ifhost!<interface>!<host>
Interface name and IP address or hostname. This syntax requires libcurl 8.9.0 or later.
If the provided name does not match an existing interface, curl returns with error 45.
curl does not support using network interface names for this option on Windows.
That name resolve operation if a hostname is provided does not use DNS-over-HTTPS even if
--doh-url is set.
On Linux this option can be used to specify a VRF (Virtual Routing and Forwarding) device, but
the binary then needs to either have the CAP_NET_RAW capability set or to be run as root.
Examples:
curl --interface eth0 https://example.com
curl --interface "host!10.0.0.1" https://example.com
curl --interface "if!enp3s0" https://example.com
The values allowed for <string> can be a numeric value between 1 and 255 or one of the follow-
ing:
CS0, CS1, CS2, CS3, CS4, CS5, CS6, CS7, AF11, AF12, AF13, AF21, AF22, AF23, AF31,
AF32, AF33, AF41, AF42, AF43, EF, VOICE-ADMIT, ECT1, ECT0, CE, LE, LOWCOST,
LOWDELAY, THROUGHPUT, RELIABILITY, MINCOST
Example:
curl --ip-tos CS5 https://example.com
If you run a local IPFS node, this gateway is by default available under "http://localhost:8080". A
full example URL would look like:
There are many public IPFS gateways. See for example: https://ipfs.github.io/public-gate-
way-checker/
If you opt to go for a remote gateway you need to be aware that you completely trust the gateway.
This might be fine in local gateways that you host yourself. With remote gateways there could po-
tentially be malicious actors returning you data that does not match the request you made, inspect
or even interfere with the request. You may not notice this when using curl. A mitigation could be
to go for a "trustless" gateway. This means you locally verify the data. Consult the docs page on
trusted vs trustless: https://docs.ipfs.tech/reference/http/gateway/#trusted-vs-trustless
Example:
curl --ipfs-gateway https://example.com ipfs://
Example:
curl --ipv4 https://example.com
This option is mutually exclusive with -6, --ipv6. See also --http1.1 and --http2.
-6, --ipv6
Use IPv6 addresses only when resolving hostnames, and not for example try IPv4.
Your resolver may respond to an IPv6-only resolve request by returning IPv6 addresses that con-
tain "mapped" IPv4 addresses for compatibility purposes. macOS is known to do this.
Example:
curl --ipv6 https://example.com
This option is mutually exclusive with -4, --ipv4. See also --http1.1 and --http2.
--json <data>
(HTTP) Send the specified JSON data in a POST request to the HTTP server. --json works as a
shortcut for passing on these three options:
--data-binary [arg]
--header "Content-Type: application/json"
--header "Accept: application/json"
There is no verification that the passed in data is actual JSON or that the syntax is correct.
If you start the data with the letter @, the rest should be a filename to read the data from, or a sin-
gle dash (-) if you want curl to read the data from stdin. Posting data from a file named 'foobar'
would thus be done with --json @foobar and to instead read the data from stdin, use --json @-.
If this option is used more than once on the same command line, the additional data pieces are
concatenated to the previous before sending.
The headers this option sets can be overridden with -H, --header as usual.
Examples:
curl --json ’{ "drink": "coffe" }’ https://example.com
curl --json ’{ "drink":’ --json ’ "coffe" }’ https://example.com
curl --json @prepared https://example.com
curl --json @- https://example.com < json.txt
This option is mutually exclusive with -F, --form, -I, --head and -T, --upload-file. Added in
7.82.0. See also --data-binary and --data-raw.
-j, --junk-session-cookies
(HTTP) When curl is told to read cookies from a given file, this option makes it discard all "ses-
sion cookies". This has the same effect as if a new session is started. Typical browsers discard ses-
sion cookies when they are closed down.
Providing --junk-session-cookies multiple times has no extra effect. Disable it again with --no-
junk-session-cookies.
Example:
curl --junk-session-cookies -b cookies.txt https://example.com
This option is supported on Linux, *BSD/macOS, Windows >=10.0.16299, Solaris 11.4, and re-
cent AIX, HP-UX and more. This option has no effect if --no-keepalive is used.
Example:
curl --keepalive-cnt 3 https://example.com
Example:
curl --keepalive-time 20 https://example.com
If curl is built against OpenSSL library, and the engine pkcs11 or pkcs11 provider is available,
then a PKCS#11 URI (RFC 7512) can be used to specify a private key located in a PKCS#11 de-
vice. A string beginning with "pkcs11:" is interpreted as a PKCS#11 URI. If a PKCS#11 URI is
provided, then the --engine option is set as "pkcs11" if none was provided and the --key-type
option is set as "ENG" or "PROV" if none was provided (depending on OpenSSL version).
If curl is built against Secure Transport or Schannel then this option is ignored for TLS protocols
(HTTPS, etc). Those backends expect the private key to be already present in the keychain or
PKCS#12 file containing the certificate.
Example:
curl --cert certificate --key here https://example.com
Example:
curl --key-type DER --key here https://example.com
Example:
curl --krb clear ftp://example.com/
--krb requires that libcurl is built to support Kerberos. See also --delegation and --ssl.
--libcurl <file>
Append this option to any ordinary curl command line, and you get libcurl-using C source code
written to the file that does the equivalent of what your command-line operation does.
This option is global and does not need to be specified for each use of --next.
Example:
curl --libcurl client.c https://example.com
The given speed is measured in bytes/second, unless a suffix is appended. Appending 'k' or 'K'
counts the number as kilobytes, 'm' or 'M' makes it megabytes, while 'g' or 'G' makes it gigabytes.
The suffixes (k, M, G, T, P) are 1024 based. For example 1k is 1024. Examples: 200K, 3m and 1G.
The rate limiting logic works on averaging the transfer speed to no more than the set threshold
over a period of multiple seconds.
If you also use the -Y, --speed-limit option, that option takes precedence and might cripple the
rate-limiting slightly, to help keep the speed-limit logic working.
Examples:
curl --limit-rate 100K https://example.com
curl --limit-rate 1000 https://example.com
curl --limit-rate 10M https://example.com
Note: Some FTP servers list only files in their response to NLST; they do not include sub-directo-
ries and symbolic links.
When listing an SFTP directory, this switch forces a name-only view, one per line. This is espe-
cially useful if the user wants to machine-parse the contents of an SFTP directory since the nor-
mal directory view provides more information than just filenames.
When retrieving a specific email from POP3, this switch forces a LIST command to be performed
instead of RETR. This is particularly useful if the user wants to see if a specific message-id exists
on the server and what size it is.
For FILE, this option has no effect yet as directories are always listed in this mode.
Note: When combined with -X, --request, this option can be used to send a UIDL command in-
stead, so the user may use the email's unique identifier rather than its message-id to make the re-
quest.
Providing --list-only multiple times has no extra effect. Disable it again with --no-list-only.
Example:
curl --list-only ftp://example.com/dir/
Example:
curl --local-port 1000-3000 https://example.com
When authentication is used, or when sending a cookie with "-H Cookie:", curl only sends its cre-
dentials to the initial host. If a redirect takes curl to a different host, it does not get the credentials
passed on. See --location-trusted on how to change this.
When curl follows a redirect and if the request is a POST, it sends the following request with a
GET if the HTTP response was 301, 302, or 303. If the response code was any other 3xx code,
curl resends the following request using the same unmodified method.
You can tell curl to not change POST requests to GET after a 30x response by using the dedicated
options for that: --post301, --post302 and --post303.
The method set with -X, --request overrides the method curl would otherwise select to use.
Providing --location multiple times has no extra effect. Disable it again with --no-location.
Example:
curl -L https://example.com
This may or may not introduce a security breach if the site redirects you to a site to which you
send this sensitive data to. Another host means that one or more of hostname, protocol scheme or
port number changed.
This option also allows curl to pass long cookies set explicitly with -H, --header.
Providing --location-trusted multiple times has no extra effect. Disable it again with --no-
location-trusted.
Examples:
curl --location-trusted -u user:password https://example.com
curl --location-trusted -H "Cookie: session=abc" https://example.com
You can use login options to specify protocol specific options that may be used during authentica-
tion. At present only IMAP, POP3 and SMTP support login options. For more information about
login options please see RFC 2384, RFC 5092 and the IETF draft https://data-
tracker.ietf.org/doc/html/draft-earhart-url-smtp-00
Since 8.2.0, IMAP supports the login option "AUTH=+LOGIN". With this option, curl uses the
plain (not SASL) "LOGIN IMAP" command even if the server advertises SASL authentication.
Care should be taken in using this option, as it sends your password over the network in plain text.
This does not work if the IMAP server disables the plain "LOGIN" (e.g. to prevent password
snooping).
Example:
curl --login-options ’AUTH=*’ imap://example.com
Example:
curl --mail-auth [email protected] -T mail smtp://example.com/
Example:
curl --mail-from [email protected] -T mail smtp://example.com/
When performing an address verification (VRFY command), the recipient should be specified as
the username or username and domain (as per Section 3.5 of RFC 5321).
When performing a mailing list expand (EXPN command), the recipient should be specified using
the mailing list name, such as "Friends" or "London-Office".
Example:
curl --mail-rcpt [email protected] smtp://example.com
If all recipients trigger RCPT TO failures and this flag is specified, curl still aborts the SMTP con-
versation and returns the error received from to the last RCPT TO command.
Providing --mail-rcpt-allowfails multiple times has no extra effect. Disable it again with --no-
mail-rcpt-allowfails.
Example:
curl --mail-rcpt-allowfails --mail-rcpt [email protected] smtp://example.com
Example:
curl --manual
A size modifier may be used. For example, Appending 'k' or 'K' counts the number as kilobytes,
'm' or 'M' makes it megabytes, while 'g' or 'G' makes it gigabytes. Examples: 200K, 3m and 1G.
NOTE: before curl 8.4.0, when the file size is not known prior to download, for such files this op-
tion has no effect even if the file transfer ends up being larger than this given limit.
Starting with curl 8.4.0, this option aborts the transfer if it reaches the threshold during transfer.
Example:
curl --max-filesize 100K https://example.com
Example:
curl --max-redirs 3 --location https://example.com
If you enable retrying the transfer (--retry) then the maximum time counter is reset each time the
transfer is retried. You can use --retry-max-time to limit the retry time.
The decimal value needs to be provided using a dot (.) as decimal separator - not the local version
even if it might be using another separator.
Examples:
curl --max-time 10 https://example.com
curl --max-time 2.92 https://example.com
Example:
curl --metalink file https://example.com
MPTCP is beneficial in networks where multiple paths exist between clients and servers, such as
mobile networks where a device may switch between WiFi and cellular data or in wired networks
with multiple Internet Service Providers.
This option is currently only supported on Linux starting from kernel 5.6. Only TCP connections
are modified, hence this option does not affect HTTP/3 (QUIC) or UDP connections.
The server curl connects to must also support MPTCP. If not, the connection seamlessly falls back
to TCP.
Providing --mptcp multiple times has no extra effect. Disable it again with --no-mptcp.
Example:
curl --mptcp https://example.com
This option requires a library built with GSS-API or SSPI support. Use -V, --version to see if
your curl supports GSS-API/SSPI or SPNEGO.
When using this option, you must also provide a fake -u, --user option to activate the authenti-
cation code properly. Sending a '-u :' is enough as the username and password from the -u,
--user option are not actually used.
Example:
curl --negotiate -u : https://example.com
On Windows two filenames in the home directory are checked: .netrc and _netrc, preferring the
former. Older versions on Windows checked for _netrc only.
A quick and simple example of how to setup a .netrc to allow curl to FTP to the machine host.ex-
ample.com with username 'myself' and password 'secret' could look similar to:
machine host.example.com
login myself
password secret
Providing --netrc multiple times has no extra effect. Disable it again with --no-netrc.
Example:
curl --netrc https://example.com
This option is mutually exclusive with --netrc-file and --netrc-optional. See also
--netrc-file, -K, --config and -u, --user.
--netrc-file <filename>
Set the netrc file to use. Similar to -n, --netrc, except that you also provide the path (absolute or
relative).
Example:
curl --netrc-file netrc https://example.com
This option is mutually exclusive with -n, --netrc. See also -n, --netrc, -u, --user and -K,
--config.
--netrc-optional
Similar to -n, --netrc, but this option makes the .netrc usage optional and not mandatory as the
-n, --netrc option does.
Providing --netrc-optional multiple times has no extra effect. Disable it again with --no-netrc-op-
tional.
Example:
curl --netrc-optional https://example.com
This option is mutually exclusive with -n, --netrc. See also --netrc-file.
-:, --next
Use a separate operation for the following URL and associated options. This allows you to send
several URL requests, each with their own specific options, for example, such as different user-
names or custom requests for each.
-:, --next resets all local options and only global ones have their values survive over to the oper-
ation following the -:, --next instruction. Global options include -v, --verbose, --trace,
--trace-ascii and --fail-early.
For example, you can do both a GET and a POST in a single command line:
Examples:
curl https://example.com --next -d postthis www2.example.com
curl -I https://example.com --next https://example.net/
Note that this is the negated option name documented. You can use --alpn to enable ALPN.
Providing --no-alpn multiple times has no extra effect. Disable it again with --alpn.
Example:
curl --no-alpn https://example.com
--no-alpn requires that libcurl is built to support TLS. See also --no-npn and --http2.
-N, --no-buffer
Disable the buffering of the output stream. In normal work situations, curl uses a standard buffered
output stream that has the effect that it outputs the data in chunks, not necessarily exactly when the
data arrives. Using this option disables that buffering.
Note that this is the negated option name documented. You can use --buffer to enable buffering
again.
Providing --no-buffer multiple times has no extra effect. Disable it again with --buffer.
Example:
curl --no-buffer https://example.com
Note that this is the negated option name documented. You can thus use --clobber to enforce the
clobbering, even if -J, --remote-header-name is specified.
Providing --no-clobber multiple times has no extra effect. Disable it again with --clobber.
Example:
curl --no-clobber --output local/dir/file https://example.com
Note that this is the negated option name documented. You can thus use --keepalive to enforce
keepalive.
Providing --no-keepalive multiple times has no extra effect. Disable it again with --keepalive.
Example:
curl --no-keepalive https://example.com
Disable the NPN TLS extension. NPN is enabled by default if libcurl was built with an SSL li-
brary that supports NPN. NPN is used by a libcurl that supports HTTP/2 to negotiate HTTP/2 sup-
port with the server during https sessions.
Providing --no-npn multiple times has no extra effect. Disable it again with --npn.
Example:
curl --no-npn https://example.com
--no-npn requires that libcurl is built to support TLS. See also --no-alpn and --http2.
--no-progress-meter
Option to switch off the progress meter output without muting or otherwise affecting warning and
informational messages like -s, --silent does.
Note that this is the negated option name documented. You can thus use --progress-meter to en-
able the progress meter again.
Providing --no-progress-meter multiple times has no extra effect. Disable it again with
--progress-meter.
Example:
curl --no-progress-meter -o store https://example.com
Note that this is the negated option name documented. You can thus use --sessionid to enforce
session-ID caching.
Providing --no-sessionid multiple times has no extra effect. Disable it again with --sessionid.
Example:
curl --no-sessionid https://example.com
This option overrides the environment variables that disable the proxy ("no_proxy" and
"NO_PROXY"). If there is an environment variable disabling a proxy, you can set the no proxy list
to "" to override it.
IP addresses specified to this option can be provided using CIDR notation (added in 7.86.0): an ap-
pended slash and number specifies the number of network bits out of the address to use in the
comparison. For example "192.168.0.0/16" would match all addresses starting with "192.168".
Example:
curl --noproxy "www.example" https://example.com
If you want to enable NTLM for your proxy authentication, then use --proxy-ntlm.
Example:
curl --ntlm -u user:password https://example.com
--ntlm requires that libcurl is built to support TLS. This option is mutually exclusive with --ba-
sic, --negotiate, --digest and --anyauth. See also --proxy-ntlm.
--ntlm-wb
(HTTP) Deprecated option (added in 8.8.0).
Enabled NTLM much in the style --ntlm does, but handed over the authentication to a separate
executable that was executed when needed.
Example:
curl --ntlm-wb -u user:password https://example.com
The Bearer Token and username are formatted according to RFC 6750.
Example:
curl --oauth2-bearer "mF_9.B5f-4.1JqM" https://example.com
You may use this option as many times as the number of URLs you have. For example, if you
specify two URLs on the same command line, you can use it like this:
and the order of the -o options and the URLs does not matter, just that the first -o is for the first
URL and so on, so the above command line can also be written as
See also the --create-dirs option to create the local directories dynamically. Specifying the out-
put as '-' (a single dash) passes the output to stdout.
Or for Windows:
Specify the filename as single minus to force the output to stdout, to override curl's internal binary
output in terminal prevention:
curl https://example.com/jpeg -o -
--output is associated with a single URL. Use it once per URL when you use several URLs in a
command line.
Examples:
curl -o file https://example.com
curl "http://{one,two}.example.com" -o "file_#1.txt"
curl "http://{site,host}.host[1-5].example" -o "#1_#2"
curl -o file https://example.com -o file2 https://example.net
The given output directory is used for all URLs and output options on the command line, up until
the first -:, --next.
If the specified target directory does not exist, the operation fails unless --create-dirs is also
used.
Example:
curl --output-dir "tmp" -O https://example.com
With parallel transfers, the progress meter output is different from when doing serial transfers, as it
then displays the transfer status for multiple transfers in a single line.
The maximum amount of concurrent transfers is set with --parallel-max and it defaults to 50.
This option is global and does not need to be specified for each use of --next.
Providing --parallel multiple times has no extra effect. Disable it again with --no-parallel.
Example:
curl --parallel https://example.com -o file1 https://example.com -o file2
Added in 7.66.0. See also -:, --next, -v, --verbose, --parallel-max and --parallel-immedi-
ate.
--parallel-immediate
When doing parallel transfers, this option instructs curl to prefer opening up more connections in
parallel at once rather than waiting to see if new transfers can be added as multiplexed streams on
another connection.
By default, without this option set, curl prefers to wait a little and multiplex new transfers over ex-
isting connections. It keeps the number of connections low at the expense of risking a slightly
slower transfer startup.
This option is global and does not need to be specified for each use of --next.
Providing --parallel-immediate multiple times has no extra effect. Disable it again with --no-par-
allel-immediate.
Example:
curl --parallel-immediate -Z https://example.com -o file1 https://example.com -o file2
This option is global and does not need to be specified for each use of --next.
Example:
curl --parallel-max 100 -Z https://example.com ftp://example.com/
Example:
curl --pass secret --key file https://example.com
Providing --path-as-is multiple times has no extra effect. Disable it again with --no-path-as-is.
Example:
curl --path-as-is https://example.com/../../etc/passwd
When negotiating a TLS or SSL connection, the server sends a certificate indicating its identity. A
public key is extracted from this certificate and if it does not exactly match the public key provided
to this option, curl aborts the connection before sending or receiving any data.
This option is independent of option -k, --insecure. If you use both options together then the
peer is still verified by public key.
PEM/DER support:
OpenSSL and GnuTLS, wolfSSL, mbedTLS, Secure Transport macOS 10.7+/iOS 10+, Schannel
sha256 support:
OpenSSL, GnuTLS and wolfSSL, mbedTLS, Secure Transport macOS 10.7+/iOS 10+, Schannel
Examples:
curl --pinnedpubkey keyfile https://example.com
curl --pinnedpubkey ’sha256//ce118b51897f4452dc’ https://example.com
Providing --post301 multiple times has no extra effect. Disable it again with --no-post301.
Example:
Providing --post302 multiple times has no extra effect. Disable it again with --no-post302.
Example:
curl --post302 --location -d "data" https://example.com
Providing --post303 multiple times has no extra effect. Disable it again with --no-post303.
Example:
curl --post303 --location -d "data" https://example.com
The pre proxy string should be specified with a protocol:// prefix to specify alternative proxy pro-
tocols. Use socks4://, socks4a://, socks5:// or socks5h:// to request the specific SOCKS version to
be used. No protocol specified makes curl default to SOCKS4.
If the port number is not specified in the proxy string, it is assumed to be 1080.
User and password that might be provided in the proxy string are URL decoded by curl. This al-
lows you to pass in special characters such as @ by using %40 or pass in a colon with %3a.
Example:
curl --preproxy socks5://proxy.example -x http://http.example https://example.com
This progress bar draws a single line of '#' characters across the screen and shows a percentage if
the transfer size is known. For transfers without a known size, there is a space ship (-=o=-) that
moves back and forth but only while data is being transferred, with a set of flying hash sign
symbols on top.
This option is global and does not need to be specified for each use of --next.
Providing --progress-bar multiple times has no extra effect. Disable it again with --no-progress-
bar.
Example:
curl -# -O https://example.com
Unknown and disabled protocols produce a warning. This allows scripts to safely rely on being
able to disable potentially dangerous protocols, without relying upon support for that protocol be-
ing built into curl to avoid an error.
This option can be used multiple times, in which case the effect is the same as concatenating the
protocols into one instance of the option.
Example:
curl --proto =http,https,sftp https://example.com
This option does not change the default proxy protocol (http).
Without this option set, curl guesses protocol based on the hostname, see --url for details.
Example:
curl --proto-default https ftp.example.com
By default curl only allows HTTP, HTTPS, FTP and FTPS on redirects (added in 7.65.2). Specify-
ing all or +all enables all protocols on redirects, which is not good for security.
Example:
curl --proto-redir =http,https https://example.com
The proxy string can be specified with a protocol:// prefix. No protocol specified or http:// it is
treated as an HTTP proxy. Use socks4://, socks4a://, socks5:// or socks5h:// to request a specific
SOCKS version to be used.
Unix domain sockets are supported for socks proxy. Set localhost for the host part. e.g.
socks5h://localhost/path/to/socket.sock
HTTPS proxy support works with the https:// protocol prefix for OpenSSL and GnuTLS. It also
works for BearSSL, mbedTLS, Rustls, Schannel, Secure Transport and wolfSSL (added in 7.87.0).
Unrecognized and unsupported proxy protocols cause an error. Ancient curl versions ignored un-
known schemes and used http:// instead.
If the port number is not specified in the proxy string, it is assumed to be 1080.
This option overrides existing environment variables that set the proxy to use. If there is an envi-
ronment variable setting a proxy, you can set proxy to "" to override it.
All operations that are performed over an HTTP proxy are transparently converted to HTTP. It
means that certain protocol specific operations might not be available. This is not the case if you
can tunnel through the proxy, as one with the -p, --proxytunnel option.
User and password that might be provided in the proxy string are URL decoded by curl. This al-
lows you to pass in special characters such as @ by using %40 or pass in a colon with %3a.
The proxy host can be specified the same way as the proxy environment variables, including the
protocol prefix (http://) and the embedded user + password.
When a proxy is used, the active FTP mode as set with -P, --ftp-port, cannot be used.
Doing FTP over an HTTP proxy without -p, --proxytunnel makes curl do HTTP with an FTP
URL over the proxy. For such transfers, common FTP specific options do not work, including
--ssl-reqd and --ftp-ssl-control.
Example:
curl --proxy http://proxy.example https://example.com
Example:
curl --proxy-anyauth --proxy-user user:passwd -x proxy https://example.com
Example:
curl --proxy-basic --proxy-user user:passwd -x proxy https://example.com
This option is independent of other HTTPS proxy CA certificate locations set at run time or build
time. Those locations are searched in addition to the native CA store.
Equivalent to --ca-native but used in HTTPS proxy context. Refer to --ca-native for TLS
backend limitations.
Providing --proxy-ca-native multiple times has no extra effect. Disable it again with --no-proxy-
ca-native.
Example:
curl --proxy-ca-native https://example.com
Added in 8.2.0. See also --ca-native, --cacert, --capath, --dump-ca-embed and -k, --in-
secure.
--proxy-cacert <file>
Use the specified certificate file to verify the HTTPS proxy. The file may contain multiple CA cer-
tificates. The certificate(s) must be in PEM format.
This allows you to use a different trust for the proxy compared to the remote server connected to
via the proxy.
Example:
curl --proxy-cacert CA-file.txt -x https://proxy https://example.com
Use the specified certificate directory to verify the proxy. Multiple paths can be provided by sepa-
rating them with colon (":") (e.g. "path1:path2:path3"). The certificates must be in PEM format,
and if curl is built against OpenSSL, the directory must have been processed using the c_rehash
utility supplied with OpenSSL. Using --proxy-capath can allow OpenSSL-powered curl to
make SSL-connections much more efficiently than using --proxy-cacert if the --proxy-cacert
file contains many CA certificates.
Example:
curl --proxy-capath /local/directory -x https://proxy https://example.com
This option is the equivalent to -E, --cert but used in HTTPS proxy context.
Example:
curl --proxy-cert file -x https://proxy https://example.com
The default type depends on the TLS backend and is usually PEM, however for Secure Transport
and Schannel it is P12. If --proxy-cert is a pkcs11: URI then ENG or PROV is the default type
(depending on OpenSSL version).
Example:
curl --proxy-cert-type PEM --proxy-cert file -x https://proxy https://example.com
Specify which cipher suites to use in the connection to your HTTPS proxy when it negotiates TLS
1.2 (1.1, 1.0). The list of ciphers suites must specify valid ciphers. Read up on cipher suite details
on this URL:
https://curl.se/docs/ssl-ciphers.html
Example:
curl --proxy-ciphers ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256 -x https:/
Example:
curl --proxy-crlfile rejects.txt -x https://proxy https://example.com
Example:
curl --proxy-digest --proxy-user user:passwd -x proxy https://example.com
curl makes sure that each header you add/replace is sent with the proper end-of-line marker, you
should thus not add that as a part of the header content: do not add newlines or carriage returns,
they only mess things up for you.
Headers specified with this option are not included in requests that curl knows are not to be sent to
a proxy.
This option can take an argument in @filename style, which then adds a header for each line in the
input file. Using @- makes curl read the headers from stdin.
Examples:
curl --proxy-header "X-First-Name: Joe" -x http://proxy https://example.com
curl --proxy-header "User-Agent: surprise" -x http://proxy https://example.com
curl --proxy-header "Host:" -x http://proxy https://example.com
Providing --proxy-http2 multiple times has no extra effect. Disable it again with --no-proxy-
http2.
Example:
curl --proxy-http2 -x proxy https://example.com
--proxy-http2 requires that libcurl is built to support HTTP/2. Added in 8.1.0. See also -x,
--proxy.
--proxy-insecure
Same as -k, --insecure but used in HTTPS proxy context.
Every secure connection curl makes is verified to be secure before the transfer takes place. This
option makes curl skip the verification step with a proxy and proceed without checking.
When this option is not used for a proxy using HTTPS, curl verifies the proxy's TLS certificate be-
fore it continues: that the certificate contains the right name which matches the hostname and that
the certificate has been signed by a CA certificate present in the cert store. See this online resource
for further details: https://curl.se/docs/sslcerts.html
WARNING: using this option makes the transfer to the proxy insecure.
Providing --proxy-insecure multiple times has no extra effect. Disable it again with --no-proxy-
insecure.
Example:
curl --proxy-insecure -x https://proxy https://example.com
Example:
curl --proxy-key here -x https://proxy https://example.com
Example:
curl --proxy-key-type DER --proxy-key here -x https://proxy https://example.com
Example:
curl --proxy-negotiate --proxy-user user:passwd -x proxy https://example.com
Example:
curl --proxy-ntlm --proxy-user user:passwd -x http://proxy https://example.com
Example:
curl --proxy-pass secret --proxy-key here -x https://proxy https://example.com
When negotiating a TLS or SSL connection, the server sends a certificate indicating its identity. A
public key is extracted from this certificate and if it does not exactly match the public key provided
to this option, curl aborts the connection before sending or receiving any data.
Before curl 8.10.0 this option did not work due to a bug.
Examples:
curl --proxy-pinnedpubkey keyfile https://example.com
curl --proxy-pinnedpubkey ’sha256//ce118b51897f4452dc’ https://example.com
Example:
curl --proxy-service-name "shrubbery" -x proxy https://example.com
This option only changes how curl does TLS 1.0 with an HTTPS proxy and has no effect on later
TLS versions.
WARNING: this option loosens the TLS security, and by using this flag you ask for exactly that.
Providing --proxy-ssl-allow-beast multiple times has no extra effect. Disable it again with --no-
proxy-ssl-allow-beast.
Example:
curl --proxy-ssl-allow-beast -x https://proxy https://example.com
Providing --proxy-ssl-auto-client-cert multiple times has no extra effect. Disable it again with
--no-proxy-ssl-auto-client-cert.
Example:
curl --proxy-ssl-auto-client-cert -x https://proxy https://example.com
Specify which cipher suites to use in the connection to your HTTPS proxy when it negotiates TLS
1.3. The list of ciphers suites must specify valid ciphers. Read up on TLS 1.3 cipher suite details
on this URL:
https://curl.se/docs/ssl-ciphers.html
This option is used when curl is built to use OpenSSL 1.1.1 or later, Schannel, wolfSSL, or
mbedTLS 3.6.0 or later.
Before curl 8.10.0 with mbedTLS or wolfSSL, TLS 1.3 cipher suites were set by using the
--proxy-ciphers option.
Example:
curl --proxy-tls13-ciphers TLS_AES_128_GCM_SHA256 -x proxy https://example.com
Example:
curl --proxy-tlsauthtype SRP -x https://proxy https://example.com
Example:
curl --proxy-tlspassword passwd -x https://proxy https://example.com
Example:
Example:
curl --proxy-tlsv1 -x https://proxy https://example.com
If you use a Windows SSPI-enabled curl binary and do either Negotiate or NTLM authentication
then you can tell curl to select the username and password from your environment by specifying a
single colon with this option: "-U :".
On systems where it works, curl hides the given option argument from process listings. This is not
enough to protect credentials from possibly getting seen by other users on the same system as they
still are visible for a moment before being cleared. Such sensitive data should be retrieved from a
file instead or similar and never used in clear text in a command line.
Example:
curl --proxy-user smith:secret -x proxy https://example.com
The only difference between this and the HTTP proxy option -x, --proxy, is that attempts to use
CONNECT through the proxy specifies an HTTP 1.0 protocol instead of the default HTTP 1.1.
Example:
curl --proxy1.0 http://proxy https://example.com
To suppress proxy CONNECT response headers when curl is set to output headers use --sup-
press-connect-headers.
Providing --proxytunnel multiple times has no extra effect. Disable it again with --no-proxytun-
nel.
Example:
curl --proxytunnel -x http://proxy https://example.com
curl attempts to automatically extract the public key from the private key file, so passing this op-
tion is generally not required. Note that this public key extraction requires libcurl to be linked
against a copy of libssh2 1.2.8 or higher that is itself linked against OpenSSL.
Example:
curl --pubkey file.pub sftp://example.com/
(FTP only) To make commands be sent after curl has changed the working directory, just before
the file transfer command(s), prefix the command with a '+'. This is not performed when a direc-
tory listing is performed.
By default curl stops at first failure. To make curl continue even if the command fails, prefix the
command with an asterisk (*). Otherwise, if the server returns failure for one of the commands,
the entire operation is aborted.
You must send syntactically correct FTP commands as RFC 959 defines to FTP servers, or one of
the commands listed below to SFTP servers.
SFTP is a binary protocol. Unlike for FTP, curl interprets SFTP quote commands itself before
sending them to the server. Filenames may be quoted shell-style to embed spaces or special char-
acters. Following is the list of all supported SFTP quote commands:
atime date file
The atime command sets the last access time of the file named by the file operand. The
date expression can be all sorts of date strings, see the curl_getdate(3) man page for date
expression details. (Added in 7.73.0)
chgrp group file
The chgrp command sets the group ID of the file named by the file operand to the group
ID specified by the group operand. The group operand is a decimal integer group ID.
chmod mode file
The chmod command modifies the file mode bits of the specified file. The mode operand
is an octal integer mode number.
Example:
curl --quote "DELE file" ftp://example.com/foo
Specify the path name to file containing random data. The data may be used to seed the random
engine for SSL connections.
Example:
curl --random-file rubbish https://example.com
Only digit characters (0-9) are valid in the 'start' and 'stop' fields of the 'start-stop' range syntax. If
a non-digit character is given in the range, the server's response is unspecified, depending on the
server's configuration.
Many HTTP/1.1 servers do not have this feature enabled, so that when you attempt to get a range,
curl instead gets the whole document.
FTP and SFTP range downloads only support the simple 'start-stop' syntax (optionally with one of
the numbers omitted). FTP use depends on the extended FTP command SIZE.
When using this option for HTTP uploads using POST or PUT, functionality is not guaranteed.
The HTTP protocol has no standard interoperable resume upload and curl uses a set of headers for
this purpose that once proved working for some servers and have been left for those who find that
useful.
This command line option is mutually exclusive with -C, --continue-at: you can only use one
of them for a single transfer.
Example:
curl --range 22-44 https://example.com
If given several URLs and a transfer completes faster than the allowed rate, curl waits until the
next transfer is started to maintain the requested rate. This option has no effect when -Z, --paral-
lel is used.
The request rate is provided as "N/U" where N is an integer number and U is a time unit. Sup-
ported units are 's' (second), 'm' (minute), 'h' (hour) and 'd' /(day, as in a 24 hour unit). The default
time unit, if no "/U" is provided, is number of transfers per hour.
If curl is told to allow 10 requests per minute, it does not start the next request until 6 seconds have
elapsed since the previous transfer was started.
This function uses millisecond resolution. If the allowed frequency is set more than 1000 per sec-
ond, it instead runs unrestricted.
When retrying transfers, enabled with --retry, the separate retry delay logic is used and not this
setting.
Starting in version 8.10.0, you can specify the number of time units in the rate expression. Make
curl do no more than 5 transfers per 15 seconds with "5/15s" or limit it to 3 transfers per 4 hours
with "3/4h". No spaces allowed.
This option is global and does not need to be specified for each use of --next.
Examples:
curl --rate 2/s https://example.com ...
curl --rate 3/h https://example.com ...
curl --rate 14/m https://example.com ...
Providing --raw multiple times has no extra effect. Disable it again with --no-raw.
Example:
curl --raw https://example.com
Examples:
curl --referer "https://fake.example" https://example.com
curl --referer "https://fake.example;auto" -L https://example.com
curl --referer ";auto" -L https://example.com
The file is saved in the current directory, or in the directory specified with --output-dir.
If the server specifies a filename and a file with that name already exists in the destination direc-
tory, it is not overwritten and an error occurs - unless you allow it by using the --clobber option.
If the server does not specify a filename then this option has no effect.
There is no attempt to decode %-sequences (yet) in the provided filename, so this option may pro-
vide you with rather unexpected filenames.
This feature uses the name from the "filename" field, it does not yet support the "filename*" field
(filenames with explicit character sets).
WARNING: Exercise judicious use of this option, especially on Windows. A rogue server could
send you the name of a DLL or other file that could be loaded automatically by Windows or some
third party software.
Providing --remote-header-name multiple times has no extra effect. Disable it again with --no-re-
mote-header-name.
Example:
curl -OJ https://example.com/file
The file is saved in the current working directory. If you want the file saved in a different directory,
make sure you change the current working directory before invoking curl with this option or use
--output-dir.
The remote filename to use for saving is extracted from the given URL, nothing else, and if it al-
ready exists it is overwritten. If you want the server to be able to choose the filename refer to -J,
--remote-header-name which can be used in addition to this option. If the server chooses a file-
name and that name already exists it is not overwritten.
There is no URL decoding done on the filename. If it has %20 or other URL encoded parts of the
name, they end up as-is as filename.
You may use this option as many times as the number of URLs you have.
Before curl 8.10.0, curl returned an error if the URL ended with a slash, which means that there is
no filename part in the URL. Starting in 8.10.0, curl sets the filename to the last directory part of
the URL or if that also is missing to "curl_response" (without extension) for this situation.
--remote-name is associated with a single URL. Use it once per URL when you use several URLs
in a command line.
Examples:
curl -O https://example.com/filename
curl -O https://example.com/filename -O https://example.com/file2
Providing --remote-name-all multiple times has no extra effect. Disable it again with --no-re-
mote-name-all.
Example:
curl --remote-name-all ftp://example.com/file1 ftp://example.com/file2
Providing --remote-time multiple times has no extra effect. Disable it again with --no-remote-
time.
Example:
curl --remote-time -o foo https://example.com
Providing --remove-on-error multiple times has no extra effect. Disable it again with --no-re-
move-on-error.
Example:
curl --remove-on-error -o output https://example.com
curl passes on the verbatim string you give it in the request without any filter or other safe guards.
That includes white space and control characters.
HTTP Specifies a custom request method to use when communicating with the HTTP server.
The specified request method is used instead of the method otherwise used (which de-
faults to GET). Read the HTTP 1.1 specification for details and explanations. Common
additional HTTP requests include PUT and DELETE, while related technologies like
WebDAV offers PROPFIND, COPY, MOVE and more.
Normally you do not need this option. All sorts of GET, HEAD, POST and PUT requests
are rather invoked by using dedicated command line options.
This option only changes the actual word used in the HTTP request, it does not alter the
way curl behaves. For example if you want to make a proper HEAD request, using -X
HEAD does not suffice. You need to use the -I, --head option.
The method string you set with -X, --request is used for all requests, which if you for
example use -L, --location may cause unintended side-effects when curl does not
change request method according to the HTTP 30x response codes - and similar.
FTP Specifies a custom FTP command to use instead of LIST when doing file lists with FTP.
POP3 Specifies a custom POP3 command to use instead of LIST or RETR.
Examples:
curl -X "DELETE" https://example.com
curl -X NLST ftp://example.com/
curl passes on the verbatim string you give it in the request without any filter or other safe guards.
That includes white space and control characters.
Example:
curl --request-target "*" -X OPTIONS https://example.com
By specifying "*" as host you can tell curl to resolve any host and specific port pair to the specified
address. Wildcard is resolved last so any --resolve with a specific host and port is used first.
The provided address set by this option is used even if -4, --ipv4 or -6, --ipv6 is set to make
curl use another IP version.
By prefixing the host with a '+' you can make the entry time out after curl's default timeout (1
minute). Note that this only makes sense for long running parallel transfers with a lot of files. In
such cases, if this option is used curl tries to resolve the host as it normally would once the timeout
has expired.
To redirect connects from a specific hostname or any hostname, independently of port number,
consider the --connect-to option.
Support for specifying the host component as an IPv6 address was added in 8.13.0.
Examples:
curl --resolve example.com:443:127.0.0.1 https://example.com
curl --resolve example.com:443:[2001:db8::252f:efd6] https://example.com
When curl is about to retry a transfer, it first waits one second and then for all forthcoming retries
it doubles the waiting time until it reaches 10 minutes, which then remains the set fixed delay time
between the rest of the retries. By using --retry-delay you disable this exponential backoff algo-
rithm. See also --retry-max-time to limit the total time allowed for retries.
curl complies with the Retry-After: response header if one was present to know when to issue the
next retry (added in 7.66.0).
Example:
curl --retry 7 https://example.com
This option is the "sledgehammer" of retrying. Do not use this option by default (for example in
your curlrc), there may be unintended consequences such as sending or receiving duplicate data.
Do not use with redirected input or output. You might be better off handling your unique problems
in a shell script. Please read the example below.
WARNING: For server compatibility curl attempts to retry failed flaky transfers as close as possi-
ble to how they were started, but this is not possible with redirected input or output. For example,
before retrying it removes output data from a failed partial transfer that was written to an output
file. However this is not true of data redirected to a | pipe or > file, which are not reset. We strongly
suggest you do not parse or record output via redirect in combination with this option, since you
may receive duplicate data.
By default curl does not return an error for transfers with an HTTP response code that indicates an
HTTP error, if the transfer was successful. For example, if a server replies 404 Not Found and the
reply is fully received then that is not an error. When --retry is used then curl retries on some
HTTP response codes that indicate transient HTTP errors, but that does not include most 4xx re-
sponse codes such as 404. If you want to retry on all response codes that indicate HTTP errors
(4xx and 5xx) then combine with -f, --fail.
Providing --retry-all-errors multiple times has no extra effect. Disable it again with --no-retry-
all-errors.
Example:
curl --retry 5 --retry-all-errors https://example.com
--retry-connrefused
In addition to the other conditions, consider ECONNREFUSED as a transient error too for
--retry. This option is used together with --retry.
Providing --retry-connrefused multiple times has no extra effect. Disable it again with --no-retry-
connrefused.
Example:
curl --retry-connrefused --retry 7 https://example.com
Example:
curl --retry-delay 5 --retry 7 https://example.com
Example:
curl --retry-max-time 30 --retry 10 https://example.com
If the option is not specified, the server derives the authzid from the authcid, but if specified, and
depending on the server implementation, it may be used to access another user's inbox, that the
user has been granted access to, or a shared mailbox for example.
Example:
curl --sasl-authzid zid imap://example.com/
Providing --sasl-ir multiple times has no extra effect. Disable it again with --no-sasl-ir.
Example:
curl --sasl-ir imap://example.com/
Example:
curl --service-name sockd/server https://example.com
This option is global and does not need to be specified for each use of --next.
Providing --show-error multiple times has no extra effect. Disable it again with --no-show-error.
Example:
curl --show-error --silent https://example.com
This option makes the response headers get saved in the same stream/output as the data. -D,
--dump-header exists to save headers in a separate stream.
Prior to 7.75.0 curl did not print the headers if -f, --fail was used in combination with this option
and there was an error reported by the server.
This option was called --include before 8.10.0. The previous name remains functional.
Providing --show-headers multiple times has no extra effect. Disable it again with --no-show-
headers.
Example:
curl -i https://example.com
An algorithm can use either a signature algorithm and a hash algorithm pair separated by a "+"
(e.g. "ECDSA+SHA224"), or its TLS 1.3 signature scheme name (e.g. "ed25519").
"--sigalgs" allows a OpenSSL powered curl to make SSL-connections with exactly the signature
algorithms requested by the client, avoiding nontransparent client/server negotiations.
If this option is set, the default signature algorithm list built into OpenSSL are ignored.
Example:
curl --sigalgs ecdsa_secp256r1_sha256 https://example.com
Use -S, --show-error in addition to this option to disable progress meter but still show error
messages.
Providing --silent multiple times has no extra effect. Disable it again with --no-silent.
Example:
curl -s https://example.com
Providing --skip-existing multiple times has no extra effect. Disable it again with --no-skip-exist-
ing.
Example:
curl --skip-existing --output local/dir/file https://example.com
Added in 8.10.0. See also -o, --output, -O, --remote-name and --no-clobber.
--socks4 <host[:port]>
Use the specified SOCKS4 proxy. If the port number is not specified, it is assumed at port 1080.
Using this socket type makes curl resolve the hostname and pass the address on to the proxy.
To specify proxy on a Unix domain socket, use localhost for host, e.g. "socks4://local-
host/path/to/socket.sock"
This option overrides any previous use of -x, --proxy, as they are mutually exclusive.
This option is superfluous since you can specify a socks4 proxy with -x, --proxy using a
socks4:// protocol prefix.
--preproxy can be used to specify a SOCKS proxy at the same time proxy is used with an
HTTP/HTTPS proxy. In such a case, curl first connects to the SOCKS proxy and then connects
(through SOCKS) to the HTTP or HTTPS proxy.
Example:
curl --socks4 hostname:4096 https://example.com
To specify proxy on a Unix domain socket, use localhost for host, e.g. "socks4a://local-
host/path/to/socket.sock"
This option overrides any previous use of -x, --proxy, as they are mutually exclusive.
This option is superfluous since you can specify a socks4a proxy with -x, --proxy using a
socks4a:// protocol prefix.
--preproxy can be used to specify a SOCKS proxy at the same time -x, --proxy is used with an
HTTP/HTTPS proxy. In such a case, curl first connects to the SOCKS proxy and then connects
(through SOCKS) to the HTTP or HTTPS proxy.
Example:
curl --socks4a hostname:4096 https://example.com
To specify proxy on a Unix domain socket, use localhost for host, e.g. "socks5://local-
host/path/to/socket.sock"
This option overrides any previous use of -x, --proxy, as they are mutually exclusive.
This option is superfluous since you can specify a socks5 proxy with -x, --proxy using a
socks5:// protocol prefix.
--preproxy can be used to specify a SOCKS proxy at the same time -x, --proxy is used with an
HTTP/HTTPS proxy. In such a case, curl first connects to the SOCKS proxy and then connects
(through SOCKS) to the HTTP or HTTPS proxy.
Example:
curl --socks5 proxy.example:7000 https://example.com
Example:
curl --socks5-basic --socks5 hostname:4096 https://example.com
Providing --socks5-gssapi multiple times has no extra effect. Disable it again with --no-
socks5-gssapi.
Example:
curl --socks5-gssapi --socks5 hostname:4096 https://example.com
Providing --socks5-gssapi-nec multiple times has no extra effect. Disable it again with --no-
socks5-gssapi-nec.
Example:
curl --socks5-gssapi-nec --socks5 hostname:4096 https://example.com
Example:
curl --socks5-gssapi-service sockd --socks5 hostname:4096 https://example.com
To specify proxy on a Unix domain socket, use localhost for host, e.g. "socks5h://local-
host/path/to/socket.sock"
This option overrides any previous use of -x, --proxy, as they are mutually exclusive.
This option is superfluous since you can specify a socks5 hostname proxy with -x, --proxy using
a socks5h:// protocol prefix.
--preproxy can be used to specify a SOCKS proxy at the same time -x, --proxy is used with an
HTTP/HTTPS proxy. In such a case, curl first connects to the SOCKS proxy and then connects
(through SOCKS) to the HTTP or HTTPS proxy.
Example:
curl --socks5-hostname proxy.example:7000 https://example.com
Example:
curl --speed-limit 300 --speed-time 10 https://example.com
This option controls transfers (in both directions) but does not affect slow connects etc. If this is a
concern for you, try the --connect-timeout option.
Example:
curl --speed-limit 300 --speed-time 10 https://example.com
Try to use SSL/TLS for the connection - often referred to as STARTTLS or STLS because of the
involved commands. Reverts to a non-secure connection if the server does not support SSL/TLS.
See also --ftp-ssl-control and --ssl-reqd for different levels of encryption required.
This option is handled in LDAP (added in 7.81.0). It is fully supported by the OpenLDAP backend
and ignored by the generic ldap backend.
Please note that a server may close the connection if the negotiation does not succeed.
This option was formerly known as --ftp-ssl. That option name can still be used but might be re-
moved in a future version.
Providing --ssl multiple times has no extra effect. Disable it again with --no-ssl.
Example:
curl --ssl pop3://example.com/
This option only changes how curl does TLS 1.0 and has no effect on later TLS versions.
WARNING: this option loosens the TLS security, and by using this flag you ask for exactly that.
Providing --ssl-allow-beast multiple times has no extra effect. Disable it again with --no-ssl-al-
low-beast.
Example:
curl --ssl-allow-beast https://example.com
Providing --ssl-auto-client-cert multiple times has no extra effect. Disable it again with --no-ssl-
auto-client-cert.
Example:
curl --ssl-auto-client-cert https://example.com
Providing --ssl-no-revoke multiple times has no extra effect. Disable it again with --no-ssl-no-re-
voke.
Example:
curl --ssl-no-revoke https://example.com
This option is handled in LDAP (added in 7.81.0). It is fully supported by the OpenLDAP backend
and rejected by the generic ldap backend if explicit TLS is required.
This option is unnecessary if you use a URL scheme that in itself implies immediate and implicit
use of TLS, like for FTPS, IMAPS, POP3S, SMTPS and LDAPS. Such a transfer always fails if
the TLS handshake does not work.
Providing --ssl-reqd multiple times has no extra effect. Disable it again with --no-ssl-reqd.
Example:
curl --ssl-reqd ftp://example.com
Providing --ssl-revoke-best-effort multiple times has no extra effect. Disable it again with --no-
ssl-revoke-best-effort.
Example:
curl --ssl-revoke-best-effort https://example.com
The file does not have to exist, but curl reports an error if it is unable to create it. Unused loaded
tickets are saved again, unless they get replaced or purged from the cache for space reasons.
Using a session file allows "--tls-earlydata" to send the first request in "0-RTT" mode, should
an SSL session with the feature be found. Note that a server may not support early data. Also note
that early data does not provide forward secrecy, e.g. is not as secure.
The SSL session tickets are stored as base64 encoded text, each ticket on its own line. The host-
names are cryptographically salted and hashed. While this prevents someone from easily seeing
the hosts you contacted, they could still check if a specific hostname matches one of the values.
Example:
curl --ssl-sessions sessions.txt https://example.com
Example:
curl --sslv2 https://example.com
-2, --sslv2 requires that libcurl is built to support TLS. This option is mutually exclusive with -3,
--sslv3, -1, --tlsv1, --tlsv1.1 and --tlsv1.2. See also --http1.1 and --http2.
-3, --sslv3
(SSL) This option previously asked curl to use SSLv3, but is now ignored (added in 7.77.0).
SSLv3 is widely considered insecure (see RFC 7568).
Example:
curl --sslv3 https://example.com
-3, --sslv3 requires that libcurl is built to support TLS. This option is mutually exclusive with -2,
--sslv2, -1, --tlsv1, --tlsv1.1 and --tlsv1.2. See also --http1.1 and --http2.
--stderr <file>
Redirect all writes to stderr to the specified file instead. If the filename is a plain '-', it is instead
written to stdout.
This option is global and does not need to be specified for each use of --next.
Example:
curl --stderr output.txt https://example.com
Styled output requires a terminal that supports bold fonts. This feature is not present on curl for
Windows due to lack of this capability.
This option is global and does not need to be specified for each use of --next.
Providing --styled-output multiple times has no extra effect. Disable it again with --no-styled-
output.
Example:
curl --styled-output -I https://example.com
Providing --suppress-connect-headers multiple times has no extra effect. Disable it again with
--no-suppress-connect-headers.
Example:
curl --suppress-connect-headers --show-headers -x proxy https://example.com
Providing --tcp-fastopen multiple times has no extra effect. Disable it again with --no-tcp-
fastopen.
Example:
curl --tcp-fastopen https://example.com
curl sets this option by default and you need to explicitly switch it off if you do not want it on.
Providing --tcp-nodelay multiple times has no extra effect. Disable it again with --no-tcp-node-
lay.
Example:
curl --tcp-nodelay https://example.com
Example:
curl -t TTYPE=vt100 telnet://example.com/
Example:
curl --tftp-blksize 1024 tftp://example.com/file
--tftp-no-options
(TFTP) Do not send TFTP options requests. This improves interop with some legacy servers that
do not acknowledge or properly implement TFTP options. When this option is used --tftp-blk-
size is ignored.
Providing --tftp-no-options multiple times has no extra effect. Disable it again with --no-tftp-no-
options.
Example:
curl --tftp-no-options tftp://192.168.0.1/
Start the date expression with a dash (-) to make it request for a document that is older than the
given date/time, default is a document that is newer than the specified date/time.
If provided a non-existing file, curl outputs a warning about that fact and proceeds to do the trans-
fer without a time condition.
Examples:
curl -z "Wed 01 Sep 2021 12:18:00" https://example.com
curl -z "-Wed 01 Sep 2021 12:18:00" https://example.com
curl -z file https://example.com
If a server supports this TLSv1.3 feature, and to what extent, is announced as part of the TLS "ses-
sion" sent back to curl. Until curl has seen such a session in a previous request, early data cannot
be used.
When a new connection is initiated with a known TLSv1.3 session, and that session announced
early data support, the first request on this connection is sent before the TLS handshake is com-
plete. While the early data is also encrypted, it is not protected against replays. An attacker can
send your early data to the server again and the server would accept it.
If your request contacts a public server and only retrieves a file, there may be no harm in that. If
the first request orders a refrigerator for you, it is probably not a good idea to use early data for it.
curl cannot deduce what the security implications of your requests actually are and make this deci-
sion for you.
The amount of early data sent can be inspected by using the "-w, --write-out" variable "tls_ear-
lydata".
WARNING: this option has security implications. See above for more details.
Providing --tls-earlydata multiple times has no extra effect. Disable it again with --no-tls-early-
data.
Example:
curl --tls-earlydata https://example.com
If the connection is done without TLS, this option has no effect. This includes QUIC-using
(HTTP/3) transfers.
default Use up to the recommended TLS version.
1.0 Use up to TLSv1.0.
1.1 Use up to TLSv1.1.
1.2 Use up to TLSv1.2.
1.3 Use up to TLSv1.3.
If --tls-max is provided several times, the last set value is used.
Examples:
curl --tls-max 1.2 https://example.com
curl --tls-max 1.3 --tlsv1.2 https://example.com
--tls-max requires that libcurl is built to support TLS. See also --tlsv1.0, --tlsv1.1, --tlsv1.2
and --tlsv1.3.
--tls13-ciphers <list>
(TLS) Set which cipher suites to use in the connection if it negotiates TLS 1.3. The list of ciphers
suites must specify valid ciphers. Read up on TLS 1.3 cipher suite details on this URL:
https://curl.se/docs/ssl-ciphers.html
This option is used when curl is built to use OpenSSL 1.1.1 or later, wolfSSL, or mbedTLS 3.6.0
or later.
Before curl 8.10.0 with mbedTLS or wolfSSL, TLS 1.3 cipher suites were set by using the --ci-
phers option.
Example:
curl --tls13-ciphers TLS_AES_128_GCM_SHA256 https://example.com
Example:
curl --tlsauthtype SRP https://example.com
Example:
curl --tlspassword pwd --tlsuser user https://example.com
Example:
curl --tlspassword pwd --tlsuser user https://example.com
Example:
curl --tlsv1 https://example.com
-1, --tlsv1 requires that libcurl is built to support TLS. This option is mutually exclusive with
--tlsv1.1, --tlsv1.2 and --tlsv1.3. See also --http1.1 and --http2.
--tlsv1.0
(TLS) Force curl to use TLS version 1.0 or later when connecting to a remote TLS server.
In old versions of curl this option was documented to allow _only_ TLS 1.0. That behavior was
inconsistent depending on the TLS library. Use --tls-max if you want to set a maximum TLS
version.
Example:
curl --tlsv1.0 https://example.com
In old versions of curl this option was documented to allow _only_ TLS 1.1. That behavior was
inconsistent depending on the TLS library. Use --tls-max if you want to set a maximum TLS
version.
Example:
curl --tlsv1.1 https://example.com
In old versions of curl this option was documented to allow _only_ TLS 1.2. That behavior was
inconsistent depending on the TLS library. Use --tls-max if you want to set a maximum TLS
version.
Example:
curl --tlsv1.2 https://example.com
If the connection is done without TLS, this option has no effect. This includes QUIC-using
(HTTP/3) transfers.
Example:
curl --tlsv1.3 https://example.com
Providing --tr-encoding multiple times has no extra effect. Disable it again with --no-tr-encod-
ing.
Example:
curl --tr-encoding https://example.com
--trace <file>
Save a full trace dump of all incoming and outgoing data, including descriptive information, in the
given output file. Use "-" as filename to have the output sent to stdout. Use "%" as filename to
have the output sent to stderr.
Note that verbose output of curl activities and network traffic might contain sensitive data, includ-
ing usernames, credentials or secret data content. Be aware and be careful when sharing trace logs
with others.
This option is global and does not need to be specified for each use of --next.
Example:
curl --trace log.txt https://example.com
This option is mutually exclusive with -v, --verbose and --trace-ascii. See also
--trace-ascii, --trace-config, --trace-ids and --trace-time.
--trace-ascii <file>
Save a full trace dump of all incoming and outgoing data, including descriptive information, in the
given output file. Use "-" as filename to have the output sent to stdout. Use "%" as filename to
send the output to stderr.
This is similar to --trace, but leaves out the hex part and only shows the ASCII part of the dump.
It makes smaller output that might be easier to read for untrained humans.
Note that verbose output of curl activities and network traffic might contain sensitive data, includ-
ing usernames, credentials or secret data content. Be aware and be careful when sharing trace logs
with others.
This option is global and does not need to be specified for each use of --next.
Example:
curl --trace-ascii log.txt https://example.com
This option is mutually exclusive with --trace and -v, --verbose. See also -v, --verbose and
--trace.
--trace-config <string>
Set configuration for trace output. A comma-separated list of components where detailed output
can be made available from. Names are case-insensitive. Specify 'all' to enable all trace compo-
nents.
In addition to trace component names, specify "ids" and "time" to avoid extra --trace-ids or
--trace-time parameters.
This option is global and does not need to be specified for each use of --next.
Example:
This option is global and does not need to be specified for each use of --next.
Providing --trace-ids multiple times has no extra effect. Disable it again with --no-trace-ids.
Example:
curl --trace-ids --trace-ascii output https://example.com
This option is global and does not need to be specified for each use of --next.
Providing --trace-time multiple times has no extra effect. Disable it again with --no-trace-time.
Example:
curl --trace-time --trace-ascii output https://example.com
Example:
curl --unix-socket socket-path https://example.com
If there is no file part in the specified URL, curl appends the local file name to the end of the URL
before the operation starts. You must use a trailing slash (/) on the last directory to prove to curl
that there is no filename or curl thinks that your last directory name is the remote filename to use.
When putting the local filename at the end of the URL, curl ignores what is on the left side of any
slash (/) or backslash (\\) used in the filename and only appends what is on the right side of the
rightmost such character.
Use the filename "-" (a single dash) to use stdin instead of a given file. Alternately, the filename
"." (a single period) may be specified instead of "-" to use stdin in non-blocking mode to allow
reading server output while stdin is being uploaded.
If this option is used with an HTTP(S) URL, the PUT method is used.
You can specify one -T, --upload-file for each URL on the command line. Each -T, --up-
load-file + URL pair specifies what to upload and to where. curl also supports globbing of the -T,
--upload-file argument, meaning that you can upload multiple files to a single URL by using the
same URL globbing style supported in the URL.
When uploading to an SMTP server: the uploaded data is assumed to be RFC 5322 formatted. It
has to feature the necessary set of headers and mail body formatted correctly by the user as curl
does not transcode nor encode it further in any way.
--upload-file is associated with a single URL. Use it once per URL when you use several URLs in
a command line.
Examples:
curl -T file https://example.com
curl -T "img[1-1000].png" ftp://ftp.example.com/
curl --upload-file "{file1,file2}" https://example.com
curl -T file -T file2 https://example.com https://example.com
See also -G, --get, -I, --head, -X, --request and -d, --data.
--upload-flags <flags>
Specify additional behavior to apply to uploaded files. Flags are specified as either a single flag
value or a comma-separated list of flag values. These values are case-sensitive and may be
negated by prepending them with a '-' character. Currently the following flag values are accepted:
answered, deleted, draft, flagged, and seen. The currently-accepted flag values are used to set flags
on IMAP uploads.
Example:
curl --upload-flags Flagged,!Seen --upload-file local/dir/file https://example.com
If the given URL is missing a scheme (such as "http://" or "ftp://" etc) curl guesses which scheme
to use based on the hostname. If the outermost subdomain name matches DICT, FTP, IMAP,
LDAP, POP3 or SMTP case insensitively, then that protocol is used, otherwise it assumes HTTP.
Scheme guessing can be avoided by providing a full URL including the scheme, or disabled by
setting a default protocol, see --proto-default for details.
To control where the contents of a retrieved URL is written instead of the default stdout, use the
-o, --output or the -O, --remote-name options. When retrieving multiple URLs in a single in-
voke, each provided URL needs its own dedicated destination option unless --remote-name-all
is used.
On Windows, "file://" accesses can be converted to network accesses by the operating system.
Starting in curl 8.13.0, curl can be told to download URLs provided in a text file, one URL per
line. It is done with "--url @filename": so instead of a URL, you specify a filename prefixed with
the "@" symbol. It can be told to load the list of URLs from stdin by providing an argument like
"@-".
When downloading URLs given in a file, it implies using -O, --remote-name for each provided
URL. The URLs are full, there is no globbing applied or done on these. Features such as
--skip-existing work fine in combination with this.
Lines in the URL file that start with "#" are treated as comments and are skipped.
Examples:
curl --url https://example.com
curl --url @file
If the argument starts with a '+' (plus), the rest of the string is provided as-is unencoded.
The query part of a URL is the one following the question mark on the right end.
Examples:
curl --url-query name=val https://example.com
curl --url-query =encodethis http://example.net/foo
curl --url-query name@file https://example.com
curl --url-query @fileonly https://example.com
curl --url-query "+name=%20foo" https://example.com
Providing --use-ascii multiple times has no extra effect. Disable it again with --no-use-ascii.
Example:
curl -B ftp://example.com/README
The username and passwords are split up on the first colon, which makes it impossible to use a
colon in the username with this option. The password can, still.
On systems where it works, curl hides the given option argument from process listings. This is not
enough to protect credentials from possibly getting seen by other users on the same system as they
still are visible for a moment before being cleared. Such sensitive data should be retrieved from a
file instead or similar and never used in clear text in a command line.
When using Kerberos V5 with a Windows based server you should include the Windows domain
name in the username, in order for the server to successfully obtain a Kerberos Ticket. If you do
When using NTLM, the username can be specified simply as the username, without the domain, if
there is a single domain and forest in your setup for example.
To specify the domain name use either Down-Level Logon Name or UPN (User Principal Name)
formats. For example, EXAMPLE\user and [email protected] respectively.
If you use a Windows SSPI-enabled curl binary and perform Kerberos V5, Negotiate, NTLM or
Digest authentication then you can tell curl to select the username and password from your envi-
ronment by specifying a single colon with this option: "-u :".
Example:
curl -u user:secret https://example.com
If you give an empty argument to -A, --user-agent (""), it removes the header completely from
the request. If you prefer a blank header, you can set it to a single space (" ").
Example:
curl -A "Agent 007" https://example.com
Setting the same variable name again overwrites the old contents with the new.
The contents of a variable can be referenced in a later command line option when that option name
is prefixed with "--expand-", and the name is used as "{{name}}".
--variable can import environment variables into the name space. Opt to either require the envi-
ronment variable to be set or provide a default value for the variable in case it is not already set.
--variable %name imports the variable called "name" but exits with an error if that environment
variable is not already set. To provide a default value if the environment variable is not set, use
--variable %name=content or --variable %name@content. Note that on some systems - but
not all - environment variables are case insensitive.
Added in curl 8.12.0: you can get a byte range from the source by appending "[start-end]" to the
variable name, where start and end are byte offsets to include from the contents. For example,
asking for offset "2-10" means offset two to offset ten, inclusive, resulting in 9 bytes in total.
"2-2" means a single byte at offset 2. Not providing a second number implies to the end of data.
The start offset cannot be larger than the end offset. Asking for a range that is outside of the file
size makes the variable contents empty. For example, getting the first one hundred bytes from a
given file:
Given a byte range that has no data results in an empty string. Asking for a range that is larger than
the content makes curl use the piece of the data that exists.
To assign a variable using contents from another variable, use --expand-variable. Like for exam-
ple assigning a new variable using contents from two other:
When expanding variables, curl supports a set of functions that can make the variable contents
more convenient to use. You apply a function to a variable expansion by adding a colon and then
list the desired functions in a comma-separated list that is evaluated in a left-to-right order. Vari-
able content holding null bytes that are not encoded when expanded causes an error.
Available functions:
trim removes all leading and trailing white space.
Example:
Example:
Example:
Example:
Example:
(Added in 8.13.0)
--variable can be used several times in a command line
Example:
curl --variable name=smith --expand-url "https://example.com/{{name}}"
If you only want HTTP headers in the output, -i, --show-headers or -D, --dump-header
might be more suitable options.
Since curl 8.10, mentioning this option several times in the same argument increases the level of
the trace output. However, as before, a single -v, --verbose or --no-verbose reverts any addi-
tions by previous "-vv" again. This means that "-vv -v" is equivalent to a single -v. This avoids
unwanted verbosity when the option is mentioned in the command line and curl config files.
Using it twice, e.g. "-vv", outputs time (--trace-time) and transfer ids (--trace-ids), as well as
enabling tracing for all protocols (--trace-config protocol).
Adding a third verbose outputs transfer content (--trace-ascii %) and enables tracing of more
components (--trace-config read,write,ssl).
If you think this option does not give you the right details, consider using --trace or
--trace-ascii instead. Or use it only once and use --trace-config to trace the specific compo-
nents you wish to see.
Note that verbose output of curl activities and network traffic might contain sensitive data, includ-
ing usernames, credentials or secret data content. Be aware and be careful when sharing trace logs
with others.
When the output contains protocol headers, those lines might include carriage return (ASCII code
13) characters, even on platforms that otherwise normally only use linefeed to signify line separa-
tions - as curl shows the exact contents arriving from the server.
This option is global and does not need to be specified for each use of --next.
Providing --verbose multiple times has no extra effect. Disable it again with --no-verbose.
Example:
curl --verbose https://example.com
This option is mutually exclusive with --trace and --trace-ascii. See also -i, --show-head-
ers, -s, --silent, --trace and --trace-ascii.
-V, --version
Display information about curl and the libcurl version it uses.
The first line includes the full version of curl, libcurl and other 3rd party libraries linked with the
executable.
This line may contain one or more TLS libraries. curl can be built to support more than one TLS
library which then makes curl - at start-up - select which particular backend to use for this invo-
cation.
If curl supports more than one TLS library like this, the ones that are not selected by default are
listed within parentheses. Thus, if you do not specify which backend to use (with the
"CURL_SSL_BACKEND" environment variable) the one listed without parentheses is used. Such
builds also have "MultiSSL" set as a feature.
The second line (starts with "Release-Date:") shows the release date.
The third line (starts with "Protocols:") shows all protocols that libcurl reports to support.
The fourth line (starts with "Features:") shows specific features libcurl reports to offer. Available
features include:
alt-svc Support for the Alt-Svc: header is provided.
AsynchDNS
This curl uses asynchronous name resolves. Asynchronous name resolves can be done us-
ing either the c-ares or the threaded resolver backends.
brotli Support for automatic brotli compression over HTTP(S).
CharConv
curl was built with support for character set conversions (like EBCDIC)
Debug This curl uses a libcurl built with Debug. This enables more error-tracking and memory
debugging etc. For curl-developers only.
ECH ECH support is present.
gsasl The built-in SASL authentication includes extensions to support SCRAM because libcurl
was built with libgsasl.
GSS-API
GSS-API is supported.
HSTS HSTS support is present.
HTTP2 HTTP/2 support has been built-in.
HTTP3 HTTP/3 support has been built-in.
HTTPS-proxy
This curl is built to support HTTPS proxy.
IDN This curl supports IDN - international domain names.
IPv6 You can use IPv6 with this.
Kerberos
Kerberos V5 authentication is supported.
Largefile
This curl supports transfers of large files, files larger than 2GB.
libz Automatic decompression (via gzip, deflate) of compressed files over HTTP is supported.
MultiSSL
This curl supports multiple TLS backends.
NTLM NTLM authentication is supported.
NTLM_WB
NTLM delegation to winbind helper is supported. This feature was removed from curl in
8.8.0.
PSL PSL is short for Public Suffix List and means that this curl has been built with knowledge
about "public suffixes".
SPNEGO
SPNEGO authentication is supported.
SSL SSL versions of various protocols are supported, such as HTTPS, FTPS, POP3S and so
on.
SSLS-EXPORT
This build supports TLS session export/import, like with the --ssl-sessions.
SSPI SSPI is supported.
TLS-SRP
SRP (Secure Remote Password) authentication is supported for TLS.
TrackMemory
Debug memory tracking is supported.
Unicode
Unicode support on Windows.
UnixSockets
Unix sockets support is provided.
zstd Automatic decompression (via zstd) of compressed files over HTTP is supported.
Example:
curl --version
This field is set on Ethernet level, and only works within a local network.
Example:
curl --vlan-priority 4 https://example.com
The variables present in the output format are substituted by the value or text that curl thinks fit, as
described below. All variables are specified as %{variable_name} and to output a normal % you
just write them as %%. You can output a newline by using \n, a carriage return with \r and a tab
space with \t.
The output is by default written to standard output, but can be changed with %{stderr} and %out-
put{}.
Output HTTP header values from the transfer's most recent server response by using
%header{name} where name is the case insensitive name of the header (without the trailing
colon). The header contents are exactly as delivered over the network but with leading and trailing
whitespace and newlines stripped off (added in 7.84.0).
Select a specific target destination file to write the output to, by using %output{name} (added in
curl 8.3.0) where name is the full filename. The output following that instruction is then written to
that file. More than one %output{} instruction can be specified in the same write-out argument. If
the filename cannot be created, curl leaves the output destination to the one used prior to the %out-
put{} instruction. Use %output{>>name} to append data to an existing file.
This output is done independently of if the file transfer was successful or not.
If the specified action or output specified with this option fails in any way, it does not make curl
return a (different) error.
NOTE: On Windows, the %-symbol is a special symbol used to expand environment variables. In
batch files, all occurrences of % must be doubled when using this option to properly escape. If this
option is used at the command prompt then the % cannot be escaped and unintended expansion is
possible.
ftp_entry_path
The initial path curl ended up in when logging on to the remote FTP server.
header{name}
The value of header "name" from the transfer's most recent server response. Unlike other
variables, the variable name "header" is not in braces. For example "%header{date}". Re-
fer to -w, --write-out remarks. (Added in 7.84.0)
header_json
A JSON object with all HTTP response headers from the recent transfer. Values are pro-
vided as arrays, since in the case of multiple headers there can be multiple values. (Added
in 7.83.0)
The header names provided in lowercase, listed in order of appearance over the wire. Ex-
cept for duplicated headers. They are grouped on the first occurrence of that header, each
value is presented in the JSON array.
http_code
The numerical response code that was found in the last retrieved HTTP(S) or FTP(s)
transfer.
http_connect
The numerical code that was found in the last response (from a proxy) to a curl CON-
NECT request.
http_version
The http version that was effectively used.
json A JSON object with all available keys. (Added in 7.70.0)
local_ip
The IP address of the local end of the most recently done connection - can be either IPv4
or IPv6.
local_port
The local port number of the most recently done connection.
method The http method used in the most recent HTTP request. (Added in 7.72.0)
num_certs
Number of server certificates received in the TLS handshake. Supported only by the
OpenSSL, GnuTLS, Schannel, Rustls and Secure Transport backends. (Added in 7.88.0)
num_connects
Number of new connects made in the recent transfer.
num_headers
The number of response headers in the most recent request (restarted at each redirect).
Note that the status line IS NOT a header. (Added in 7.73.0)
num_redirects
Number of redirects that were followed in the request.
num_retries
Number of retries actually performed when "--retry" has been used. (Added in 8.9.0)
onerror The rest of the output is only shown if the transfer returned a non-zero error. (Added in
7.75.0)
output{filename}
From this point on, the -w, --write-out output is written to the filename specified in
braces. The filename can be prefixed with ">>" to append to the file. Unlike other vari-
ables, the variable name "output" is not in braces. For example "%output{>>stats.txt}".
Refer to -w, --write-out remarks. (Added in 8.3.0)
proxy_ssl_verify_result
The result of the HTTPS proxy's SSL peer certificate verification that was requested. 0
means the verification was successful.
proxy_used
Returns 1 if the previous transfer used a proxy, otherwise 0. Useful to for example deter-
mine if a "NOPROXY" pattern matched the hostname or not. (Added in 8.7.0)
redirect_url
When an HTTP request was made without -L, --location to follow redirects (or when
--max-redirs is met), this variable shows the actual URL a redirect would have gone to.
time_queue
The time, in seconds, the transfer was queued during its run. This adds the queue time for
each redirect step that may have happened. Transfers may be queued for significant
amounts of time when connection or parallel limits are in place. (Added in 8.12.0)
time_redirect
The time, in seconds, it took for all redirection steps including name lookup, connect,
pretransfer and transfer before the final transaction was started. "time_redirect" shows the
complete execution time for multiple redirections.
time_starttransfer
The time, in seconds, it took from the start until the first byte was received. This includes
time_pretransfer and also the time the server needed to calculate the result.
time_total
The total time, in seconds, that the full operation lasted.
tls_earlydata
The amount of bytes that were sent as TLSv1.3 early data. This is 0 if this TLS feature
was not used and negative if the data sent had been rejected by the server. The use of
early data is enabled via the command line option "--tls-earlydata". (Added in 8.12.0)
url The URL that was fetched. (Added in 7.75.0)
url.scheme
The scheme part of the URL that was fetched. (Added in 8.1.0)
url.user The user part of the URL that was fetched. (Added in 8.1.0)
url.password
The password part of the URL that was fetched. (Added in 8.1.0)
url.options
The options part of the URL that was fetched. (Added in 8.1.0)
url.host The host part of the URL that was fetched. (Added in 8.1.0)
url.port The port number of the URL that was fetched. If no port number was specified and the
URL scheme is known, that scheme's default port number is shown. (Added in 8.1.0)
url.path The path part of the URL that was fetched. (Added in 8.1.0)
url.query
The query part of the URL that was fetched. (Added in 8.1.0)
url.fragment
The fragment part of the URL that was fetched. (Added in 8.1.0)
url.zoneid
The zone id part of the URL that was fetched. (Added in 8.1.0)
urle.scheme
The scheme part of the effective (last) URL that was fetched. (Added in 8.1.0)
urle.user
The user part of the effective (last) URL that was fetched. (Added in 8.1.0)
urle.password
The password part of the effective (last) URL that was fetched. (Added in 8.1.0)
urle.options
The options part of the effective (last) URL that was fetched. (Added in 8.1.0)
urle.host
The host part of the effective (last) URL that was fetched. (Added in 8.1.0)
urle.port
The port number of the effective (last) URL that was fetched. If no port number was spec-
ified, but the URL scheme is known, that scheme's default port number is shown. (Added
in 8.1.0)
urle.path
The path part of the effective (last) URL that was fetched. (Added in 8.1.0)
urle.query
The query part of the effective (last) URL that was fetched. (Added in 8.1.0)
urle.fragment
The fragment part of the effective (last) URL that was fetched. (Added in 8.1.0)
urle.zoneid
The zone id part of the effective (last) URL that was fetched. (Added in 8.1.0)
urlnum The URL index number of this transfer, 0-indexed. Unglobbed URLs share the same in-
dex number as the origin globbed URL. (Added in 7.75.0)
url_effective
The URL that was fetched last. This is most meaningful if you have told curl to follow lo-
cation: headers.
xfer_id The numerical identifier of the last transfer done. -1 if no transfer has been started yet for
the handle. The transfer id is unique among all transfers performed using the same con-
nection cache. (Added in 8.2.0)
If --write-out is provided several times, the last set value is used.
Example:
curl -w ’%{response_code}\n’ https://example.com
When saving output to a file, tell curl to store file metadata in extended file attributes. Currently,
"curl" is stored in the "creator" attribute, the URL is stored in the "xdg.origin.url" attribute and, for
HTTP, the content type is stored in the "mime_type" attribute. If the file system does not support
extended attributes, a warning is issued.
Providing --xattr multiple times has no extra effect. Disable it again with --no-xattr.
Example:
curl --xattr -o storage https://example.com
Using an environment variable to set the proxy has the same effect as using the -x, --proxy option.
http_proxy [protocol://]<host>[:port]
Sets the proxy server to use for HTTP.
HTTPS_PROXY [protocol://]<host>[:port]
Sets the proxy server to use for HTTPS.
[url-protocol]_PROXY [protocol://]<host>[:port]
Sets the proxy server to use for [url-protocol], where the protocol is a protocol that curl supports
and as specified in a URL. FTP, FTPS, POP3, IMAP, SMTP, LDAP, etc.
ALL_PROXY [protocol://]<host>[:port]
Sets the proxy server to use if no protocol-specific proxy is set.
NO_PROXY <comma-separated list of hosts/domains>
list of hostnames that should not go through any proxy. If set to an asterisk '*' only, it matches all
hosts. Each name in this list is matched as either a domain name which contains the hostname, or
the hostname itself.
This environment variable disables use of the proxy even when specified with the -x, --proxy op-
tion. That is
The list of hostnames can also include numerical IP addresses, and IPv6 versions should then be
given without enclosing brackets.
IP addresses can be specified using CIDR notation: an appended slash and number specifies the
number of "network bits" out of the address to use in the comparison (added in 7.86.0). For exam-
ple "192.168.0.0/16" would match all addresses starting with "192.168".
APPDATA <dir>
On Windows, this variable is used when trying to find the home directory. If the primary home
variables are all unset.
COLUMNS <terminal width>
If set, the specified number of characters is used as the terminal width when the alternative
progress-bar is shown. If not set, curl tries to figure it out using other ways.
CURL_CA_BUNDLE <file>
If set, it is used as the --cacert value. This environment variable is ignored if Schannel is used as
the TLS backend.
CURL_HOME <dir>
If set, is the first variable curl checks when trying to find its home directory. If not set, it continues
to check XDG_CONFIG_HOME
CURL_SSL_BACKEND <TLS backend>
If curl was built with support for "MultiSSL", meaning that it has built-in support for more than
one TLS backend, this environment variable can be set to the case insensitive name of the particu-
lar backend to use when curl is invoked. Setting a name that is not a built-in alternative makes curl
stay with the default.
SSL backend names (case-insensitive): bearssl, gnutls, mbedtls, openssl, rustls, schannel, se-
cure-transport, wolfssl
HOME <dir>
If set, this is used to find the home directory when that is needed. Like when looking for the de-
fault .curlrc. CURL_HOME and XDG_CONFIG_HOME have preference.
QLOGDIR <directory name>
If curl was built with HTTP/3 support, setting this environment variable to a local directory makes
curl produce qlogs in that directory, using file names named after the destination connection id (in
hex). Do note that these files can become rather large. Works with the ngtcp2 and quiche QUIC
backends.
SHELL
Used on VMS when trying to detect if using a DCL or a Unix shell.
SSL_CERT_DIR <dir>
If set, it is used as the --capath value. This environment variable is ignored if Schannel is used as
the TLS backend.
SSL_CERT_FILE <path>
If set, it is used as the --cacert value. This environment variable is ignored if Schannel is used as
the TLS backend.
SSLKEYLOGFILE <filename>
If you set this environment variable to a filename, curl stores TLS secrets from its connections in
that file when invoked to enable you to analyze the TLS traffic in real time using network analyz-
ing tools such as Wireshark. This works with the following TLS backends: OpenSSL, LibreSSL
(TLS 1.2 max), BoringSSL, GnuTLS, wolfSSL and Rustls.
USERPROFILE <dir>
On Windows, this variable is used when trying to find the home directory. If the other, primary,
variables are all unset. If set, curl uses the path "$USERPROFILE\Application Data".
XDG_CONFIG_HOME <dir>
If CURL_HOME is not set, this variable is checked when looking for a default .curlrc file.
PROXY PROTOCOL PREFIXES
The proxy string may be specified with a protocol:// prefix to specify alternative proxy protocols.
If no protocol is specified in the proxy string or if the string does not match a supported one, the proxy is
treated as an HTTP proxy.