Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

CURLOPT_FOLLOWLOCATION (3)

Name

CURLOPT_FOLLOWLOCATION - follow HTTP 3xx redirects

Synopsis

#include <curl/curl.h>

CURLcode  curl_easy_setopt(CURL  *handle,  CURLOPT_FOLLOWLOCATION, long
enable);

Description

CURLOPT_FOLLOWLOCATION(3)  curl_easy_setopt options  CURLOPT_FOLLOWLOCATION(3)



NAME
       CURLOPT_FOLLOWLOCATION - follow HTTP 3xx redirects

SYNOPSIS
       #include <curl/curl.h>

       CURLcode  curl_easy_setopt(CURL  *handle,  CURLOPT_FOLLOWLOCATION, long
       enable);

DESCRIPTION
       A long parameter set to 1 tells the library  to  follow  any  Location:
       header  that  the  server  sends  as  part  of  an HTTP header in a 3xx
       response. The Location: header can specify a relative  or  an  absolute
       URL to follow.

       libcurl will issue another request for the new URL and follow new Loca-
       tion: headers all the way until no  more  such  headers  are  returned.
       CURLOPT_MAXREDIRS(3)  can  be  used  to  limit  the number of redirects
       libcurl will follow.

       libcurl limits what protocols it automatically follows to. The accepted
       protocols  are  set with CURLOPT_REDIR_PROTOCOLS(3). By default libcurl
       will allow all protocols on redirect except those disabled for security
       reasons:  Since  7.19.4 FILE and SCP are disabled, and since 7.40.0 SMB
       and SMBS are also disabled.

       When following a Location:, the 3xx response code  that  redirected  it
       also  dictates  which  request  method  it  will  use in the subsequent
       request: For 301, 302 and 303 responses libcurl will switch  method  to
       GET  unless CURLOPT_POSTREDIR(3) instructs libcurl otherwise. All other
       3xx codes will make libcurl send the same method again.

       For users who think the existing location following is too  naive,  too
       simple  or  just  lacks  features, it is very easy to instead implement
       your own redirect follow logic with the use  of  curl_easy_getinfo(3)'s
       CURLINFO_REDIRECT_URL(3)  option  instead  of using CURLOPT_FOLLOWLOCA-
       TION(3).

DEFAULT
       0, disabled

PROTOCOLS
       HTTP(S)

EXAMPLE
       CURL *curl = curl_easy_init();
       if(curl) {
         curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");

         /* example.com is redirected, so we tell libcurl to follow redirection */
         curl_easy_setopt(curl, CURLOPT_FOLLOWLOCATION, 1L);

         curl_easy_perform(curl);
       }

AVAILABILITY
       Along with HTTP

RETURN VALUE
       Returns CURLE_OK if HTTP 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_REDIR_PROTOCOLS(3), CURLOPT_PROTOCOLS(3), CURLOPT_POSTREDIR(3),
       CURLINFO_REDIRECT_URL(3), CURLINFO_REDIRECT_COUNT(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                    17 Jun 2014        CURLOPT_FOLLOWLOCATION(3)