Artifactspublic-v0

curl

master
ply4 git calls35 ms289 KiB3 cachedprotocol v2
133 lines4.0 KiBRaw

NAME

CURLOPT_POSTFIELDS - data to POST to server

SYNOPSIS

c
#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_POSTFIELDS, char *postdata);

DESCRIPTION

Pass a char pointer as parameter, pointing to the data buffer to use in an HTTP POST operation or an MQTT subscribe. The data must be formatted and encoded the way you want the server to receive it. libcurl does not convert or encode it in any way. For example, a web server may assume that this data is URL encoded.

The data pointed to is NOT copied by the library: as a consequence, it must be preserved by the calling application until the associated transfer finishes. This behavior can be changed (so libcurl does copy the data) by instead using the CURLOPT_COPYPOSTFIELDS(3) option.

This POST is a normal application/x-www-form-urlencoded kind (and libcurl sets that Content-Type by default when this option is used), which is commonly used by HTML forms. Change Content-Type with CURLOPT_HTTPHEADER(3).

You can use curl_easy_escape(3) to URL encode your data, if necessary. It returns a pointer to an encoded string that can be passed as postdata.

Using CURLOPT_POSTFIELDS(3) implies setting CURLOPT_POST(3) to 1.

If CURLOPT_POSTFIELDS(3) is explicitly set to NULL then libcurl gets the POST data from the read callback. To send a zero-length (empty) POST, set CURLOPT_POSTFIELDS(3) to an empty string, or set CURLOPT_POST(3) to 1 and CURLOPT_POSTFIELDSIZE(3) to 0.

libcurl assumes this option points to a null-terminated string unless you also set CURLOPT_POSTFIELDSIZE(3) to specify the length of the provided data, which then is strictly required if you want to send off null bytes included in the data.

Using POST with HTTP 1.1 implies the use of a "Expect: 100-continue" header, and libcurl adds that header automatically if the POST is either known to be larger than 1MB or if the expected size is unknown. You can disable this header with CURLOPT_HTTPHEADER(3) as usual.

To make multipart/formdata posts, check out the CURLOPT_MIMEPOST(3) option combined with curl_mime_init(3).

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

DEFAULT

NULL

%PROTOCOLS%

EXAMPLE

c
/* send an application/x-www-form-urlencoded POST */
int main(void)
{
  CURLcode result = CURLE_OK;
  CURL *curl = curl_easy_init();
  if(curl) {
    static const char *data = "data to send";

    curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");

    /* size of the POST data if strlen() is not good enough */
    curl_easy_setopt(curl, CURLOPT_POSTFIELDSIZE, 12L);

    /* pass in a pointer to the data - libcurl does not copy */
    curl_easy_setopt(curl, CURLOPT_POSTFIELDS, data);

    result = curl_easy_perform(curl);
    curl_easy_cleanup(curl);
  }

  /* send an application/json POST */
  curl = curl_easy_init();
  if(curl) {
    static const char *json = "{\"name\": \"daniel\"}";
    struct curl_slist *slist1 = NULL;
    slist1 = curl_slist_append(slist1, "Content-Type: application/json");
    slist1 = curl_slist_append(slist1, "Accept: application/json");

    /* set custom headers */
    curl_easy_setopt(curl, CURLOPT_HTTPHEADER, slist1);

    curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");

    /* pass in a pointer to the data - libcurl does not copy */
    curl_easy_setopt(curl, CURLOPT_POSTFIELDS, json);

    result = curl_easy_perform(curl);
    curl_easy_cleanup(curl);
  }
}

%AVAILABILITY%

RETURN VALUE

curl_easy_setopt(3) returns a CURLcode indicating success or error.

CURLE_OK (0) means everything was OK, non-zero means an error occurred, see libcurl-errors(3).

1---
2c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
3SPDX-License-Identifier: curl
4Title: CURLOPT_POSTFIELDS
5Section: 3
6Source: libcurl
7See-also:
8 - CURLOPT_COPYPOSTFIELDS (3)
9 - CURLOPT_MIMEPOST (3)
10 - CURLOPT_POSTFIELDSIZE (3)
11 - CURLOPT_READFUNCTION (3)
12 - CURLOPT_UPLOAD (3)
13Protocol:
14 - HTTP
15 - MQTT
16Added-in: 7.1
17---
19# NAME
21CURLOPT_POSTFIELDS - data to POST to server
23# SYNOPSIS
25~~~c
26#include <curl/curl.h>
28CURLcode curl_easy_setopt(CURL *handle, CURLOPT_POSTFIELDS, char *postdata);
29~~~
31# DESCRIPTION
33Pass a char pointer as parameter, pointing to the data buffer to use in an
34HTTP POST operation or an MQTT subscribe. The data must be formatted and
35encoded the way you want the server to receive it. libcurl does not convert or
36encode it in any way. For example, a web server may assume that this data is
37URL encoded.
39The data pointed to is NOT copied by the library: as a consequence, it must be
40preserved by the calling application until the associated transfer finishes.
41This behavior can be changed (so libcurl does copy the data) by instead using
42the CURLOPT_COPYPOSTFIELDS(3) option.
44This POST is a normal **application/x-www-form-urlencoded** kind (and libcurl
45sets that Content-Type by default when this option is used), which is commonly
46used by HTML forms. Change Content-Type with CURLOPT_HTTPHEADER(3).
48You can use curl_easy_escape(3) to URL encode your data, if
49necessary. It returns a pointer to an encoded string that can be passed as
50*postdata*.
52Using CURLOPT_POSTFIELDS(3) implies setting CURLOPT_POST(3) to 1.
54If CURLOPT_POSTFIELDS(3) is explicitly set to NULL then libcurl gets the POST
55data from the read callback. To send a zero-length (empty) POST, set
56CURLOPT_POSTFIELDS(3) to an empty string, or set CURLOPT_POST(3) to 1 and
57CURLOPT_POSTFIELDSIZE(3) to 0.
59libcurl assumes this option points to a null-terminated string unless you also
60set CURLOPT_POSTFIELDSIZE(3) to specify the length of the provided data, which
61then is strictly required if you want to send off null bytes included in the
62data.
64Using POST with HTTP 1.1 implies the use of a "Expect: 100-continue" header,
65and libcurl adds that header automatically if the POST is either known to be
66larger than 1MB or if the expected size is unknown. You can disable this
67header with CURLOPT_HTTPHEADER(3) as usual.
69To make **multipart/formdata** posts, check out the
70CURLOPT_MIMEPOST(3) option combined with curl_mime_init(3).
72Using this option multiple times makes the last set pointer override the
73previous ones. Set it to NULL to disable its use again.
75# DEFAULT
77NULL
79# %PROTOCOLS%
81# EXAMPLE
83~~~c
84/* send an application/x-www-form-urlencoded POST */
85int main(void)
87 CURLcode result = CURLE_OK;
88 CURL *curl = curl_easy_init();
89 if(curl) {
90 static const char *data = "data to send";
92 curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
94 /* size of the POST data if strlen() is not good enough */
95 curl_easy_setopt(curl, CURLOPT_POSTFIELDSIZE, 12L);
97 /* pass in a pointer to the data - libcurl does not copy */
98 curl_easy_setopt(curl, CURLOPT_POSTFIELDS, data);
100 result = curl_easy_perform(curl);
101 curl_easy_cleanup(curl);
102 }
104 /* send an application/json POST */
105 curl = curl_easy_init();
106 if(curl) {
107 static const char *json = "{\"name\": \"daniel\"}";
108 struct curl_slist *slist1 = NULL;
109 slist1 = curl_slist_append(slist1, "Content-Type: application/json");
110 slist1 = curl_slist_append(slist1, "Accept: application/json");
112 /* set custom headers */
113 curl_easy_setopt(curl, CURLOPT_HTTPHEADER, slist1);
115 curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
117 /* pass in a pointer to the data - libcurl does not copy */
118 curl_easy_setopt(curl, CURLOPT_POSTFIELDS, json);
120 result = curl_easy_perform(curl);
121 curl_easy_cleanup(curl);
122 }
124~~~
126# %AVAILABILITY%
128# RETURN VALUE
130curl_easy_setopt(3) returns a CURLcode indicating success or error.
132CURLE_OK (0) means everything was OK, non-zero means an error occurred, see
133libcurl-errors(3).
Diagnostics4 git calls · 35 ms
CallStatusSizeTime035 ms
discover200152 B3 ms
git.upload-pack discover
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=2
git.response.bytes=152
git.server.agent=gitty/1.0
git.server.object_format=sha1
git.server.caps=agent ls-refs fetch object-format
git.server.fetch=shallow filter sideband-all
git.protocol.version=2
git.pkt.frames=8
git.pkt.data=6
git.pkt.flush=2
git.pkt.delim=0
git.pkt.bytes=152
git.pkt.payload.max=34
ls-refs200149 B · hit3 ms
git.upload-pack ls-refs
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=ls-refs
git.upstream.dur_ms=3
git.response.bytes=149
git.response.cache=HIT
git.response.duration_ms=3
git.protocol.version=2
git.pkt.frames=3
git.pkt.data=2
git.pkt.flush=1
git.pkt.delim=0
git.pkt.bytes=149
git.pkt.payload.max=78
git.ls_refs.count=2
git.ls_refs.head=refs/heads/master
fetchblob:none · deepen 10200287 KiB · hit4 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=28
git.response.bytes=293470
git.response.cache=HIT
git.response.duration_ms=4
git.fetch.filter=blob:none
git.fetch.filter.requested=tree:0
git.fetch.filter.fallback=blob:none
git.fetch.filter.learned=false
git.fetch.wants=31c911efe5652725e930f4d2e60c9060e5f6646d
git.fetch.haves.count=0
git.fetch.deepen=10
git.fetch.thin_pack=false
git.fetch.ofs_delta=true
git.protocol.version=2
git.pkt.frames=10
git.pkt.data=8
git.pkt.flush=1
git.pkt.delim=1
git.pkt.bytes=293470
git.pkt.payload.max=65516
git.sideband.band1.bytes=293354
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=87
git.pack.bytes=293354
git.pack.ofs_delta=0
git.pack.ref_delta=1
git.pack.chain.max=1
git.pack.trailer=6a646bcda6740bab42e321b51998b52ea15146c0
git.pack.full=86
Open pack map
fetch2001.8 KiB · hit28 ms
git.upload-pack fetch
http.response.status_code=200
git.response.bytes=1837
git.response.cache=HIT
git.response.duration_ms=28
git.fetch.wants=49d955966a3f9cde83c0f34369684dbd71005e5c
git.fetch.haves.count=0
git.fetch.deepen=0
git.fetch.thin_pack=false
git.fetch.ofs_delta=true
git.protocol.version=2
git.pkt.frames=3
git.pkt.data=2
git.pkt.flush=1
git.pkt.delim=0
git.pkt.bytes=1837
git.pkt.payload.max=1816
git.sideband.band1.bytes=1815
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0

Each row is one HTTP round trip ply made to the git server for this page, on one timeline. discover asks what the server speaks, ls-refs lists branch tips, fetch brings objects by id. A hit was served by Workers Cache. Tap a row for its wire details.

Remote
https://5ad2236b39de4c8bd8f6270ea63f3ea9.artifacts.cloudflare.net/git/public-v0/curl.git
Ref
refs/heads/master
Commit
31c911efe5652725e930f4d2e60c9060e5f6646d
cf-ray
a5e36dd00874e88e
Request
72792b8c…
Protocol
v2 · sha1
Agent
gitty/1.0
Filter
advertised
Fetch
shallow filter sideband-all
Capabilities
agent ls-refs fetch object-format