Influxdata
/
docs-v2
mirror of https://github.com/influxdata/docs-v2.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

fix(api): fixes #5412. Updates API landing pages to include Management API for Cloud Dedicated and descriptions of v1 and v2 APIs for each product.

pull/5432/head
Jason Stirnaman 2024-04-16 16:45:11 -05:00
parent 3d08263f38
commit fd73956bd4
5 changed files with 84 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
content/influxdb/cloud-dedicated/reference/api/_index.md
View File

@ -1,22 +1,41 @@
---
title: InfluxDB HTTP API
description: >
The InfluxDB HTTP API provides a programmatic interface for interactions with InfluxDB.
Access the InfluxDB API using the `/api/v2/` endpoint or InfluxDB v1 endpoints.
The InfluxDB HTTP API provides a programmatic interface for interactions with
InfluxDB, such as writing and querying data, and managing an InfluxDB cluster.
Access the InfluxDB API using the `/api/v2/write`, InfluxDB v1, or
Management API endpoints for InfluxDB Cloud Dedicated.
menu:
influxdb_cloud_dedicated:
parent: Reference
name: InfluxDB HTTP API
weight: 104
influxdb/cloud-dedicated/tags: [api]
aliases:
- /influxdb/cloud-dedicated/api/v1-compatibility/
---
The InfluxDB HTTP API provides a programmatic interface for interactions with InfluxDB.
The InfluxDB HTTP API provides a programmatic interface for interactions with
{{% product-name %}}, such as writing and querying data, and managing an InfluxDB cluster.
## InfluxDB HTTP API reference
Access the InfluxDB HTTP API using the `/api/v2/` endpoint, InfluxDB v1 endpoints, or
Management API endpoints for {{% product-name %}}.
<a class="btn" href="/influxdb/cloud-dedicated/api/">InfluxDB Cloud Dedicated HTTP API reference</a>
## InfluxDB v2 Compatibility API reference documentation
The API reference describes requests and responses for `/api/v2/` endpoints and v1 `/query` and `/write` endpoints.
<a class="btn" href="/influxdb/cloud-dedicated/api/v2/">InfluxDB v2 API for {{% product-name %}}</a>
The API reference describes requests and responses for InfluxDB v2-compatible
endpoints that work with {{% product-name %}} and with InfluxDB 2.x client
libraries and third-party integrations.
## InfluxDB v1 Compatibility API reference documentation
<a class="btn" href="/influxdb/cloud-dedicated/api/v1/">InfluxDB v1 API for {{% product-name %}}</a>
The API reference describes requests and responses for InfluxDB v1-compatible `/write` and `/query` endpoints that work with {{% product-name %}} and with InfluxDB 1.x client libraries and third-party integrations.
## InfluxDB Management API reference documentation
<a class="btn" href="/influxdb/cloud-dedicated/api/management/">InfluxDB Management API for {{% product-name %}}</a>
The API reference describes requests and responses for InfluxDB Management API endpoints.
The Management API lets cluster administrators manage resources such as databases, partitioning templates, and database tokens.

23
content/influxdb/cloud-serverless/reference/api/_index.md
View File

@ -2,21 +2,30 @@
title: InfluxDB HTTP API
description: >
The InfluxDB HTTP API provides a programmatic interface for interactions with InfluxDB.
Access the InfluxDB API using the `/api/v2/` endpoint or InfluxDB v1 endpoints.
Access the InfluxDB API using the `/api/v2/write` or InfluxDB v1 endpoints.
menu:
influxdb_cloud_serverless:
parent: Reference
name: InfluxDB HTTP API
weight: 104
influxdb/cloud-serverless/tags: [api]
aliases:
- /influxdb/cloud-serverless/api/v1-compatibility/
---
The InfluxDB HTTP API provides a programmatic interface for interactions with InfluxDB.
The InfluxDB HTTP API provides a programmatic interface for interactions with
{{% product-name %}}, such as writing and querying data.
## InfluxDB HTTP API reference
Access the InfluxDB HTTP API using the `/api/v2/` or InfluxDB v1 endpoints.
<a class="btn" href="/influxdb/cloud-serverless/api/">InfluxDB Cloud Serverless HTTP API reference</a>
## InfluxDB v2 Compatibility API reference documentation
The API reference describes requests and responses for `/api/v2/` endpoints and v1 `/query` and `/write` endpoints.
<a class="btn" href="/influxdb/cloud-serverless/api/v2/">InfluxDB v2 API for {{% product-name %}}</a>
The API reference describes requests and responses for InfluxDB v2-compatible
endpoints that work with {{% product-name %}} and with InfluxDB 2.x client
libraries and third-party integrations.
## InfluxDB v1 Compatibility API reference documentation
<a class="btn" href="/influxdb/cloud-serverless/api/v1/">InfluxDB v1 API for {{% product-name %}}</a>
The API reference describes requests and responses for InfluxDB v1-compatible `/write` and `/query` endpoints that work with {{% product-name %}} and with InfluxDB 1.x client libraries and third-party integrations.

26
content/influxdb/clustered/reference/api/_index.md
View File

