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

title	description	menu	weight	flux/v0/tags
http.get() function	`http.get()` submits an HTTP GET request to the specified URL and returns the HTTP status code, response body, and response headers.	flux_v0_ref name parent identifier http.get experimental/http experimental/http/get	201	http inputs

http.get() submits an HTTP GET request to the specified URL and returns the HTTP status code, response body, and response headers.

{{% warn %}}

Deprecated

Experimental http.get() is deprecated in favor of requests.get(). {{% /warn %}}

Response format

http.get() returns a record with the following properties:

• statusCode: HTTP status code returned by the GET request (int).
• body: HTTP response body (bytes).
• headers: HTTP response headers (record).

Function type signature

(url: string, ?headers: A, ?timeout: duration) => {statusCode: int, headers: B, body: bytes} where A: Record, B: Record

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

Parameters

url

({{< req >}}) URL to send the GET request to.

headers

Headers to include with the GET request.

timeout

Timeout for the GET request. Default is 30s.

Examples

Get the status of an InfluxDB OSS instance

import "experimental/http"

http.get(
    url: "http://localhost:8086/health",
    headers: {Authorization: "Token mY5up3RS3crE7t0k3N", Accept: "application/json"},
)