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.

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

Parameters

url

(Required) 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: "https://cloud2.influxdata.com/health",
    headers: {Authorization: "Token mY5up3RS3crE7t0k3N", Accept: "application/json"},
)