Merge remote-tracking branch 'origin/api-docs-uplift' into clean-squash
# Conflicts: # api-docs/scripts/generate-openapi-articles.tsclean-squash
Jason Stirnaman
commit
83800428e6
|
|
@ -3,7 +3,7 @@ plugins:
|
|||
extends:
|
||||
- recommended
|
||||
- docs/all
|
||||
x-influxdata-product-name: InfluxDB 3 Serverless
|
||||
x-influxdata-product-name: InfluxDB Cloud Serverless
|
||||
|
||||
apis:
|
||||
data@2:
|
||||
|
|
|
|||
|
|
@ -1,13 +1,34 @@
|
|||
title: InfluxDB 3 Cloud Serverless API Service
|
||||
x-influxdata-short-title: v2 API
|
||||
x-influxdata-short-description: The InfluxDB v2 HTTP API for InfluxDB 3 Cloud Serverless provides a programmatic interface for writing data stored in an InfluxDB 3 Cloud Serverless bucket.
|
||||
title: InfluxDB Cloud Serverless HTTP API
|
||||
x-influxdata-short-title: HTTP API
|
||||
x-influxdata-short-description: The InfluxDB HTTP API provides a programmatic interface for writing, querying, and managing data stored in InfluxDB Cloud Serverless (powered by the InfluxDB 3 storage engine).
|
||||
description: |
|
||||
The InfluxDB v2 HTTP API for InfluxDB 3 Cloud Serverless provides a programmatic interface for writing data stored in an InfluxDB 3 Cloud Serverless bucket.
|
||||
The InfluxDB HTTP API provides a programmatic interface for writing, querying, and managing data stored in InfluxDB Cloud Serverless (powered by the InfluxDB 3 storage engine).
|
||||
|
||||
The InfluxDB v2 HTTP API lets you use `/api/v2` endpoints for managing retention policy mappings and writing data stored in an InfluxDB 3 instance.
|
||||
Access the InfluxDB HTTP API using the `/api/v2/` or InfluxDB v1 endpoints.
|
||||
|
||||
This documentation is generated from the
|
||||
[InfluxDB OpenAPI specification](https://raw.githubusercontent.com/influxdata/openapi/master/contracts/ref/cloud.yml).
|
||||
### InfluxDB v2-compatible endpoints
|
||||
|
||||
InfluxDB v2-compatible endpoints work with InfluxDB Cloud Serverless and with InfluxDB 2.x client libraries and third-party integrations.
|
||||
|
||||
The following v2-compatible endpoints are supported for Cloud Serverless:
|
||||
|
||||
- `/api/v2/write` — write data
|
||||
- `/api/v2/authorizations` — manage API tokens
|
||||
- `/api/v2/buckets` — manage buckets
|
||||
- `/api/v2/orgs` — manage organizations
|
||||
|
||||
### InfluxDB v1-compatible endpoints
|
||||
|
||||
InfluxDB v1-compatible endpoints work with InfluxDB Cloud Serverless and with InfluxDB 1.x client libraries and third-party integrations.
|
||||
|
||||
- `/write` — write data
|
||||
- `/query` — query data with InfluxQL
|
||||
|
||||
### Other endpoints
|
||||
|
||||
Other endpoints in this reference are for the InfluxDB Cloud (TSM) API.
|
||||
These endpoints may be accessible but are not supported or recommended for use with InfluxDB Cloud Serverless, which is powered by the InfluxDB 3 storage engine.
|
||||
For Cloud Serverless-specific functionality, see the [InfluxDB Cloud Serverless documentation](https://docs.influxdata.com/influxdb3/cloud-serverless/).
|
||||
license:
|
||||
name: MIT
|
||||
url: 'https://opensource.org/licenses/MIT'
|
||||
|
|
|
|||
File diff suppressed because it is too large
Load Diff
|
|
@ -2,36 +2,54 @@ tags:
|
|||
API compatibility:
|
||||
x-traitTag: true
|
||||
description: |
|
||||
InfluxDB Cloud Serverless supports a subset of the InfluxDB v2 API.
|
||||
Other endpoints in this reference are for the InfluxDB Cloud (TSM) API —
|
||||
they may be accessible, but are not supported or recommended for use with
|
||||
InfluxDB Cloud Serverless, which is powered by the InfluxDB 3 storage engine.
|
||||
|
||||
### Write data
|
||||
|
||||
InfluxDB 3 Cloud Serverless provides the following HTTP API endpoints for writing data:
|
||||
InfluxDB Cloud Serverless provides the following HTTP API endpoints for writing data:
|
||||
|
||||
- **Recommended**: [`/api/v2/write` endpoint](#operation/PostWrite)
|
||||
for new write workloads or for bringing existing InfluxDB v2 write workloads to InfluxDB 3.
|
||||
- [`/write` endpoint](#operation/PostLegacyWrite) for bringing existing InfluxDB v1 write workloads to InfluxDB 3.
|
||||
- **Recommended**: `/api/v2/write` endpoint
|
||||
for new write workloads or for bringing existing InfluxDB v2 write workloads.
|
||||
- `/write` endpoint for bringing existing InfluxDB v1 write workloads.
|
||||
|
||||
Both endpoints accept the same line protocol format and process data in the same way.
|
||||
Both endpoints accept line protocol format and process data in the same way.
|
||||
|
||||
### Query data
|
||||
|
||||
InfluxDB 3 Cloud Serverless provides the following protocols for executing a query:
|
||||
InfluxDB Cloud Serverless provides the following protocols for executing a query:
|
||||
|
||||
- **Recommended**: _Flight+gRPC_ request that contains an SQL or InfluxQL query.
|
||||
- HTTP API [`/query` request](#operation/GetLegacyQuery) that contains an InfluxQL query.
|
||||
Use this protocol when bringing existing InfluxDB v1 query workloads to InfluxDB 3.
|
||||
- HTTP API `/query` request that contains an InfluxQL query.
|
||||
Use this endpoint when bringing existing InfluxDB v1 query workloads.
|
||||
|
||||
### Management endpoints
|
||||
|
||||
Use the following endpoints to manage Cloud Serverless resources:
|
||||
|
||||
- API tokens (authorizations) — create and manage API tokens
|
||||
- Buckets — create and manage storage buckets
|
||||
- Organizations — view and manage organizations
|
||||
- Accounts — manage account information
|
||||
|
||||
### InfluxDB v2 compatibility
|
||||
|
||||
The HTTP API [`/api/v2/write` endpoint](#operation/PostWrite) works with the [`Token` authentication scheme](#section/Authentication/TokenAuthentication) and existing InfluxDB 2.x tools and code.
|
||||
The `/api/v2/write` endpoint works with the Token authentication scheme and existing InfluxDB 2.x tools and code.
|
||||
|
||||
### InfluxDB v1 compatibility
|
||||
|
||||
The HTTP API [`/write` endpoint](#operation/PostLegacyWrite) and [`/query` endpoint](#operation/GetLegacyQuery) work with InfluxDB 1.x username/password [authentication schemes](#section/Authentication/) and existing InfluxDB 1.x tools and code.
|
||||
The `/write` and `/query` endpoints work with InfluxDB 1.x username/password authentication and existing InfluxDB 1.x tools and code.
|
||||
x-related:
|
||||
- title: Get started querying InfluxDB
|
||||
href: /influxdb3/cloud-serverless/get-started/query/
|
||||
- title: Write data
|
||||
href: /influxdb3/cloud-serverless/write-data/
|
||||
- title: Get started querying InfluxDB
|
||||
href: /influxdb3/cloud-serverless/get-started/query/
|
||||
- title: Manage API tokens
|
||||
href: /influxdb3/cloud-serverless/security/tokens/
|
||||
- title: Manage buckets
|
||||
href: /influxdb3/cloud-serverless/admin/buckets/
|
||||
- title: Use the v2 HTTP API with Cloud Serverless
|
||||
href: /influxdb3/cloud-serverless/guides/api-compatibility/v2/
|
||||
- title: Use the v1 HTTP API with Cloud Serverless
|
||||
|
|
@ -40,11 +58,10 @@ tags:
|
|||
Authentication:
|
||||
x-traitTag: true
|
||||
description: |
|
||||
Use one of the following schemes to authenticate to the InfluxDB 3 Cloud Serverless API:
|
||||
Use one of the following schemes to authenticate to the InfluxDB Cloud Serverless API:
|
||||
|
||||
- [Token authentication](#section/Authentication/TokenAuthentication)
|
||||
- [Basic authentication](#section/Authentication/BasicAuthentication)
|
||||
<!-- ReDoc-Inject: <security-definitions> -->
|
||||
- Token authentication
|
||||
- Basic authentication
|
||||
|
||||
Authorizations (API tokens):
|
||||
description: >
|
||||
|
|
@ -68,13 +85,21 @@ tags:
|
|||
href: /influxdb3/cloud-serverless/admin/buckets/
|
||||
|
||||
Cells:
|
||||
x-traitTag: true
|
||||
description: >
|
||||
Manage cells within InfluxDB 3 Cloud Serverless dashboards.
|
||||
Manage cells within dashboards.
|
||||
This is an InfluxDB Cloud (TSM) endpoint that may be accessible but is
|
||||
not supported or recommended for use with InfluxDB Cloud Serverless
|
||||
(powered by the InfluxDB 3 storage engine).
|
||||
|
||||
Checks:
|
||||
x-traitTag: true
|
||||
description: >
|
||||
Create and manage monitoring checks that query data and generate
|
||||
notification statuses in InfluxDB 3 Cloud Serverless.
|
||||
notification statuses.
|
||||
This is an InfluxDB Cloud (TSM) endpoint that may be accessible but is
|
||||
not supported or recommended for use with InfluxDB Cloud Serverless
|
||||
(powered by the InfluxDB 3 storage engine).
|
||||
|
||||
Common parameters:
|
||||
x-traitTag: true
|
||||
|
|
@ -83,26 +108,37 @@ tags:
|
|||
endpoints, including `bucket`, `bucketID`, `org`, and `orgID`.
|
||||
|
||||
Config:
|
||||
x-traitTag: true
|
||||
description: >
|
||||
Retrieve configuration information for an InfluxDB 3 Cloud Serverless
|
||||
instance.
|
||||
Retrieve configuration information for an InfluxDB instance.
|
||||
This is an InfluxDB Cloud (TSM) endpoint that may be accessible but is
|
||||
not supported or recommended for use with InfluxDB Cloud Serverless
|
||||
(powered by the InfluxDB 3 storage engine).
|
||||
|
||||
Dashboards:
|
||||
x-traitTag: true
|
||||
description: >
|
||||
Create and manage dashboards in InfluxDB 3 Cloud Serverless.
|
||||
Create and manage dashboards.
|
||||
This is an InfluxDB Cloud (TSM) endpoint that may be accessible but is
|
||||
not supported or recommended for use with InfluxDB Cloud Serverless
|
||||
(powered by the InfluxDB 3 storage engine).
|
||||
|
||||
DBRPs:
|
||||
x-traitTag: true
|
||||
description: >
|
||||
Manage database and retention policy (DBRP) mappings that route InfluxDB
|
||||
v1-compatible requests to InfluxDB 3 Cloud Serverless buckets.
|
||||
x-related:
|
||||
- title: Database and retention policy mapping
|
||||
href: /influxdb3/cloud-serverless/reference/api/influxdb-1x/dbrp/
|
||||
Manage database and retention policy (DBRP) mappings.
|
||||
This is an InfluxDB Cloud (TSM) endpoint that may be accessible but is
|
||||
not supported or recommended for use with InfluxDB Cloud Serverless
|
||||
(powered by the InfluxDB 3 storage engine).
|
||||
|
||||
Delete:
|
||||
x-traitTag: true
|
||||
description: >
|
||||
Delete time series data from an InfluxDB 3 Cloud Serverless bucket by
|
||||
specifying a time range and optional predicate.
|
||||
Delete time series data from a bucket by specifying a time range and
|
||||
optional predicate.
|
||||
This is an InfluxDB Cloud (TSM) endpoint that may be accessible but is
|
||||
not supported or recommended for use with InfluxDB Cloud Serverless
|
||||
(powered by the InfluxDB 3 storage engine).
|
||||
|
||||
Headers:
|
||||
x-traitTag: true
|
||||
|
|
@ -112,20 +148,28 @@ tags:
|
|||
`Content-Type`.
|
||||
|
||||
Invokable Scripts:
|
||||
x-traitTag: true
|
||||
description: >
|
||||
Store, manage, and execute custom Flux scripts in InfluxDB 3 Cloud
|
||||
Serverless. Scripts accept runtime parameters and can be invoked via
|
||||
dedicated endpoints.
|
||||
Store, manage, and execute custom Flux scripts.
|
||||
This is an InfluxDB Cloud (TSM) endpoint that may be accessible but is
|
||||
not supported or recommended for use with InfluxDB Cloud Serverless
|
||||
(powered by the InfluxDB 3 storage engine).
|
||||
|
||||
Labels:
|
||||
x-traitTag: true
|
||||
description: >
|
||||
Create and manage labels for organizing InfluxDB 3 Cloud Serverless
|
||||
resources.
|
||||
Create and manage labels for organizing resources.
|
||||
This is an InfluxDB Cloud (TSM) endpoint that may be accessible but is
|
||||
not supported or recommended for use with InfluxDB Cloud Serverless
|
||||
(powered by the InfluxDB 3 storage engine).
|
||||
|
||||
Legacy Authorizations:
|
||||
x-traitTag: true
|
||||
description: >
|
||||
Manage legacy (v1-compatible) authorization credentials in InfluxDB 3
|
||||
Cloud Serverless.
|
||||
Manage legacy (v1-compatible) authorization credentials.
|
||||
This is an InfluxDB Cloud (TSM) endpoint that may be accessible but is
|
||||
not supported or recommended for use with InfluxDB Cloud Serverless
|
||||
(powered by the InfluxDB 3 storage engine).
|
||||
|
||||
Limits:
|
||||
description: >
|
||||
|
|
@ -133,14 +177,21 @@ tags:
|
|||
organization.
|
||||
|
||||
NotificationEndpoints:
|
||||
x-traitTag: true
|
||||
description: >
|
||||
Create and manage notification endpoints that receive alert notifications
|
||||
from InfluxDB 3 Cloud Serverless monitoring checks.
|
||||
Create and manage notification endpoints that receive alert notifications.
|
||||
This is an InfluxDB Cloud (TSM) endpoint that may be accessible but is
|
||||
not supported or recommended for use with InfluxDB Cloud Serverless
|
||||
(powered by the InfluxDB 3 storage engine).
|
||||
|
||||
NotificationRules:
|
||||
x-traitTag: true
|
||||
description: >
|
||||
Create and manage notification rules that define when and how
|
||||
InfluxDB 3 Cloud Serverless sends notifications to endpoints.
|
||||
notifications are sent to endpoints.
|
||||
This is an InfluxDB Cloud (TSM) endpoint that may be accessible but is
|
||||
not supported or recommended for use with InfluxDB Cloud Serverless
|
||||
(powered by the InfluxDB 3 storage engine).
|
||||
|
||||
Organizations:
|
||||
description: >
|
||||
|
|
@ -157,8 +208,12 @@ tags:
|
|||
InfluxDB 3 Cloud Serverless API.
|
||||
|
||||
Ping:
|
||||
x-traitTag: true
|
||||
description: >
|
||||
Check the availability of the InfluxDB 3 Cloud Serverless instance.
|
||||
Check the availability of an InfluxDB instance.
|
||||
This is an InfluxDB Cloud (TSM) endpoint that may be accessible but is
|
||||
not supported or recommended for use with InfluxDB Cloud Serverless
|
||||
(powered by the InfluxDB 3 storage engine).
|
||||
|
||||
Query data:
|
||||
description: >
|
||||
|
|
@ -178,9 +233,12 @@ tags:
|
|||
Serverless API.
|
||||
|
||||
Resources:
|
||||
x-traitTag: true
|
||||
description: >
|
||||
Retrieve a list of top-level resource types available in the InfluxDB 3
|
||||
Cloud Serverless API.
|
||||
Retrieve a list of top-level resource types available in the API.
|
||||
This is an InfluxDB Cloud (TSM) endpoint that may be accessible but is
|
||||
not supported or recommended for use with InfluxDB Cloud Serverless
|
||||
(powered by the InfluxDB 3 storage engine).
|
||||
|
||||
Response codes:
|
||||
x-traitTag: true
|
||||
|
|
@ -189,36 +247,63 @@ tags:
|
|||
endpoints and their meanings.
|
||||
|
||||
Routes:
|
||||
x-traitTag: true
|
||||
description: >
|
||||
Retrieve top-level routes for the InfluxDB 3 Cloud Serverless API.
|
||||
Retrieve top-level routes for the InfluxDB API.
|
||||
This is an InfluxDB Cloud (TSM) endpoint that may be accessible but is
|
||||
not supported or recommended for use with InfluxDB Cloud Serverless
|
||||
(powered by the InfluxDB 3 storage engine).
|
||||
|
||||
Rules:
|
||||
x-traitTag: true
|
||||
description: >
|
||||
Manage notification rules in InfluxDB 3 Cloud Serverless.
|
||||
Manage notification rules.
|
||||
This is an InfluxDB Cloud (TSM) endpoint that may be accessible but is
|
||||
not supported or recommended for use with InfluxDB Cloud Serverless
|
||||
(powered by the InfluxDB 3 storage engine).
|
||||
|
||||
Secrets:
|
||||
x-traitTag: true
|
||||
description: >
|
||||
Create and manage secrets (key-value pairs) for use in InfluxDB 3 Cloud
|
||||
Serverless Flux scripts and tasks.
|
||||
Create and manage secrets (key-value pairs) for use in Flux scripts
|
||||
and tasks.
|
||||
This is an InfluxDB Cloud (TSM) endpoint that may be accessible but is
|
||||
not supported or recommended for use with InfluxDB Cloud Serverless
|
||||
(powered by the InfluxDB 3 storage engine).
|
||||
|
||||
Security and access endpoints:
|
||||
x-traitTag: true
|
||||
description: >
|
||||
Endpoints for managing authentication and access control in InfluxDB 3
|
||||
Cloud Serverless.
|
||||
Endpoints for managing authentication and access control.
|
||||
This is an InfluxDB Cloud (TSM) endpoint that may be accessible but is
|
||||
not supported or recommended for use with InfluxDB Cloud Serverless
|
||||
(powered by the InfluxDB 3 storage engine).
|
||||
|
||||
Setup:
|
||||
x-traitTag: true
|
||||
description: >
|
||||
Configure an initial InfluxDB 3 Cloud Serverless instance, including
|
||||
creating the initial user, organization, and bucket.
|
||||
Configure an initial InfluxDB instance, including creating the initial
|
||||
user, organization, and bucket.
|
||||
This is an InfluxDB Cloud (TSM) endpoint that may be accessible but is
|
||||
not supported or recommended for use with InfluxDB Cloud Serverless
|
||||
(powered by the InfluxDB 3 storage engine).
|
||||
|
||||
Signin:
|
||||
x-traitTag: true
|
||||
description: >
|
||||
Create a user session by signing in with username and password
|
||||
credentials.
|
||||
This is an InfluxDB Cloud (TSM) endpoint that may be accessible but is
|
||||
not supported or recommended for use with InfluxDB Cloud Serverless
|
||||
(powered by the InfluxDB 3 storage engine).
|
||||
|
||||
Signout:
|
||||
x-traitTag: true
|
||||
description: >
|
||||
End a user session by signing out.
|
||||
This is an InfluxDB Cloud (TSM) endpoint that may be accessible but is
|
||||
not supported or recommended for use with InfluxDB Cloud Serverless
|
||||
(powered by the InfluxDB 3 storage engine).
|
||||
|
||||
Supported operations:
|
||||
x-traitTag: true
|
||||
|
|
@ -234,29 +319,47 @@ tags:
|
|||
| **Delete** | `DELETE` | Remove a resource. |
|
||||
|
||||
System information endpoints:
|
||||
x-traitTag: true
|
||||
description: >
|
||||
Endpoints for retrieving system-level information about the InfluxDB 3
|
||||
Cloud Serverless instance.
|
||||
Endpoints for retrieving system-level information about an InfluxDB
|
||||
instance.
|
||||
This is an InfluxDB Cloud (TSM) endpoint that may be accessible but is
|
||||
not supported or recommended for use with InfluxDB Cloud Serverless
|
||||
(powered by the InfluxDB 3 storage engine).
|
||||
|
||||
Tasks:
|
||||
x-traitTag: true
|
||||
description: >
|
||||
Schedule and manage Flux tasks that process and transform data on a
|
||||
recurring basis in InfluxDB 3 Cloud Serverless.
|
||||
recurring basis.
|
||||
This is an InfluxDB Cloud (TSM) endpoint that may be accessible but is
|
||||
not supported or recommended for use with InfluxDB Cloud Serverless
|
||||
(powered by the InfluxDB 3 storage engine).
|
||||
|
||||
Telegraf Plugins:
|
||||
x-traitTag: true
|
||||
description: >
|
||||
Retrieve available Telegraf plugin configuration templates for use with
|
||||
InfluxDB 3 Cloud Serverless.
|
||||
Retrieve available Telegraf plugin configuration templates.
|
||||
This is an InfluxDB Cloud (TSM) endpoint that may be accessible but is
|
||||
not supported or recommended for use with InfluxDB Cloud Serverless
|
||||
(powered by the InfluxDB 3 storage engine).
|
||||
|
||||
Telegrafs:
|
||||
x-traitTag: true
|
||||
description: >
|
||||
Create and manage Telegraf agent configurations that collect and write
|
||||
data to InfluxDB 3 Cloud Serverless.
|
||||
data to InfluxDB.
|
||||
This is an InfluxDB Cloud (TSM) endpoint that may be accessible but is
|
||||
not supported or recommended for use with InfluxDB Cloud Serverless
|
||||
(powered by the InfluxDB 3 storage engine).
|
||||
|
||||
Templates:
|
||||
x-traitTag: true
|
||||
description: >
|
||||
Export and apply InfluxDB templates, and manage template stacks for
|
||||
InfluxDB 3 Cloud Serverless.
|
||||
Export and apply InfluxDB templates, and manage template stacks.
|
||||
This is an InfluxDB Cloud (TSM) endpoint that may be accessible but is
|
||||
not supported or recommended for use with InfluxDB Cloud Serverless
|
||||
(powered by the InfluxDB 3 storage engine).
|
||||
|
||||
Usage:
|
||||
description: >
|
||||
|
|
@ -264,21 +367,28 @@ tags:
|
|||
Serverless organization.
|
||||
|
||||
Users:
|
||||
x-traitTag: true
|
||||
description: >
|
||||
View specific users that are members of your InfluxDB 3 Cloud Serverless
|
||||
organization.
|
||||
x-related:
|
||||
- title: Manage users
|
||||
href: /influxdb3/cloud-serverless/organizations/users/
|
||||
View specific users that are members of your organization.
|
||||
This is an InfluxDB Cloud (TSM) endpoint that may be accessible but is
|
||||
not supported or recommended for use with InfluxDB Cloud Serverless
|
||||
(powered by the InfluxDB 3 storage engine).
|
||||
|
||||
Variables:
|
||||
x-traitTag: true
|
||||
description: >
|
||||
Create and manage variables for use in InfluxDB 3 Cloud Serverless
|
||||
dashboards.
|
||||
Create and manage variables for use in dashboards.
|
||||
This is an InfluxDB Cloud (TSM) endpoint that may be accessible but is
|
||||
not supported or recommended for use with InfluxDB Cloud Serverless
|
||||
(powered by the InfluxDB 3 storage engine).
|
||||
|
||||
Views:
|
||||
x-traitTag: true
|
||||
description: >
|
||||
Manage cell views within InfluxDB 3 Cloud Serverless dashboards.
|
||||
Manage cell views within dashboards.
|
||||
This is an InfluxDB Cloud (TSM) endpoint that may be accessible but is
|
||||
not supported or recommended for use with InfluxDB Cloud Serverless
|
||||
(powered by the InfluxDB 3 storage engine).
|
||||
|
||||
Write data:
|
||||
description: >
|
||||
|
|
|
|||
File diff suppressed because it is too large
Load Diff
Loading…
Reference in New Issue