2024-03-15 20:55:33 -06:00
|
|
|
.\" generated by cd2nroff 0.1 from CURLOPT_POSTREDIR.md
|
2024-07-29 18:00:04 -06:00
|
|
|
.TH CURLOPT_POSTREDIR 3 "2024-07-29" libcurl
|
2024-03-15 20:55:33 -06:00
|
|
|
.SH NAME
|
|
|
|
|
CURLOPT_POSTREDIR \- how to act on an HTTP POST redirect
|
|
|
|
|
.SH SYNOPSIS
|
|
|
|
|
.nf
|
|
|
|
|
#include <curl/curl.h>
|
|
|
|
|
|
|
|
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_POSTREDIR,
|
|
|
|
|
long bitmask);
|
|
|
|
|
.fi
|
|
|
|
|
.SH DESCRIPTION
|
|
|
|
|
Pass a bitmask to control how libcurl acts on redirects after POSTs that get a
|
|
|
|
|
301, 302 or 303 response back. A parameter with bit 0 set (value
|
|
|
|
|
\fBCURL_REDIR_POST_301\fP) tells the library to respect RFC 7231 (section
|
|
|
|
|
6.4.2 to 6.4.4) and not convert POST requests into GET requests when following
|
|
|
|
|
a 301 redirection. Setting bit 1 (value \fBCURL_REDIR_POST_302\fP) makes
|
|
|
|
|
libcurl maintain the request method after a 302 redirect whilst setting bit 2
|
|
|
|
|
(value \fBCURL_REDIR_POST_303\fP) makes libcurl maintain the request method
|
|
|
|
|
after a 303 redirect. The value \fBCURL_REDIR_POST_ALL\fP is a convenience
|
|
|
|
|
define that sets all three bits.
|
|
|
|
|
|
|
|
|
|
The non\-RFC behavior is ubiquitous in web browsers, so the library does the
|
|
|
|
|
conversion by default to maintain consistency. However, a server may require a
|
|
|
|
|
POST to remain a POST after such a redirection. This option is meaningful only
|
|
|
|
|
when setting \fICURLOPT_FOLLOWLOCATION(3)\fP.
|
|
|
|
|
.SH DEFAULT
|
|
|
|
|
0
|
|
|
|
|
.SH PROTOCOLS
|
2024-07-29 18:00:04 -06:00
|
|
|
This functionality affects http only
|
2024-03-15 20:55:33 -06:00
|
|
|
.SH EXAMPLE
|
|
|
|
|
.nf
|
|
|
|
|
int main(void)
|
|
|
|
|
{
|
|
|
|
|
CURL *curl = curl_easy_init();
|
|
|
|
|
if(curl) {
|
|
|
|
|
curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
|
|
|
|
|
|
|
|
|
|
/* a silly POST example */
|
|
|
|
|
curl_easy_setopt(curl, CURLOPT_POSTFIELDS, "data=true");
|
|
|
|
|
|
|
|
|
|
/* example.com is redirected, so we tell libcurl to send POST on 301,
|
|
|
|
|
302 and 303 HTTP response codes */
|
|
|
|
|
curl_easy_setopt(curl, CURLOPT_POSTREDIR, CURL_REDIR_POST_ALL);
|
|
|
|
|
|
|
|
|
|
curl_easy_perform(curl);
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
.fi
|
2024-07-29 18:00:04 -06:00
|
|
|
.SH HISTORY
|
|
|
|
|
This option was known as CURLOPT_POST301 up to 7.19.0 as it only supported the
|
|
|
|
|
301 then. CURL_REDIR_POST_303 was added in 7.26.0.
|
2024-03-15 20:55:33 -06:00
|
|
|
.SH AVAILABILITY
|
2024-07-29 18:00:04 -06:00
|
|
|
Added in curl 7.19.1
|
2024-03-15 20:55:33 -06:00
|
|
|
.SH RETURN VALUE
|
|
|
|
|
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
|
|
|
|
|
.SH SEE ALSO
|
|
|
|
|
.BR CURLINFO_EFFECTIVE_METHOD (3),
|
|
|
|
|
.BR CURLINFO_REDIRECT_COUNT (3),
|
|
|
|
|
.BR CURLOPT_FOLLOWLOCATION (3),
|
|
|
|
|
.BR CURLOPT_MAXREDIRS (3),
|
|
|
|
|
.BR CURLOPT_POSTFIELDS (3)
|
