Remarks

These APIs allow to manage the domain objects of InfluxDB (such as buckets, sources, tasks, authorizations). The APIs are constructed with InfluxDB instance that is populated with InfluxDB server parameters. All API operations return Promise of response data, the majority of them relies upon simple exchange of JSON data. For example:

...
const {InfluxDB} = require('@influxdata/influxdb-client')
const {OrgsAPI} = require('@influxdata/influxdb-client-apis')
const influxDB = new InfluxDB({
  url: "http://localhost:8086", 
  token: "my-token"
})
...
async function getOrg() {
  const orgsAPI = new OrgsAPI(influxDB)
  const organizations = await orgsAPI.getOrgs({
    org: "my-org"
  })
  ...
}
...
Copy

Generated APIs that write or query InfluxDB are also herein, but it is recommended to use @influxdata/influxdb-client!WriteApi and @influxdata/influxdb-client!QueryApi from @influxdata/influxdb-client, they are much easier to use and offer specialized features (write failover, line protocol serialization, flux results parsing, ...).

See also examples to know more.