docs-v2/content/flux/v0/stdlib/experimental/http/requests/post.md

title	description	menu	weight	flux/v0/tags
requests.post() function	`requests.post()` makes a http POST request. This identical to calling `request.do(method: "POST", ...)`.	flux_v0_ref name parent identifier requests.post experimental/http/requests experimental/http/requests/post	301	http inputs

requests.post() makes a http POST request. This identical to calling request.do(method: "POST", ...).

{{% warn %}}

Deprecated

Experimental requests.post is deprecated in favor of requests.post. {{% /warn %}}

Function type signature

(
    url: string,
    ?body: bytes,
    ?config: {A with timeout: duration, insecureSkipVerify: bool},
    ?headers: [string:string],
    ?params: [string:[string]],
) => {statusCode: int, headers: [string:string], duration: duration, body: bytes}

{{% caption %}} For more information, see Function type signatures. {{% /caption %}}

Parameters

url

({{< req >}}) URL to request. This should not include any query parameters.

params

Set of key value pairs to add to the URL as query parameters. Query parameters will be URL encoded. All values for a key will be appended to the query.

headers

Set of key values pairs to include on the request.

body

Data to send with the request.

config

Set of options to control how the request should be performed.

Examples

Make a POST request with a JSON body and decode JSON response

import "experimental/http/requests"
import ejson "experimental/json"
import "json"
import "array"

response =
    requests.post(
        url: "https://goolnk.com/api/v1/shorten",
        body: json.encode(v: {url: "http://www.influxdata.com"}),
        headers: ["Content-Type": "application/json"],
    )

data = ejson.parse(data: response.body)

array.from(rows: [data])

{{< expand-wrapper >}} {{% expand "View example output" %}}

Output data

result_url
https://goolnk.com/BnXAE6

{{% /expand %}} {{< /expand-wrapper >}}