InfluxDB v2.0 Docs

Influx API Service (0.1.0)

Download OpenAPI specification:Download

Authentication

BasicAuth

Security scheme type:HTTP
HTTP Authorization Schemebasic

Exchange basic auth credentials for session

Authorizations:
header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

204

Successfully authenticated

401

Unauthorized access

403

user account is disabled

default

Unsuccessful authentication

post /signin
/api/v2/signin

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "code": "internal error",
  • "message": "string"
}

Expire the current session

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

204

Session successfully expired

401

Unauthorized access

default

Unsuccessful session expiry

post /signout
/api/v2/signout

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "code": "internal error",
  • "message": "string"
}

Map of all top level routes available

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

default

All routes

get /
/api/v2/

Response samples

Content type
application/json
Copy
Expand all Collapse all
{}

Setup

Check if database has default user, org, bucket

Returns true if no default user, organization, or bucket has been created.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

200

allowed true or false

get /setup
/api/v2/setup

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "allowed": true
}

Set up initial user, org and bucket

Post an onboarding request to set up initial user, org and bucket.

header Parameters
Zap-Trace-Span
string
Example: