requests.do() function
requests.do() is experimental and subject to change at any time.
requests.do() makes an http request.
Deprecated
Experimental requests.do is deprecated in favor of requests.do.
The returned response contains the following properties:
- statusCode: HTTP status code returned from the request.
- body: Contents of the request. A maximum size of 100MB will be read from the response body.
- headers: Headers present on the response.
- duration: Duration of request.
Function type signature
(
method: string,
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}
For more information, see Function type signatures.
Parameters
method
(Required) method of the http request. Supported methods: DELETE, GET, HEAD, PATCH, POST, PUT.
url
(Required) 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 GET request
- Make a GET request that needs authorization
- Make a GET request with query parameters
Make a GET request
import "experimental/http/requests"
response = requests.do(url: "http://example.com", method: "GET")
requests.peek(response: response)
Make a GET request that needs authorization
import "experimental/http/requests"
import "influxdata/influxdb/secrets"
token = secrets.get(key: "TOKEN")
response =
requests.do(
method: "GET",
url: "http://example.com",
headers: ["Authorization": "token ${token}"],
)
requests.peek(response: response)
Make a GET request with query parameters
import "experimental/http/requests"
response = requests.do(method: "GET", url: "http://example.com", params: ["start": ["100"]])
requests.peek(response: response)
Was this page helpful?
Thank you for your feedback!
Support and feedback
Thank you for being part of our community! We welcome and encourage your feedback and bug reports for Flux and this documentation. To find support, use the following resources:
Customers with an annual or support contract can contact InfluxData Support. Customers using a trial license can email trial@influxdata.com for assistance.