InfluxDB Organizations API
Manage your [organization](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#organization).An organization is a workspace for a group of users. Organizations can beused to separate different environments, projects, teams or users withinInfluxDB.Use the `/api/v2/orgs` endpoints to view and manage organizations.
InfluxDB Organizations 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 Organizations. 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 11 operations across 6 paths, and defines 14 schemas. It is described by OpenAPI 3.0.0.
Requests are made against the base URL https://cloud2.influxdata.com/api/v2.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
InfluxDB Organizations 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 11
Across 6 paths, the API surfaces 11 operations — 3 DELETE, 4 GET, 1 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.
Manage your [organization](https://docs.influxdata.com/influxdb/cloud/reference/glossary/organization). An organization is a workspace for a group of users. Organizations can be u…
Schemas 14
The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are Organization (8 properties), Error (4 properties), UserResponse (4 properties), Links (3 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from InfluxDB 12
Other APIs InfluxDB publishes across the network.