CURLOPT_USERAGENT - agent header
#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_USERAGENT, char *ua);
CURLOPT_USERAGENT(3) curl_easy_setopt options CURLOPT_USERAGENT(3)
NAME
CURLOPT_USERAGENT - HTTP user-agent header
SYNOPSIS
#include <curl/curl.h>
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_USERAGENT, char *ua);
DESCRIPTION
Pass a pointer to a null-terminated string as parameter. It will be
used to set the User-Agent: header in the HTTP request sent to the
remote server. This can be used to fool servers or scripts. You can
also set any custom header with CURLOPT_HTTPHEADER(3).
The application does not have to keep the string around after setting
this option.
DEFAULT
NULL, no User-Agent: header is used by default.
PROTOCOLS
HTTP, HTTPS
EXAMPLE
CURL *curl = curl_easy_init();
if(curl) {
curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
curl_easy_setopt(curl, CURLOPT_USERAGENT, "Dark Secret Ninja/1.0");
curl_easy_perform(curl);
}
AVAILABILITY
As long as HTTP is supported
RETURN VALUE
Returns CURLE_OK if HTTP is supported, CURLE_UNKNOWN_OPTION if not, or
CURLE_OUT_OF_MEMORY if there was insufficient heap space.
ATTRIBUTES
See attributes(7) for descriptions of the following attributes:
+---------------+------------------+
|ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+---------------+------------------+
|Availability | web/curl |
+---------------+------------------+
|Stability | Uncommitted |
+---------------+------------------+
SEE ALSO
CURLOPT_REFERER(3), CURLOPT_HTTPHEADER(3),
NOTES
Source code for open source software components in Oracle Solaris can
be found at https://www.oracle.com/downloads/opensource/solaris-source-
code-downloads.html.
This software was built from source available at
https://github.com/oracle/solaris-userland. The original community
source was downloaded from https://curl.se/down-
load/curl-7.83.1.tar.bz2.
Further information about this software can be found on the open source
community website at http://curl.haxx.se/.
libcurl 7.83.1 November 26, 2021 CURLOPT_USERAGENT(3)