Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

CURLOPT_NOBODY (3)

Name

CURLOPT_NOBODY - do the download request without getting the body

Synopsis

#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_NOBODY, long opt);

Description

CURLOPT_NOBODY(3)          curl_easy_setopt options          CURLOPT_NOBODY(3)



NAME
       CURLOPT_NOBODY - do the download request without getting the body

SYNOPSIS
       #include <curl/curl.h>

       CURLcode curl_easy_setopt(CURL *handle, CURLOPT_NOBODY, long opt);

DESCRIPTION
       A long parameter set to 1 tells libcurl to not include the body-part in
       the output when doing what would otherwise be a download. For  HTTP(S),
       this makes libcurl do a HEAD request. For most other protocols it means
       just not asking to transfer the body data.

       For HTTP operations when CURLOPT_NOBODY(3) has been set, unsetting  the
       option  (with 0) will make it a GET again - only if the method is still
       set to be HEAD. The proper way to get back to a GET request is  to  set
       CURLOPT_HTTPGET(3)  and  for  other  methods,  use  the  POST or UPLOAD
       options.

       Enabling CURLOPT_NOBODY(3) means asking for a download without a body.

       If you do a transfer with HTTP that involves a method other than  HEAD,
       you  will  get a body (unless the resource and server sends a zero byte
       body for the specific URL you request).

DEFAULT
       0, the body is transferred

PROTOCOLS
       Most

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

         /* get us the resource without a body - use HEAD! */
         curl_easy_setopt(curl, CURLOPT_NOBODY, 1L);

         /* Perform the request */
         curl_easy_perform(curl);
       }

AVAILABILITY
       Always

RETURN VALUE
       Returns CURLE_OK


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


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | web/curl         |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+

SEE ALSO
       CURLOPT_HTTPGET(3),  CURLOPT_POSTFIELDS(3),   CURLOPT_UPLOAD(3),   CUR-
       LOPT_REQUEST_TARGET(3), CURLOPT_MIMEPOST(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_NOBODY(3)