Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

InfluxDB Setup API

The Setup API from InfluxDB — 2 operation(s) for setup.

InfluxDB Setup API is one of 40 APIs that InfluxDB publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Setup. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, authentication docs, and a getting-started guide.

This API exposes 3 operations across 2 paths, and defines 19 schemas. It is described by OpenAPI 3.0.0.

Requests are made against the base URL https://cloud2.influxdata.com/api/v2.

3 operations 2 paths 19 schemas 1 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
Base URL
https://cloud2.influxdata.com/api/v2
Authentication
HTTP Basic, API Key
Resource Areas
1

Authentication & Security 2

InfluxDB Setup API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (BasicAuthentication). An API key is passed in the header as Authorization (TokenAuthentication). By default, every request must be authenticated.

  • BasicAuthentication — Basic authentication scheme Use the HTTP Basic authentication scheme for InfluxDB /api/v2 API operations that support it: Syntax Authorization: Basic BASE64ENC…
  • TokenAuthentication — Use the [Token authentication](section/Authentication/TokenAuthentication) scheme to authenticate to the InfluxDB API. In your API requests, send an Authorizat…

Paths & Operations 3

Across 2 paths, the API surfaces 3 operations — 1 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Setup 3
GET
/api/v2/setup
Retrieve setup status
GetSetup 1 param → 200
POST
/api/v2/setup
Create an initial user, organization, and bucket
PostSetup 1 param body → 201default
POST
/api/v2/setup/user
Create a new user, organization, and bucket
PostSetupUser body → 201default

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are Limit (12 properties), Bucket (12 properties), Organization (8 properties), OnboardingRequest (7 properties). Each schema is shown below with its type and property counts.

IsOnboarding
object
1 property
Resource
object
5 properties 1 required
Link
string
URI of resource.
ErrorCode
string
code is the machine-readable error code.
RetentionRule
object
3 properties 1 required
UserResponse
object
4 properties 1 required
SchemaType
string
Limit
object
These are org limits similar to those configured in/by quartz.
12 properties 7 required
Label
object
4 properties
Labels
array
Error
object
4 properties 1 required
RetentionRules
array
Retention rules to expire or retain data. The InfluxDB /api/v2 API uses RetentionRules to configure the [retention period](https://docs.influxdata.com/influxdb…
OnboardingResponse
object
4 properties
AuthorizationUpdateRequest
object
2 properties
Bucket
object
12 properties 2 required
Permission
object
2 properties 2 required
OnboardingRequest
object
7 properties 3 required
Authorization
2 required
Organization
object
8 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

influxdb-setup-api-openapi.yml Raw ↑

Other APIs InfluxDB publishes across the network.

InfluxDB Authorizations (API tokens) API
InfluxDB Bucket Schemas API
InfluxDB Buckets API
InfluxDB Cells API
InfluxDB Checks API
InfluxDB Config API
InfluxDB Dashboards API
InfluxDB Data I/O endpoints API
InfluxDB DBRPs API
InfluxDB Delete API
InfluxDB Invokable Scripts API
InfluxDB Labels API