Documentation

http.get() function

http.get() is experimental and subject to change at any time.

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

Deprecated

http.get() is deprecated in favor of requests.get().

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
For more information, see Function type signatures.

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: "http://localhost:8086/health",
    headers: {Authorization: "Token mY5up3RS3crE7t0k3N", Accept: "application/json"},
)

Was this page helpful?

Thank you for your feedback!


Upgrade to InfluxDB Cloud or InfluxDB 2.0!

InfluxDB Cloud and InfluxDB OSS 2.0 ready for production.