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 Legacy Authorizations API

The Legacy Authorizations API from InfluxDB — 3 operation(s) for legacy authorizations.

InfluxDB Legacy Authorizations 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 Legacy Authorizations. 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 6 operations across 3 paths, and defines 9 schemas. It is described by OpenAPI 3.0.0.

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

6 operations 3 paths 9 schemas 1 DELETE2 GET1 PATCH2 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 Legacy Authorizations 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 6

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

Legacy Authorizations 6
GET
/legacy/authorizations
List all legacy authorizations
GetLegacyAuthorizations 7 params → 200default
POST
/legacy/authorizations
Create a legacy authorization
PostLegacyAuthorizations 1 param body → 201400401default
DELETE
/legacy/authorizations/{authID}
Delete a legacy authorization
DeleteLegacyAuthorizationsID 2 params → 204default
GET
/legacy/authorizations/{authID}
Retrieve a legacy authorization
GetLegacyAuthorizationsID 2 params → 200default
PATCH
/legacy/authorizations/{authID}
Update a legacy authorization to be active or inactive
PatchLegacyAuthorizationsID 2 params body → 200default
POST
/legacy/authorizations/{authID}/password
Set a legacy authorization password
PostLegacyAuthorizationsIDPassword 2 params body → 204default

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are Resource (5 properties), Error (4 properties), Links (3 properties), AuthorizationUpdateRequest (2 properties). Each schema is shown below with its type and property counts.

Permission
object
2 properties 2 required
Links
object
URI pointers for additional paged results.
3 properties 1 required
Resource
object
5 properties 1 required
Authorization
2 required
Link
string
URI of resource.
LegacyAuthorizationPostRequest
2 required
ErrorCode
string
code is the machine-readable error code.
AuthorizationUpdateRequest
object
2 properties
Error
object
4 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

influxdb-legacy-authorizations-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