curl / libcurl / API / curl_easy_setopt / CURLOPT_REQUEST_TARGET

CURLOPT_REQUEST_TARGET explained

Name

CURLOPT_REQUEST_TARGET - alternative target for this request

Synopsis

#include <curl/curl.h>
 
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_REQUEST_TARGET, string);

Description

Pass a char pointer to string which libcurl uses in the upcoming request instead of the path as extracted from the URL.

libcurl passes on the verbatim string in its request without any filter or other safe guards. That includes white space and control characters.

Using this option multiple times makes the last set string override the previous ones. Set it to NULL to disable its use again.

The application does not have to keep the string around after setting this option.

Default

NULL

Protocols

This functionality affects http only

Example

int main(void)
{
  CURL *curl = curl_easy_init();
  if(curl) {
    curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/*");
    curl_easy_setopt(curl, CURLOPT_CUSTOMREQUEST, "OPTIONS");
 
    /* issue an OPTIONS * request (no leading slash) */
    curl_easy_setopt(curl, CURLOPT_REQUEST_TARGET, "*");
 
    /* Perform the request */
    curl_easy_perform(curl);
  }
}

Availability

Added in curl 7.55.0

Return value

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