Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

CURLOPT_PROXYHEADER (3)

Name

CURLOPT_PROXYHEADER - custom HTTP headers to pass to proxy

Synopsis

#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXYHEADER,
struct curl_slist *headers);

Description

CURLOPT_PROXYHEADER(3)     curl_easy_setopt options     CURLOPT_PROXYHEADER(3)



NAME
       CURLOPT_PROXYHEADER - custom HTTP headers to pass to proxy

SYNOPSIS
       #include <curl/curl.h>

       CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXYHEADER,
                                 struct curl_slist *headers);

DESCRIPTION
       Pass  a  pointer  to a linked list of HTTP headers to pass in your HTTP
       request sent to a proxy. The rules for this list is  identical  to  the
       CURLOPT_HTTPHEADER(3) option's.

       The  headers set with this option is only ever used in requests sent to
       a proxy - when there's also a request sent to a host.

       The first line in a request (containing the method, usually  a  GET  or
       POST)  is  NOT  a header and cannot be replaced using this option. Only
       the lines following the request-line are headers.  Adding  this  method
       line  in  this  list of headers will only cause your request to send an
       invalid header.

       Pass a NULL to this to reset back to no custom headers.

DEFAULT
       NULL

PROTOCOLS
       HTTP

EXAMPLE
       CURL *curl = curl_easy_init();

       struct curl_slist *list;

       if(curl) {
         curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
         curl_easy_setopt(curl, CURLOPT_PROXY, "http://proxy.example.com:80");

         list = curl_slist_append(NULL, "Shoesize: 10");
         list = curl_slist_append(list, "Accept:");

         curl_easy_setopt(curl, CURLOPT_PROXYHEADER, list);

         curl_easy_perform(curl);

         curl_slist_free_all(list); /* free the list again */
       }

AVAILABILITY
       Added in 7.37.0

RETURN VALUE
       Returns CURLE_OK if the option is supported,  and  CURLE_UNKNOWN_OPTION
       if not.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | web/curl         |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+
SEE ALSO
       CURLOPT_HEADEROPT(3), CURLOPT_HTTPHEADER(3),



NOTES
       This     software     was    built    from    source    available    at
       https://github.com/oracle/solaris-userland.   The  original   community
       source    was    downloaded    from    https://github.com/curl/curl/ar-
       chive/curl-7_64_0.zip

       Further information about this software can be found on the open source
       community website at http://curl.haxx.se/.



libcurl 7.37.0                    19 Jun 2014           CURLOPT_PROXYHEADER(3)