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

InfluxData Setup API

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

InfluxData Setup API is one of 45 APIs that InfluxData publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 3 operations across 2 paths, and defines 18 schemas. It is described by OpenAPI 3.0.0, at version 2.0.1.

Requests are made against a single base URL, /api/v2.

3 operations 2 paths 18 schemas 1 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2.0.1
Base URL
https://us-east-1-1.aws.cloud2.influxdata.com/api/v2
Authentication
API Key, HTTP Basic
License
Resource Areas
1

Authentication & Security 2

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

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

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
/setup
Retrieve setup status
GetSetup 1 param → 200
POST
/setup
Create an initial user, organization, and bucket
PostSetup 1 param body → 201default
POST
/setup/user
Create a new user, organization, and bucket
PostSetupUser body → 201default

Schemas 18

The contract defines 18 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.

RetentionRule
object
3 properties 1 required
Permission
object
2 properties 2 required
IsOnboarding
object
1 property
Bucket
object
12 properties 2 required
Link
string
URI of resource.
OnboardingResponse
object
4 properties
AuthorizationUpdateRequest
object
2 properties
SchemaType
string
Label
object
4 properties
Authorization
2 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…
Labels
array
UserResponse
object
4 properties 1 required
OnboardingRequest
object
7 properties 3 required
Organization
object
8 properties 1 required
Resource
object
5 properties 1 required
Limit
object
These are org limits similar to those configured in/by quartz.
12 properties 7 required
Error
object
4 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

influxdata-setup-api-openapi.yml Raw ↑

Other APIs InfluxData publishes across the network.

InfluxData Authorizations (API tokens) API
InfluxData Backup API
InfluxData Bucket Schemas API
InfluxData Buckets API
InfluxData Cells API
InfluxData Checks API
InfluxData Config API
InfluxData Dashboards API
InfluxData Data I/O endpoints API
InfluxData DBRPs API
InfluxData Debug API
InfluxData Delete API