@ -1,22 +1,32 @@
---
title: InfluxDB HTTP API
description: >
The InfluxDB HTTP API provides a programmatic interface for interactions with InfluxDB.
Access the InfluxDB API using the `/api/v2/` endpoint or InfluxDB v1 endpoints.
The InfluxDB HTTP API provides a programmatic interface for interactions with
InfluxDB, such as writing and querying data.
Access the InfluxDB API using the `/api/v2/write` or InfluxDB v1 endpoints.
menu:
influxdb_clustered:
parent: Reference
name: InfluxDB HTTP API
weight: 104
influxdb/clustered/tags: [api]
aliases:
- /influxdb/clustered/api/v1-compatibility/
---
The InfluxDB HTTP API provides a programmatic interface for interactions with InfluxDB.
The InfluxDB HTTP API provides a programmatic interface for interactions with
{{% product-name %}}, such as writing and querying data.
## InfluxDB HTTP API reference
Access the InfluxDB HTTP API using the `/api/v2/` or InfluxDB v1 endpoints.
<a class="btn" href="/influxdb/clustered/api/">InfluxDB Clustered HTTP API reference</a>
## InfluxDB v2 Compatibility API reference documentation
The API reference describes requests and responses for `/api/v2/` endpoints and v1 `/query` and `/write` endpoints.
<a class="btn" href="/influxdb/clustered/api/v2/">InfluxDB v2 API for {{% product-name %}}</a>
The API reference describes requests and responses for InfluxDB v2-compatible
endpoints that work with {{% product-name %}} and with InfluxDB 2.x client
libraries and third-party integrations.
## InfluxDB v1 Compatibility API reference documentation
<a class="btn" href="/influxdb/clustered/api/v1/">InfluxDB v1 API for {{% product-name %}}</a>
The API reference describes requests and responses for InfluxDB v1-compatible `/write` and `/query` endpoints that work with {{% product-name %}} and with InfluxDB 1.x client libraries and third-party integrations.

6
content/influxdb/v2/api-guide/api_intro.md
View File

@ -14,12 +14,12 @@ influxdb/cloud/tags: [api]
InfluxDB offers a rich API and [client libraries](/influxdb/v2/api-guide/client-libraries) ready to integrate with your application. Use popular tools like Curl and [Postman](/influxdb/v2/api-guide/postman) for rapidly testing API requests.
This section will guide you through the most commonly used API methods.
This section guides you through the most commonly used API methods.
For detailed documentation on the entire API, see [InfluxDBv2 API Reference](/influxdb/v2/reference/api/#influxdb-v2-api-documentation).
For detailed documentation on the entire API, see the [InfluxDB v2 API Reference](/influxdb/v2/reference/api/#influxdb-v2-api-documentation).
{{% note %}}
If you need to use InfluxDB {{< current-version >}} with **InfluxDB 1.x** API clients and integrations, see the [1.x compatibility API](/influxdb/v2/reference/api/influxdb-1x/).
If you need to use InfluxDB {{< current-version >}} with **InfluxDB 1.x** API clients and integrations, see the [1.x compatibility API](/influxdb/v2/reference/api/#influxdb-v1-compatibility-api-reference-documentation).
{{% /note %}}
## Bootstrap your application

30
content/influxdb/v2/reference/api/_index.md
View File

@ -1,8 +1,9 @@
---
title: InfluxDB v2 API
description: >
The InfluxDB v2 API provides a programmatic interface for interactions with InfluxDB.
Access the InfluxDB API using the `/api/v2/` endpoint.
The InfluxDB HTTP API provides a programmatic interface for interactions with InfluxDB, such as writing and querying data,
and managing resources within an InfluxDB instance.
Access the InfluxDB API using the `/api/v2/` or InfluxDB v1 endpoints.
menu:
influxdb_v2:
parent: Reference
@ -12,21 +13,30 @@ aliases:
- /influxdb/v2/concepts/api/
---
The InfluxDB v2 API provides a programmatic interface for interactions with InfluxDB.
Access the InfluxDB API using the `/api/v2/` endpoint.
The InfluxDB v2 API provides a programmatic interface for interactions such as writing and querying data, and managing resources in {{% product-name %}}.
Access the InfluxDB HTTP API using the `/api/v2/` endpoint or InfluxDB v1 endpoints
for {{% product-name %}}
## InfluxDB v2 API documentation
<a class="btn" href="/influxdb/v2/api/">InfluxDB OSS {{< current-version >}} API documentation</a>
<a class="btn" href="/influxdb/v2/api/">InfluxDB {{< current-version >}} API</a>
{{% oss-only %}}
#### View InfluxDB API documentation locally
InfluxDB API documentation is built into the `influxd` service and represents
the API specific to the current version of InfluxDB.
the API specific to your version of InfluxDB.
To view the API documentation locally, [start InfluxDB](/influxdb/v2/get-started/#start-influxdb)
and visit the `/docs` endpoint in a browser ([localhost:8086/docs](http://localhost:8086/docs)).
## InfluxDB v1 compatibility API documentation
The InfluxDB v2 API includes [InfluxDB 1.x compatibility endpoints](/influxdb/v2/reference/api/influxdb-1x/)
{{% /oss-only %}}
## InfluxDB v1 Compatibility API reference documentation
<a class="btn" href="/influxdb/v2/api/v1-compatibility/">InfluxDB v1 API for {{% product-name %}}</a>
The InfluxDB HTTP API includes [InfluxDB v1 compatibility endpoints](/influxdb/v2/reference/api/influxdb-1x/)
that work with InfluxDB 1.x client libraries and third-party integrations like
[Grafana](https://grafana.com) and others.
<a class="btn" href="/influxdb/v2/api/v1-compatibility/">View full v1 compatibility API documentation</a>