Documentation

influxdb.api() function

influxdb.api() is experimental and subject to change at any time.

influxdb.api() submits an HTTP request to the specified InfluxDB API path and returns a record containing the HTTP status code, response headers, and the response body.

Note: influxdb.api() uses the authorization of the specified token or, if executed from the InfluxDB UI, the authorization of the InfluxDB user that invokes the script. Authorization permissions and limits apply to each request.

Response format

influxdb.api() returns a record with the following properties:

  • statusCode: HTTP status code returned by the GET request (int).
  • headers: HTTP response headers (dict).
  • body: HTTP response body (bytes).
Function type signature
(
    method: string,
    path: string,
    ?body: bytes,
    ?headers: [string:string],
    ?host: string,
    ?query: [string:string],
    ?timeout: duration,
    ?token: string,
) => {statusCode: int, headers: [string:string], body: bytes}
  • Copy
  • Fill window

For more information, see Function type signatures.

Parameters

method

(Required) HTTP request method.

path

(Required) InfluxDB API path.

host

InfluxDB host URL (Required when executed outside of InfluxDB). Default is "".

token

InfluxDB API token (Required when executed outside of InfluxDB). Default is "".

headers

HTTP request headers.

query

URL query parameters.

timeout

HTTP request timeout. Default is 30s.

body

HTTP request body as bytes.

Examples

Retrieve the health of an InfluxDB OSS instance

import "experimental/influxdb"
import "influxdata/influxdb/secrets"

token = secrets.get(key: "INFLUX_TOKEN")

response = influxdb.api(method: "get", path: "/health", host: "http://localhost:8086", token: token)

string(v: response.body)
  • Copy
  • Fill window

Create a bucket through the InfluxDB Cloud API

import "experimental/influxdb"
import "json"
import "influxdata/influxdb/secrets"

token = secrets.get(key: "INFLUX_TOKEN")

influxdb.api(
    method: "post",
    path: "/api/v2/buckets",
    host: "https://us-west-2-1.aws.cloud2.influxdata.com",
    token: token,
    body:
        json.encode(
            v: {
                name: "example-bucket",
                description: "This is an example bucket.",
                orgID: "x000X0x0xx0X00x0",
                retentionRules: [],
            },
        ),
)
  • Copy
  • Fill window

Was this page helpful?

Thank you for your feedback!


The future of Flux

Flux is going into maintenance mode. You can continue using it as you currently are without any changes to your code.

Read more

Now Generally Available

InfluxDB 3 Core and Enterprise

Start fast. Scale faster.

Get the Updates

InfluxDB 3 Core is an open source, high-speed, recent-data engine that collects and processes data in real-time and persists it to local disk or object storage. InfluxDB 3 Enterprise builds on Core’s foundation, adding high availability, read replicas, enhanced security, and data compaction for faster queries and optimized storage. A free tier of InfluxDB 3 Enterprise is available for non-commercial at-home or hobbyist use.

For more information, check out: