diff --git a/data/article-data/influxdb/cloud-v2/articles.json b/data/article-data/influxdb/cloud-v2/articles.json
deleted file mode 100644
index 2267c4303..000000000
--- a/data/article-data/influxdb/cloud-v2/articles.json
+++ /dev/null
@@ -1,597 +0,0 @@
-{
- "articles": [
- {
- "path": "api-v2-authorizations",
- "fields": {
- "name": "/api/v2/authorizations",
- "describes": [
- "/api/v2/authorizations",
- "/api/v2/authorizations/{authID}"
- ],
- "title": "/api/v2/authorizations\nInfluxDB Cloud API Service",
- "tags": [
- "api-v2",
- "authorizations"
- ],
- "source": "static/openapi/influxdb-cloud-v2/paths/ref-api-v2-authorizations.yaml",
- "staticFilePath": "/openapi/influxdb-cloud-v2/paths/ref-api-v2-authorizations.yaml"
- }
- },
- {
- "path": "api-v2-buckets",
- "fields": {
- "name": "/api/v2/buckets",
- "describes": [
- "/api/v2/buckets",
- "/api/v2/buckets/{bucketID}",
- "/api/v2/buckets/{bucketID}/labels",
- "/api/v2/buckets/{bucketID}/labels/{labelID}",
- "/api/v2/buckets/{bucketID}/members",
- "/api/v2/buckets/{bucketID}/members/{userID}",
- "/api/v2/buckets/{bucketID}/owners",
- "/api/v2/buckets/{bucketID}/owners/{userID}",
- "/api/v2/buckets/{bucketID}/schema/measurements",
- "/api/v2/buckets/{bucketID}/schema/measurements/{measurementID}"
- ],
- "title": "/api/v2/buckets\nInfluxDB Cloud API Service",
- "tags": [
- "api-v2",
- "buckets"
- ],
- "source": "static/openapi/influxdb-cloud-v2/paths/ref-api-v2-buckets.yaml",
- "staticFilePath": "/openapi/influxdb-cloud-v2/paths/ref-api-v2-buckets.yaml"
- }
- },
- {
- "path": "api-v2-checks",
- "fields": {
- "name": "/api/v2/checks",
- "describes": [
- "/api/v2/checks",
- "/api/v2/checks/{checkID}",
- "/api/v2/checks/{checkID}/labels",
- "/api/v2/checks/{checkID}/labels/{labelID}",
- "/api/v2/checks/{checkID}/query"
- ],
- "title": "/api/v2/checks\nInfluxDB Cloud API Service",
- "tags": [
- "api-v2",
- "checks"
- ],
- "source": "static/openapi/influxdb-cloud-v2/paths/ref-api-v2-checks.yaml",
- "staticFilePath": "/openapi/influxdb-cloud-v2/paths/ref-api-v2-checks.yaml"
- }
- },
- {
- "path": "api-v2-dashboards",
- "fields": {
- "name": "/api/v2/dashboards",
- "describes": [
- "/api/v2/dashboards",
- "/api/v2/dashboards/{dashboardID}",
- "/api/v2/dashboards/{dashboardID}/cells",
- "/api/v2/dashboards/{dashboardID}/cells/{cellID}",
- "/api/v2/dashboards/{dashboardID}/cells/{cellID}/view",
- "/api/v2/dashboards/{dashboardID}/labels",
- "/api/v2/dashboards/{dashboardID}/labels/{labelID}",
- "/api/v2/dashboards/{dashboardID}/members",
- "/api/v2/dashboards/{dashboardID}/members/{userID}",
- "/api/v2/dashboards/{dashboardID}/owners",
- "/api/v2/dashboards/{dashboardID}/owners/{userID}"
- ],
- "title": "/api/v2/dashboards\nInfluxDB Cloud API Service",
- "tags": [
- "api-v2",
- "dashboards"
- ],
- "source": "static/openapi/influxdb-cloud-v2/paths/ref-api-v2-dashboards.yaml",
- "staticFilePath": "/openapi/influxdb-cloud-v2/paths/ref-api-v2-dashboards.yaml"
- }
- },
- {
- "path": "api-v2-dbrps",
- "fields": {
- "name": "/api/v2/dbrps",
- "describes": [
- "/api/v2/dbrps",
- "/api/v2/dbrps/{dbrpID}"
- ],
- "title": "/api/v2/dbrps\nInfluxDB Cloud API Service",
- "tags": [
- "api-v2",
- "dbrps"
- ],
- "source": "static/openapi/influxdb-cloud-v2/paths/ref-api-v2-dbrps.yaml",
- "staticFilePath": "/openapi/influxdb-cloud-v2/paths/ref-api-v2-dbrps.yaml"
- }
- },
- {
- "path": "api-v2-delete",
- "fields": {
- "name": "/api/v2/delete",
- "describes": [
- "/api/v2/delete"
- ],
- "title": "/api/v2/delete\nInfluxDB Cloud API Service",
- "tags": [
- "api-v2",
- "delete"
- ],
- "source": "static/openapi/influxdb-cloud-v2/paths/ref-api-v2-delete.yaml",
- "staticFilePath": "/openapi/influxdb-cloud-v2/paths/ref-api-v2-delete.yaml"
- }
- },
- {
- "path": "api-v2-flags",
- "fields": {
- "name": "/api/v2/flags",
- "describes": [
- "/api/v2/flags"
- ],
- "title": "/api/v2/flags\nInfluxDB Cloud API Service",
- "tags": [
- "api-v2",
- "flags"
- ],
- "source": "static/openapi/influxdb-cloud-v2/paths/ref-api-v2-flags.yaml",
- "staticFilePath": "/openapi/influxdb-cloud-v2/paths/ref-api-v2-flags.yaml"
- }
- },
- {
- "path": "api-v2-labels",
- "fields": {
- "name": "/api/v2/labels",
- "describes": [
- "/api/v2/labels",
- "/api/v2/labels/{labelID}"
- ],
- "title": "/api/v2/labels\nInfluxDB Cloud API Service",
- "tags": [
- "api-v2",
- "labels"
- ],
- "source": "static/openapi/influxdb-cloud-v2/paths/ref-api-v2-labels.yaml",
- "staticFilePath": "/openapi/influxdb-cloud-v2/paths/ref-api-v2-labels.yaml"
- }
- },
- {
- "path": "api-v2-maps",
- "fields": {
- "name": "/api/v2/maps",
- "describes": [
- "/api/v2/maps/mapToken"
- ],
- "title": "/api/v2/maps\nInfluxDB Cloud API Service",
- "tags": [
- "api-v2",
- "maps"
- ],
- "source": "static/openapi/influxdb-cloud-v2/paths/ref-api-v2-maps.yaml",
- "staticFilePath": "/openapi/influxdb-cloud-v2/paths/ref-api-v2-maps.yaml"
- }
- },
- {
- "path": "api-v2-me",
- "fields": {
- "name": "/api/v2/me",
- "describes": [
- "/api/v2/me",
- "/api/v2/me/password"
- ],
- "title": "/api/v2/me\nInfluxDB Cloud API Service",
- "tags": [
- "api-v2",
- "me"
- ],
- "source": "static/openapi/influxdb-cloud-v2/paths/ref-api-v2-me.yaml",
- "staticFilePath": "/openapi/influxdb-cloud-v2/paths/ref-api-v2-me.yaml"
- }
- },
- {
- "path": "api-v2-notificationEndpoints",
- "fields": {
- "name": "/api/v2/notificationEndpoints",
- "describes": [
- "/api/v2/notificationEndpoints",
- "/api/v2/notificationEndpoints/{endpointID}",
- "/api/v2/notificationEndpoints/{endpointID}/labels",
- "/api/v2/notificationEndpoints/{endpointID}/labels/{labelID}"
- ],
- "title": "/api/v2/notificationEndpoints\nInfluxDB Cloud API Service",
- "tags": [
- "api-v2",
- "notificationEndpoints"
- ],
- "source": "static/openapi/influxdb-cloud-v2/paths/ref-api-v2-notificationEndpoints.yaml",
- "staticFilePath": "/openapi/influxdb-cloud-v2/paths/ref-api-v2-notificationEndpoints.yaml"
- }
- },
- {
- "path": "api-v2-notificationRules",
- "fields": {
- "name": "/api/v2/notificationRules",
- "describes": [
- "/api/v2/notificationRules",
- "/api/v2/notificationRules/{ruleID}",
- "/api/v2/notificationRules/{ruleID}/labels",
- "/api/v2/notificationRules/{ruleID}/labels/{labelID}",
- "/api/v2/notificationRules/{ruleID}/query"
- ],
- "title": "/api/v2/notificationRules\nInfluxDB Cloud API Service",
- "tags": [
- "api-v2",
- "notificationRules"
- ],
- "source": "static/openapi/influxdb-cloud-v2/paths/ref-api-v2-notificationRules.yaml",
- "staticFilePath": "/openapi/influxdb-cloud-v2/paths/ref-api-v2-notificationRules.yaml"
- }
- },
- {
- "path": "api-v2-orgs",
- "fields": {
- "name": "/api/v2/orgs",
- "describes": [
- "/api/v2/orgs",
- "/api/v2/orgs/{orgID}",
- "/api/v2/orgs/{orgID}/limits",
- "/api/v2/orgs/{orgID}/members",
- "/api/v2/orgs/{orgID}/members/{userID}",
- "/api/v2/orgs/{orgID}/owners",
- "/api/v2/orgs/{orgID}/owners/{userID}",
- "/api/v2/orgs/{orgID}/secrets",
- "/api/v2/orgs/{orgID}/secrets/delete",
- "/api/v2/orgs/{orgID}/secrets/{secretID}",
- "/api/v2/orgs/{orgID}/usage"
- ],
- "title": "/api/v2/orgs\nInfluxDB Cloud API Service",
- "tags": [
- "api-v2",
- "orgs"
- ],
- "source": "static/openapi/influxdb-cloud-v2/paths/ref-api-v2-orgs.yaml",
- "staticFilePath": "/openapi/influxdb-cloud-v2/paths/ref-api-v2-orgs.yaml"
- }
- },
- {
- "path": "api-v2-query",
- "fields": {
- "name": "/api/v2/query",
- "describes": [
- "/api/v2/query",
- "/api/v2/query/analyze",
- "/api/v2/query/ast",
- "/api/v2/query/suggestions",
- "/api/v2/query/suggestions/{name}"
- ],
- "title": "/api/v2/query\nInfluxDB Cloud API Service",
- "tags": [
- "api-v2",
- "query"
- ],
- "source": "static/openapi/influxdb-cloud-v2/paths/ref-api-v2-query.yaml",
- "staticFilePath": "/openapi/influxdb-cloud-v2/paths/ref-api-v2-query.yaml"
- }
- },
- {
- "path": "api-v2-resources",
- "fields": {
- "name": "/api/v2/resources",
- "describes": [
- "/api/v2/resources"
- ],
- "title": "/api/v2/resources\nInfluxDB Cloud API Service",
- "tags": [
- "api-v2",
- "resources"
- ],
- "source": "static/openapi/influxdb-cloud-v2/paths/ref-api-v2-resources.yaml",
- "staticFilePath": "/openapi/influxdb-cloud-v2/paths/ref-api-v2-resources.yaml"
- }
- },
- {
- "path": "api-v2-scripts",
- "fields": {
- "name": "/api/v2/scripts",
- "describes": [
- "/api/v2/scripts",
- "/api/v2/scripts/{scriptID}",
- "/api/v2/scripts/{scriptID}/invoke",
- "/api/v2/scripts/{scriptID}/params"
- ],
- "title": "/api/v2/scripts\nInfluxDB Cloud API Service",
- "tags": [
- "api-v2",
- "scripts"
- ],
- "source": "static/openapi/influxdb-cloud-v2/paths/ref-api-v2-scripts.yaml",
- "staticFilePath": "/openapi/influxdb-cloud-v2/paths/ref-api-v2-scripts.yaml"
- }
- },
- {
- "path": "api-v2-setup",
- "fields": {
- "name": "/api/v2/setup",
- "describes": [
- "/api/v2/setup",
- "/api/v2/setup/user"
- ],
- "title": "/api/v2/setup\nInfluxDB Cloud API Service",
- "tags": [
- "api-v2",
- "setup"
- ],
- "source": "static/openapi/influxdb-cloud-v2/paths/ref-api-v2-setup.yaml",
- "staticFilePath": "/openapi/influxdb-cloud-v2/paths/ref-api-v2-setup.yaml"
- }
- },
- {
- "path": "api-v2-signin",
- "fields": {
- "name": "/api/v2/signin",
- "describes": [
- "/api/v2/signin"
- ],
- "title": "/api/v2/signin\nInfluxDB Cloud API Service",
- "tags": [
- "api-v2",
- "signin"
- ],
- "source": "static/openapi/influxdb-cloud-v2/paths/ref-api-v2-signin.yaml",
- "staticFilePath": "/openapi/influxdb-cloud-v2/paths/ref-api-v2-signin.yaml"
- }
- },
- {
- "path": "api-v2-signout",
- "fields": {
- "name": "/api/v2/signout",
- "describes": [
- "/api/v2/signout"
- ],
- "title": "/api/v2/signout\nInfluxDB Cloud API Service",
- "tags": [
- "api-v2",
- "signout"
- ],
- "source": "static/openapi/influxdb-cloud-v2/paths/ref-api-v2-signout.yaml",
- "staticFilePath": "/openapi/influxdb-cloud-v2/paths/ref-api-v2-signout.yaml"
- }
- },
- {
- "path": "api-v2-stacks",
- "fields": {
- "name": "/api/v2/stacks",
- "describes": [
- "/api/v2/stacks",
- "/api/v2/stacks/{stack_id}",
- "/api/v2/stacks/{stack_id}/uninstall"
- ],
- "title": "/api/v2/stacks\nInfluxDB Cloud API Service",
- "tags": [
- "api-v2",
- "stacks"
- ],
- "source": "static/openapi/influxdb-cloud-v2/paths/ref-api-v2-stacks.yaml",
- "staticFilePath": "/openapi/influxdb-cloud-v2/paths/ref-api-v2-stacks.yaml"
- }
- },
- {
- "path": "api-v2-tasks",
- "fields": {
- "name": "/api/v2/tasks",
- "describes": [
- "/api/v2/tasks",
- "/api/v2/tasks/{taskID}",
- "/api/v2/tasks/{taskID}/labels",
- "/api/v2/tasks/{taskID}/labels/{labelID}",
- "/api/v2/tasks/{taskID}/logs",
- "/api/v2/tasks/{taskID}/members",
- "/api/v2/tasks/{taskID}/members/{userID}",
- "/api/v2/tasks/{taskID}/owners",
- "/api/v2/tasks/{taskID}/owners/{userID}",
- "/api/v2/tasks/{taskID}/runs",
- "/api/v2/tasks/{taskID}/runs/{runID}",
- "/api/v2/tasks/{taskID}/runs/{runID}/logs",
- "/api/v2/tasks/{taskID}/runs/{runID}/retry"
- ],
- "title": "/api/v2/tasks\nInfluxDB Cloud API Service",
- "tags": [
- "api-v2",
- "tasks"
- ],
- "source": "static/openapi/influxdb-cloud-v2/paths/ref-api-v2-tasks.yaml",
- "staticFilePath": "/openapi/influxdb-cloud-v2/paths/ref-api-v2-tasks.yaml"
- }
- },
- {
- "path": "api-v2-telegraf",
- "fields": {
- "name": "/api/v2/telegraf",
- "describes": [
- "/api/v2/telegraf/plugins"
- ],
- "title": "/api/v2/telegraf\nInfluxDB Cloud API Service",
- "tags": [
- "api-v2",
- "telegraf"
- ],
- "source": "static/openapi/influxdb-cloud-v2/paths/ref-api-v2-telegraf.yaml",
- "staticFilePath": "/openapi/influxdb-cloud-v2/paths/ref-api-v2-telegraf.yaml"
- }
- },
- {
- "path": "api-v2-telegrafs",
- "fields": {
- "name": "/api/v2/telegrafs",
- "describes": [
- "/api/v2/telegrafs",
- "/api/v2/telegrafs/{telegrafID}",
- "/api/v2/telegrafs/{telegrafID}/labels",
- "/api/v2/telegrafs/{telegrafID}/labels/{labelID}",
- "/api/v2/telegrafs/{telegrafID}/members",
- "/api/v2/telegrafs/{telegrafID}/members/{userID}",
- "/api/v2/telegrafs/{telegrafID}/owners",
- "/api/v2/telegrafs/{telegrafID}/owners/{userID}"
- ],
- "title": "/api/v2/telegrafs\nInfluxDB Cloud API Service",
- "tags": [
- "api-v2",
- "telegrafs"
- ],
- "source": "static/openapi/influxdb-cloud-v2/paths/ref-api-v2-telegrafs.yaml",
- "staticFilePath": "/openapi/influxdb-cloud-v2/paths/ref-api-v2-telegrafs.yaml"
- }
- },
- {
- "path": "api-v2-templates",
- "fields": {
- "name": "/api/v2/templates",
- "describes": [
- "/api/v2/templates/apply",
- "/api/v2/templates/export"
- ],
- "title": "/api/v2/templates\nInfluxDB Cloud API Service",
- "tags": [
- "api-v2",
- "templates"
- ],
- "source": "static/openapi/influxdb-cloud-v2/paths/ref-api-v2-templates.yaml",
- "staticFilePath": "/openapi/influxdb-cloud-v2/paths/ref-api-v2-templates.yaml"
- }
- },
- {
- "path": "api-v2-users",
- "fields": {
- "name": "/api/v2/users",
- "describes": [
- "/api/v2/users",
- "/api/v2/users/{userID}",
- "/api/v2/users/{userID}/password"
- ],
- "title": "/api/v2/users\nInfluxDB Cloud API Service",
- "tags": [
- "api-v2",
- "users"
- ],
- "source": "static/openapi/influxdb-cloud-v2/paths/ref-api-v2-users.yaml",
- "staticFilePath": "/openapi/influxdb-cloud-v2/paths/ref-api-v2-users.yaml"
- }
- },
- {
- "path": "api-v2-variables",
- "fields": {
- "name": "/api/v2/variables",
- "describes": [
- "/api/v2/variables",
- "/api/v2/variables/{variableID}",
- "/api/v2/variables/{variableID}/labels",
- "/api/v2/variables/{variableID}/labels/{labelID}"
- ],
- "title": "/api/v2/variables\nInfluxDB Cloud API Service",
- "tags": [
- "api-v2",
- "variables"
- ],
- "source": "static/openapi/influxdb-cloud-v2/paths/ref-api-v2-variables.yaml",
- "staticFilePath": "/openapi/influxdb-cloud-v2/paths/ref-api-v2-variables.yaml"
- }
- },
- {
- "path": "api-v2-write",
- "fields": {
- "name": "/api/v2/write",
- "describes": [
- "/api/v2/write"
- ],
- "title": "/api/v2/write\nInfluxDB Cloud API Service",
- "tags": [
- "api-v2",
- "write"
- ],
- "source": "static/openapi/influxdb-cloud-v2/paths/ref-api-v2-write.yaml",
- "staticFilePath": "/openapi/influxdb-cloud-v2/paths/ref-api-v2-write.yaml"
- }
- },
- {
- "path": "api-v2",
- "fields": {
- "name": "/api/v2",
- "describes": [
- "/api/v2"
- ],
- "title": "/api/v2\nInfluxDB Cloud API Service",
- "tags": [
- "api",
- "v2"
- ],
- "source": "static/openapi/influxdb-cloud-v2/paths/ref-api-v2.yaml",
- "staticFilePath": "/openapi/influxdb-cloud-v2/paths/ref-api-v2.yaml"
- }
- },
- {
- "path": "legacy-authorizations",
- "fields": {
- "name": "/legacy/authorizations",
- "describes": [
- "/legacy/authorizations",
- "/legacy/authorizations/{authID}",
- "/legacy/authorizations/{authID}/password"
- ],
- "title": "/legacy/authorizations\nInfluxDB Cloud API Service",
- "tags": [
- "legacy",
- "authorizations"
- ],
- "source": "static/openapi/influxdb-cloud-v2/paths/ref-legacy-authorizations.yaml",
- "staticFilePath": "/openapi/influxdb-cloud-v2/paths/ref-legacy-authorizations.yaml"
- }
- },
- {
- "path": "ping",
- "fields": {
- "name": "/ping",
- "describes": [
- "/ping"
- ],
- "title": "/ping\nInfluxDB Cloud API Service",
- "tags": [
- "",
- "ping"
- ],
- "source": "static/openapi/influxdb-cloud-v2/paths/ref-ping.yaml",
- "staticFilePath": "/openapi/influxdb-cloud-v2/paths/ref-ping.yaml"
- }
- },
- {
- "path": "query",
- "fields": {
- "name": "/query",
- "describes": [
- "/query"
- ],
- "title": "/query\nInfluxDB Cloud API Service",
- "tags": [
- "",
- "query"
- ],
- "source": "static/openapi/influxdb-cloud-v2/paths/ref-query.yaml",
- "staticFilePath": "/openapi/influxdb-cloud-v2/paths/ref-query.yaml"
- }
- },
- {
- "path": "write",
- "fields": {
- "name": "/write",
- "describes": [
- "/write"
- ],
- "title": "/write\nInfluxDB Cloud API Service",
- "tags": [
- "",
- "write"
- ],
- "source": "static/openapi/influxdb-cloud-v2/paths/ref-write.yaml",
- "staticFilePath": "/openapi/influxdb-cloud-v2/paths/ref-write.yaml"
- }
- }
- ]
-}
\ No newline at end of file
diff --git a/data/article_data/influxdb/cloud-dedicated/articles.yml b/data/article_data/influxdb/cloud-dedicated/articles.yml
new file mode 100644
index 000000000..e655739bf
--- /dev/null
+++ b/data/article_data/influxdb/cloud-dedicated/articles.yml
@@ -0,0 +1,24 @@
+articles:
+ - path: api/accounts/{accountId}/clusters
+ fields:
+ name: /accounts/{accountId}/clusters
+ describes:
+ - /accounts/{accountId}/clusters/{clusterId}/databases
+ - /accounts/{accountId}/clusters/{clusterId}/databases/{databaseName}
+ - >-
+ /accounts/{accountId}/clusters/{clusterId}/databases/{databaseName}/tables
+ - /accounts/{accountId}/clusters/{clusterId}/tokens
+ - /accounts/{accountId}/clusters/{clusterId}/tokens/{tokenId}
+ menuName: /accounts/{accountId}/clusters
+ title: /accounts/{accountId}/clusters
+ tags:
+ - accounts-{accountId}
+ - clusters
+ apiTags:
+ - Databases
+ - Tables
+ - Database tokens
+ source: >-
+ static/openapi/influxdb-cloud-dedicated/paths/openapi-accounts-{accountId}-clusters.yaml
+ staticFilePath: >-
+ /openapi/influxdb-cloud-dedicated/paths/openapi-accounts-{accountId}-clusters.yaml
diff --git a/data/article_data/influxdb/cloud-v2/articles.yml b/data/article_data/influxdb/cloud-v2/articles.yml
new file mode 100644
index 000000000..0f188ea90
--- /dev/null
+++ b/data/article_data/influxdb/cloud-v2/articles.yml
@@ -0,0 +1,499 @@
+articles:
+ - path: api/v2/authorizations
+ fields:
+ name: /api/v2/authorizations
+ describes:
+ - /api/v2/authorizations
+ - /api/v2/authorizations/{authID}
+ title: |-
+ /api/v2/authorizations
+ InfluxDB Cloud API Service
+ tags:
+ - api-v2
+ - authorizations
+ source: static/openapi/influxdb-cloud-v2/paths/ref-api-v2-authorizations.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/paths/ref-api-v2-authorizations.yaml
+ - path: api/v2/buckets
+ fields:
+ name: /api/v2/buckets
+ describes:
+ - /api/v2/buckets
+ - /api/v2/buckets/{bucketID}
+ - /api/v2/buckets/{bucketID}/labels
+ - /api/v2/buckets/{bucketID}/labels/{labelID}
+ - /api/v2/buckets/{bucketID}/members
+ - /api/v2/buckets/{bucketID}/members/{userID}
+ - /api/v2/buckets/{bucketID}/owners
+ - /api/v2/buckets/{bucketID}/owners/{userID}
+ - /api/v2/buckets/{bucketID}/schema/measurements
+ - /api/v2/buckets/{bucketID}/schema/measurements/{measurementID}
+ title: |-
+ /api/v2/buckets
+ InfluxDB Cloud API Service
+ tags:
+ - api-v2
+ - buckets
+ source: static/openapi/influxdb-cloud-v2/paths/ref-api-v2-buckets.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/paths/ref-api-v2-buckets.yaml
+ - path: api/v2/checks
+ fields:
+ name: /api/v2/checks
+ describes:
+ - /api/v2/checks
+ - /api/v2/checks/{checkID}
+ - /api/v2/checks/{checkID}/labels
+ - /api/v2/checks/{checkID}/labels/{labelID}
+ - /api/v2/checks/{checkID}/query
+ title: |-
+ /api/v2/checks
+ InfluxDB Cloud API Service
+ tags:
+ - api-v2
+ - checks
+ source: static/openapi/influxdb-cloud-v2/paths/ref-api-v2-checks.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/paths/ref-api-v2-checks.yaml
+ - path: api/v2/dashboards
+ fields:
+ name: /api/v2/dashboards
+ describes:
+ - /api/v2/dashboards
+ - /api/v2/dashboards/{dashboardID}
+ - /api/v2/dashboards/{dashboardID}/cells
+ - /api/v2/dashboards/{dashboardID}/cells/{cellID}
+ - /api/v2/dashboards/{dashboardID}/cells/{cellID}/view
+ - /api/v2/dashboards/{dashboardID}/labels
+ - /api/v2/dashboards/{dashboardID}/labels/{labelID}
+ - /api/v2/dashboards/{dashboardID}/members
+ - /api/v2/dashboards/{dashboardID}/members/{userID}
+ - /api/v2/dashboards/{dashboardID}/owners
+ - /api/v2/dashboards/{dashboardID}/owners/{userID}
+ title: |-
+ /api/v2/dashboards
+ InfluxDB Cloud API Service
+ tags:
+ - api-v2
+ - dashboards
+ source: static/openapi/influxdb-cloud-v2/paths/ref-api-v2-dashboards.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/paths/ref-api-v2-dashboards.yaml
+ - path: api/v2/dbrps
+ fields:
+ name: /api/v2/dbrps
+ describes:
+ - /api/v2/dbrps
+ - /api/v2/dbrps/{dbrpID}
+ title: |-
+ /api/v2/dbrps
+ InfluxDB Cloud API Service
+ tags:
+ - api-v2
+ - dbrps
+ source: static/openapi/influxdb-cloud-v2/paths/ref-api-v2-dbrps.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/paths/ref-api-v2-dbrps.yaml
+ - path: api/v2/delete
+ fields:
+ name: /api/v2/delete
+ describes:
+ - /api/v2/delete
+ title: |-
+ /api/v2/delete
+ InfluxDB Cloud API Service
+ tags:
+ - api-v2
+ - delete
+ source: static/openapi/influxdb-cloud-v2/paths/ref-api-v2-delete.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/paths/ref-api-v2-delete.yaml
+ - path: api/v2/flags
+ fields:
+ name: /api/v2/flags
+ describes:
+ - /api/v2/flags
+ title: |-
+ /api/v2/flags
+ InfluxDB Cloud API Service
+ tags:
+ - api-v2
+ - flags
+ source: static/openapi/influxdb-cloud-v2/paths/ref-api-v2-flags.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/paths/ref-api-v2-flags.yaml
+ - path: api/v2/labels
+ fields:
+ name: /api/v2/labels
+ describes:
+ - /api/v2/labels
+ - /api/v2/labels/{labelID}
+ title: |-
+ /api/v2/labels
+ InfluxDB Cloud API Service
+ tags:
+ - api-v2
+ - labels
+ source: static/openapi/influxdb-cloud-v2/paths/ref-api-v2-labels.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/paths/ref-api-v2-labels.yaml
+ - path: api/v2/maps
+ fields:
+ name: /api/v2/maps
+ describes:
+ - /api/v2/maps/mapToken
+ title: |-
+ /api/v2/maps
+ InfluxDB Cloud API Service
+ tags:
+ - api-v2
+ - maps
+ source: static/openapi/influxdb-cloud-v2/paths/ref-api-v2-maps.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/paths/ref-api-v2-maps.yaml
+ - path: api/v2/me
+ fields:
+ name: /api/v2/me
+ describes:
+ - /api/v2/me
+ - /api/v2/me/password
+ title: |-
+ /api/v2/me
+ InfluxDB Cloud API Service
+ tags:
+ - api-v2
+ - me
+ source: static/openapi/influxdb-cloud-v2/paths/ref-api-v2-me.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/paths/ref-api-v2-me.yaml
+ - path: api/v2/notificationEndpoints
+ fields:
+ name: /api/v2/notificationEndpoints
+ describes:
+ - /api/v2/notificationEndpoints
+ - /api/v2/notificationEndpoints/{endpointID}
+ - /api/v2/notificationEndpoints/{endpointID}/labels
+ - /api/v2/notificationEndpoints/{endpointID}/labels/{labelID}
+ title: |-
+ /api/v2/notificationEndpoints
+ InfluxDB Cloud API Service
+ tags:
+ - api-v2
+ - notificationEndpoints
+ source: >-
+ static/openapi/influxdb-cloud-v2/paths/ref-api-v2-notificationEndpoints.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/paths/ref-api-v2-notificationEndpoints.yaml
+ - path: api/v2/notificationRules
+ fields:
+ name: /api/v2/notificationRules
+ describes:
+ - /api/v2/notificationRules
+ - /api/v2/notificationRules/{ruleID}
+ - /api/v2/notificationRules/{ruleID}/labels
+ - /api/v2/notificationRules/{ruleID}/labels/{labelID}
+ - /api/v2/notificationRules/{ruleID}/query
+ title: |-
+ /api/v2/notificationRules
+ InfluxDB Cloud API Service
+ tags:
+ - api-v2
+ - notificationRules
+ source: static/openapi/influxdb-cloud-v2/paths/ref-api-v2-notificationRules.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/paths/ref-api-v2-notificationRules.yaml
+ - path: api/v2/orgs
+ fields:
+ name: /api/v2/orgs
+ describes:
+ - /api/v2/orgs
+ - /api/v2/orgs/{orgID}
+ - /api/v2/orgs/{orgID}/limits
+ - /api/v2/orgs/{orgID}/members
+ - /api/v2/orgs/{orgID}/members/{userID}
+ - /api/v2/orgs/{orgID}/owners
+ - /api/v2/orgs/{orgID}/owners/{userID}
+ - /api/v2/orgs/{orgID}/secrets
+ - /api/v2/orgs/{orgID}/secrets/delete
+ - /api/v2/orgs/{orgID}/secrets/{secretID}
+ - /api/v2/orgs/{orgID}/usage
+ title: |-
+ /api/v2/orgs
+ InfluxDB Cloud API Service
+ tags:
+ - api-v2
+ - orgs
+ source: static/openapi/influxdb-cloud-v2/paths/ref-api-v2-orgs.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/paths/ref-api-v2-orgs.yaml
+ - path: api/v2/query
+ fields:
+ name: /api/v2/query
+ describes:
+ - /api/v2/query
+ - /api/v2/query/analyze
+ - /api/v2/query/ast
+ - /api/v2/query/suggestions
+ - /api/v2/query/suggestions/{name}
+ title: |-
+ /api/v2/query
+ InfluxDB Cloud API Service
+ tags:
+ - api-v2
+ - query
+ source: static/openapi/influxdb-cloud-v2/paths/ref-api-v2-query.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/paths/ref-api-v2-query.yaml
+ - path: api/v2/resources
+ fields:
+ name: /api/v2/resources
+ describes:
+ - /api/v2/resources
+ title: |-
+ /api/v2/resources
+ InfluxDB Cloud API Service
+ tags:
+ - api-v2
+ - resources
+ source: static/openapi/influxdb-cloud-v2/paths/ref-api-v2-resources.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/paths/ref-api-v2-resources.yaml
+ - path: api/v2/scripts
+ fields:
+ name: /api/v2/scripts
+ describes:
+ - /api/v2/scripts
+ - /api/v2/scripts/{scriptID}
+ - /api/v2/scripts/{scriptID}/invoke
+ - /api/v2/scripts/{scriptID}/params
+ title: |-
+ /api/v2/scripts
+ InfluxDB Cloud API Service
+ tags:
+ - api-v2
+ - scripts
+ source: static/openapi/influxdb-cloud-v2/paths/ref-api-v2-scripts.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/paths/ref-api-v2-scripts.yaml
+ - path: api/v2/setup
+ fields:
+ name: /api/v2/setup
+ describes:
+ - /api/v2/setup
+ - /api/v2/setup/user
+ title: |-
+ /api/v2/setup
+ InfluxDB Cloud API Service
+ tags:
+ - api-v2
+ - setup
+ source: static/openapi/influxdb-cloud-v2/paths/ref-api-v2-setup.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/paths/ref-api-v2-setup.yaml
+ - path: api/v2/signin
+ fields:
+ name: /api/v2/signin
+ describes:
+ - /api/v2/signin
+ title: |-
+ /api/v2/signin
+ InfluxDB Cloud API Service
+ tags:
+ - api-v2
+ - signin
+ source: static/openapi/influxdb-cloud-v2/paths/ref-api-v2-signin.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/paths/ref-api-v2-signin.yaml
+ - path: api/v2/signout
+ fields:
+ name: /api/v2/signout
+ describes:
+ - /api/v2/signout
+ title: |-
+ /api/v2/signout
+ InfluxDB Cloud API Service
+ tags:
+ - api-v2
+ - signout
+ source: static/openapi/influxdb-cloud-v2/paths/ref-api-v2-signout.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/paths/ref-api-v2-signout.yaml
+ - path: api/v2/stacks
+ fields:
+ name: /api/v2/stacks
+ describes:
+ - /api/v2/stacks
+ - /api/v2/stacks/{stack_id}
+ - /api/v2/stacks/{stack_id}/uninstall
+ title: |-
+ /api/v2/stacks
+ InfluxDB Cloud API Service
+ tags:
+ - api-v2
+ - stacks
+ source: static/openapi/influxdb-cloud-v2/paths/ref-api-v2-stacks.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/paths/ref-api-v2-stacks.yaml
+ - path: api/v2/tasks
+ fields:
+ name: /api/v2/tasks
+ describes:
+ - /api/v2/tasks
+ - /api/v2/tasks/{taskID}
+ - /api/v2/tasks/{taskID}/labels
+ - /api/v2/tasks/{taskID}/labels/{labelID}
+ - /api/v2/tasks/{taskID}/logs
+ - /api/v2/tasks/{taskID}/members
+ - /api/v2/tasks/{taskID}/members/{userID}
+ - /api/v2/tasks/{taskID}/owners
+ - /api/v2/tasks/{taskID}/owners/{userID}
+ - /api/v2/tasks/{taskID}/runs
+ - /api/v2/tasks/{taskID}/runs/{runID}
+ - /api/v2/tasks/{taskID}/runs/{runID}/logs
+ - /api/v2/tasks/{taskID}/runs/{runID}/retry
+ title: |-
+ /api/v2/tasks
+ InfluxDB Cloud API Service
+ tags:
+ - api-v2
+ - tasks
+ source: static/openapi/influxdb-cloud-v2/paths/ref-api-v2-tasks.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/paths/ref-api-v2-tasks.yaml
+ - path: api/v2/telegraf
+ fields:
+ name: /api/v2/telegraf
+ describes:
+ - /api/v2/telegraf/plugins
+ title: |-
+ /api/v2/telegraf
+ InfluxDB Cloud API Service
+ tags:
+ - api-v2
+ - telegraf
+ source: static/openapi/influxdb-cloud-v2/paths/ref-api-v2-telegraf.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/paths/ref-api-v2-telegraf.yaml
+ - path: api/v2/telegrafs
+ fields:
+ name: /api/v2/telegrafs
+ describes:
+ - /api/v2/telegrafs
+ - /api/v2/telegrafs/{telegrafID}
+ - /api/v2/telegrafs/{telegrafID}/labels
+ - /api/v2/telegrafs/{telegrafID}/labels/{labelID}
+ - /api/v2/telegrafs/{telegrafID}/members
+ - /api/v2/telegrafs/{telegrafID}/members/{userID}
+ - /api/v2/telegrafs/{telegrafID}/owners
+ - /api/v2/telegrafs/{telegrafID}/owners/{userID}
+ title: |-
+ /api/v2/telegrafs
+ InfluxDB Cloud API Service
+ tags:
+ - api-v2
+ - telegrafs
+ source: static/openapi/influxdb-cloud-v2/paths/ref-api-v2-telegrafs.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/paths/ref-api-v2-telegrafs.yaml
+ - path: api/v2/templates
+ fields:
+ name: /api/v2/templates
+ describes:
+ - /api/v2/templates/apply
+ - /api/v2/templates/export
+ title: |-
+ /api/v2/templates
+ InfluxDB Cloud API Service
+ tags:
+ - api-v2
+ - templates
+ source: static/openapi/influxdb-cloud-v2/paths/ref-api-v2-templates.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/paths/ref-api-v2-templates.yaml
+ - path: api/v2/users
+ fields:
+ name: /api/v2/users
+ describes:
+ - /api/v2/users
+ - /api/v2/users/{userID}
+ - /api/v2/users/{userID}/password
+ title: |-
+ /api/v2/users
+ InfluxDB Cloud API Service
+ tags:
+ - api-v2
+ - users
+ source: static/openapi/influxdb-cloud-v2/paths/ref-api-v2-users.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/paths/ref-api-v2-users.yaml
+ - path: api/v2/variables
+ fields:
+ name: /api/v2/variables
+ describes:
+ - /api/v2/variables
+ - /api/v2/variables/{variableID}
+ - /api/v2/variables/{variableID}/labels
+ - /api/v2/variables/{variableID}/labels/{labelID}
+ title: |-
+ /api/v2/variables
+ InfluxDB Cloud API Service
+ tags:
+ - api-v2
+ - variables
+ source: static/openapi/influxdb-cloud-v2/paths/ref-api-v2-variables.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/paths/ref-api-v2-variables.yaml
+ - path: api/v2/write
+ fields:
+ name: /api/v2/write
+ describes:
+ - /api/v2/write
+ title: |-
+ /api/v2/write
+ InfluxDB Cloud API Service
+ tags:
+ - api-v2
+ - write
+ source: static/openapi/influxdb-cloud-v2/paths/ref-api-v2-write.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/paths/ref-api-v2-write.yaml
+ - path: api/v2
+ fields:
+ name: /api/v2
+ describes:
+ - /api/v2
+ title: |-
+ /api/v2
+ InfluxDB Cloud API Service
+ tags:
+ - api
+ - v2
+ source: static/openapi/influxdb-cloud-v2/paths/ref-api-v2.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/paths/ref-api-v2.yaml
+ - path: legacy/authorizations
+ fields:
+ name: /legacy/authorizations
+ describes:
+ - /legacy/authorizations
+ - /legacy/authorizations/{authID}
+ - /legacy/authorizations/{authID}/password
+ title: |-
+ /legacy/authorizations
+ InfluxDB Cloud API Service
+ tags:
+ - legacy
+ - authorizations
+ source: static/openapi/influxdb-cloud-v2/paths/ref-legacy-authorizations.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/paths/ref-legacy-authorizations.yaml
+ - path: ping
+ fields:
+ name: /ping
+ describes:
+ - /ping
+ title: |-
+ /ping
+ InfluxDB Cloud API Service
+ tags:
+ - ''
+ - ping
+ source: static/openapi/influxdb-cloud-v2/paths/ref-ping.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/paths/ref-ping.yaml
+ - path: query
+ fields:
+ name: /query
+ describes:
+ - /query
+ title: |-
+ /query
+ InfluxDB Cloud API Service
+ tags:
+ - ''
+ - query
+ source: static/openapi/influxdb-cloud-v2/paths/ref-query.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/paths/ref-query.yaml
+ - path: write
+ fields:
+ name: /write
+ describes:
+ - /write
+ title: |-
+ /write
+ InfluxDB Cloud API Service
+ tags:
+ - ''
+ - write
+ source: static/openapi/influxdb-cloud-v2/paths/ref-write.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/paths/ref-write.yaml
diff --git a/data/article_data/influxdb/clustered/articles.yml b/data/article_data/influxdb/clustered/articles.yml
new file mode 100644
index 000000000..b2d634713
--- /dev/null
+++ b/data/article_data/influxdb/clustered/articles.yml
@@ -0,0 +1,47 @@
+articles:
+ - path: api/databases/{databaseName}/tables
+ fields:
+ name: /databases/{databaseName}/tables
+ describes:
+ - /databases/{databaseName}/tables
+ menuName: /databases/{databaseName}/tables
+ title: /databases/{databaseName}/tables
+ tags:
+ - databases-{databaseName}
+ - tables
+ apiTags:
+ - Tables
+ source: >-
+ static/openapi/influxdb-clustered/paths/openapi-databases-{databaseName}-tables.yaml
+ staticFilePath: >-
+ /openapi/influxdb-clustered/paths/openapi-databases-{databaseName}-tables.yaml
+ - path: api/databases
+ fields:
+ name: /databases
+ describes:
+ - /databases
+ - /databases/{databaseName}
+ menuName: /databases
+ title: /databases
+ tags:
+ - ''
+ - databases
+ apiTags:
+ - Databases
+ source: static/openapi/influxdb-clustered/paths/openapi-databases.yaml
+ staticFilePath: /openapi/influxdb-clustered/paths/openapi-databases.yaml
+ - path: api/tokens
+ fields:
+ name: /tokens
+ describes:
+ - /tokens
+ - /tokens/{tokenId}
+ menuName: /tokens
+ title: /tokens
+ tags:
+ - ''
+ - tokens
+ apiTags:
+ - Database tokens
+ source: static/openapi/influxdb-clustered/paths/openapi-tokens.yaml
+ staticFilePath: /openapi/influxdb-clustered/paths/openapi-tokens.yaml
diff --git a/data/article_data/influxdb/influxdb3_core/articles.yml b/data/article_data/influxdb/influxdb3_core/articles.yml
new file mode 100644
index 000000000..75f32fb05
--- /dev/null
+++ b/data/article_data/influxdb/influxdb3_core/articles.yml
@@ -0,0 +1,1094 @@
+articles:
+ - path: api/authentication
+ fields:
+ name: Authentication
+ describes:
+ - /api/v3/configure/token/admin
+ - /api/v3/configure/token/admin/regenerate
+ - /api/v3/configure/token
+ - /api/v3/configure/token/named_admin
+ title: Authentication
+ description: >
+ Depending on your workflow, use one of the following schemes to
+ authenticate to the InfluxDB 3 API:
+
+
+ | Authentication scheme | Works with |
+
+ |:----------------------|:-----------|
+
+ | Bearer authentication | All endpoints |
+
+ | Token authentication | v1, v2 endpoints |
+
+ | Basic authentication | v1 endpoints |
+
+ | Querystring authentication | v1 endpoints |
+
+
+ See the **Security Schemes** section below for details on each
+ authentication method.
+ tag: Authentication
+ isConceptual: true
+ menuGroup: Concepts
+ operations:
+ - operationId: PostCreateAdminToken
+ method: POST
+ path: /api/v3/configure/token/admin
+ summary: Create admin token
+ tags:
+ - Authentication
+ - Token
+ - operationId: PostRegenerateAdminToken
+ method: POST
+ path: /api/v3/configure/token/admin/regenerate
+ summary: Regenerate admin token
+ tags:
+ - Authentication
+ - Token
+ - operationId: DeleteToken
+ method: DELETE
+ path: /api/v3/configure/token
+ summary: Delete token
+ tags:
+ - Authentication
+ - Token
+ - operationId: PostCreateNamedAdminToken
+ method: POST
+ path: /api/v3/configure/token/named_admin
+ summary: Create named admin token
+ tags:
+ - Authentication
+ - Token
+ tagDescription: >
+ Depending on your workflow, use one of the following schemes to
+ authenticate to the InfluxDB 3 API:
+
+
+ | Authentication scheme | Works with |
+
+ |:----------------------|:-----------|
+
+ | Bearer authentication | All endpoints |
+
+ | Token authentication | v1, v2 endpoints |
+
+ | Basic authentication | v1 endpoints |
+
+ | Querystring authentication | v1 endpoints |
+
+
+ See the **Security Schemes** section below for details on each
+ authentication method.
+ source: static/openapi/influxdb-influxdb3-core/tags/tags/ref-authentication.yaml
+ staticFilePath: /openapi/influxdb-influxdb3-core/tags/tags/ref-authentication.yaml
+ - path: api/cache-data
+ fields:
+ name: Cache data
+ describes:
+ - /api/v3/configure/distinct_cache
+ - /api/v3/configure/last_cache
+ title: Cache data
+ description: >
+ Manage the in-memory cache.
+
+
+ #### Distinct Value Cache
+
+
+ The Distinct Value Cache (DVC) lets you cache distinct
+
+ values of one or more columns in a table, improving the performance of
+
+ queries that return distinct tag and field values.
+
+
+ The DVC is an in-memory cache that stores distinct values for specific
+ columns
+
+ in a table. When you create an DVC, you can specify what columns'
+ distinct
+
+ values to cache, the maximum number of distinct value combinations to
+ cache, and
+
+ the maximum age of cached values. A DVC is associated with a table,
+ which can
+
+ have multiple DVCs.
+
+
+ #### Last value cache
+
+
+ The Last Value Cache (LVC) lets you cache the most recent
+
+ values for specific fields in a table, improving the performance of
+ queries that
+
+ return the most recent value of a field for specific series or the last
+ N values
+
+ of a field.
+
+
+ The LVC is an in-memory cache that stores the last N number of values
+ for
+
+ specific fields of series in a table. When you create an LVC, you can
+ specify
+
+ what fields to cache, what tags to use to identify each series, and the
+
+ number of values to cache for each unique series.
+
+ An LVC is associated with a table, which can have multiple LVCs.
+
+
+ #### Related guides
+
+
+ - [Manage the Distinct Value
+ Cache](/influxdb3/core/admin/distinct-value-cache/)
+
+ - [Manage the Last Value Cache](/influxdb3/core/admin/last-value-cache/)
+ tag: Cache data
+ isConceptual: false
+ menuGroup: Data Operations
+ operations:
+ - operationId: PostConfigureDistinctCache
+ method: POST
+ path: /api/v3/configure/distinct_cache
+ summary: Create distinct cache
+ tags:
+ - Cache data
+ - Table
+ - operationId: DeleteConfigureDistinctCache
+ method: DELETE
+ path: /api/v3/configure/distinct_cache
+ summary: Delete distinct cache
+ tags:
+ - Cache data
+ - Table
+ - operationId: PostConfigureLastCache
+ method: POST
+ path: /api/v3/configure/last_cache
+ summary: Create last cache
+ tags:
+ - Cache data
+ - Table
+ - operationId: DeleteConfigureLastCache
+ method: DELETE
+ path: /api/v3/configure/last_cache
+ summary: Delete last cache
+ tags:
+ - Cache data
+ - Table
+ tagDescription: >
+ Manage the in-memory cache.
+
+
+ #### Distinct Value Cache
+
+
+ The Distinct Value Cache (DVC) lets you cache distinct
+
+ values of one or more columns in a table, improving the performance of
+
+ queries that return distinct tag and field values.
+
+
+ The DVC is an in-memory cache that stores distinct values for specific
+ columns
+
+ in a table. When you create an DVC, you can specify what columns'
+ distinct
+
+ values to cache, the maximum number of distinct value combinations to
+ cache, and
+
+ the maximum age of cached values. A DVC is associated with a table,
+ which can
+
+ have multiple DVCs.
+
+
+ #### Last value cache
+
+
+ The Last Value Cache (LVC) lets you cache the most recent
+
+ values for specific fields in a table, improving the performance of
+ queries that
+
+ return the most recent value of a field for specific series or the last
+ N values
+
+ of a field.
+
+
+ The LVC is an in-memory cache that stores the last N number of values
+ for
+
+ specific fields of series in a table. When you create an LVC, you can
+ specify
+
+ what fields to cache, what tags to use to identify each series, and the
+
+ number of values to cache for each unique series.
+
+ An LVC is associated with a table, which can have multiple LVCs.
+
+
+ #### Related guides
+
+
+ - [Manage the Distinct Value
+ Cache](/influxdb3/core/admin/distinct-value-cache/)
+
+ - [Manage the Last Value Cache](/influxdb3/core/admin/last-value-cache/)
+ source: static/openapi/influxdb-influxdb3-core/tags/tags/ref-cache-data.yaml
+ staticFilePath: /openapi/influxdb-influxdb3-core/tags/tags/ref-cache-data.yaml
+ - path: api/compatibility-endpoints
+ fields:
+ name: Compatibility endpoints
+ describes:
+ - /write
+ - /api/v2/write
+ - /query
+ - /api/v1/health
+ title: Compatibility endpoints
+ description: >
+ InfluxDB 3 provides compatibility endpoints for InfluxDB 1.x and
+ InfluxDB 2.x workloads and clients.
+
+
+ ### Write data using v1- or v2-compatible endpoints
+
+
+ - [`/api/v2/write` endpoint](#operation/PostV2Write)
+ for InfluxDB v2 clients and when you bring existing InfluxDB v2 write workloads to InfluxDB 3.
+ - [`/write` endpoint](#operation/PostV1Write) for InfluxDB v1 clients
+ and when you bring existing InfluxDB v1 write workloads to InfluxDB 3.
+
+
+ For new workloads, use the [`/api/v3/write_lp`
+ endpoint](#operation/PostWriteLP).
+
+
+ All endpoints accept the same line protocol format.
+
+
+ ### Query data
+
+
+ Use the HTTP [`/query`](#operation/GetV1ExecuteQuery) endpoint for
+ InfluxDB v1 clients and v1 query workloads using InfluxQL.
+
+
+ For new workloads, use one of the following:
+
+
+ - HTTP [`/api/v3/query_sql` endpoint](#operation/GetExecuteQuerySQL) for
+ new query workloads using SQL.
+
+ - HTTP [`/api/v3/query_influxql`
+ endpoint](#operation/GetExecuteInfluxQLQuery) for new query workloads
+ using InfluxQL.
+
+ - Flight SQL and InfluxDB 3 _Flight+gRPC_ APIs for querying with SQL or
+ InfluxQL. For more information about using Flight APIs, see [InfluxDB 3
+ client
+ libraries](https://github.com/InfluxCommunity?q=influxdb3&type=public&language=&sort=).
+
+
+ ### Server information
+
+
+ Server information endpoints such as `/health` and `metrics` are
+ compatible with InfluxDB 1.x and InfluxDB 2.x clients.
+ tag: Compatibility endpoints
+ isConceptual: false
+ menuGroup: Compatibility
+ operations:
+ - operationId: PostV1Write
+ method: POST
+ path: /write
+ summary: Write line protocol (v1-compatible)
+ tags:
+ - Compatibility endpoints
+ - Write data
+ - operationId: PostV2Write
+ method: POST
+ path: /api/v2/write
+ summary: Write line protocol (v2-compatible)
+ tags:
+ - Compatibility endpoints
+ - Write data
+ - operationId: GetV1ExecuteQuery
+ method: GET
+ path: /query
+ summary: Execute InfluxQL query (v1-compatible)
+ tags:
+ - Query data
+ - Compatibility endpoints
+ - operationId: PostExecuteV1Query
+ method: POST
+ path: /query
+ summary: Execute InfluxQL query (v1-compatible)
+ tags:
+ - Query data
+ - Compatibility endpoints
+ - operationId: GetHealthV1
+ method: GET
+ path: /api/v1/health
+ summary: Health check (v1)
+ tags:
+ - Server information
+ - Compatibility endpoints
+ tagDescription: >
+ InfluxDB 3 provides compatibility endpoints for InfluxDB 1.x and
+ InfluxDB 2.x workloads and clients.
+
+
+ ### Write data using v1- or v2-compatible endpoints
+
+
+ - [`/api/v2/write` endpoint](#operation/PostV2Write)
+ for InfluxDB v2 clients and when you bring existing InfluxDB v2 write workloads to InfluxDB 3.
+ - [`/write` endpoint](#operation/PostV1Write) for InfluxDB v1 clients
+ and when you bring existing InfluxDB v1 write workloads to InfluxDB 3.
+
+
+ For new workloads, use the [`/api/v3/write_lp`
+ endpoint](#operation/PostWriteLP).
+
+
+ All endpoints accept the same line protocol format.
+
+
+ ### Query data
+
+
+ Use the HTTP [`/query`](#operation/GetV1ExecuteQuery) endpoint for
+ InfluxDB v1 clients and v1 query workloads using InfluxQL.
+
+
+ For new workloads, use one of the following:
+
+
+ - HTTP [`/api/v3/query_sql` endpoint](#operation/GetExecuteQuerySQL) for
+ new query workloads using SQL.
+
+ - HTTP [`/api/v3/query_influxql`
+ endpoint](#operation/GetExecuteInfluxQLQuery) for new query workloads
+ using InfluxQL.
+
+ - Flight SQL and InfluxDB 3 _Flight+gRPC_ APIs for querying with SQL or
+ InfluxQL. For more information about using Flight APIs, see [InfluxDB 3
+ client
+ libraries](https://github.com/InfluxCommunity?q=influxdb3&type=public&language=&sort=).
+
+
+ ### Server information
+
+
+ Server information endpoints such as `/health` and `metrics` are
+ compatible with InfluxDB 1.x and InfluxDB 2.x clients.
+ source: >-
+ static/openapi/influxdb-influxdb3-core/tags/tags/ref-compatibility-endpoints.yaml
+ staticFilePath: >-
+ /openapi/influxdb-influxdb3-core/tags/tags/ref-compatibility-endpoints.yaml
+ - path: api/database
+ fields:
+ name: Database
+ describes:
+ - /api/v3/configure/database
+ - /api/v3/configure/database/retention_period
+ title: Database
+ description: Manage databases
+ tag: Database
+ isConceptual: false
+ menuGroup: Administration
+ operations:
+ - operationId: GetConfigureDatabase
+ method: GET
+ path: /api/v3/configure/database
+ summary: List databases
+ tags:
+ - Database
+ - operationId: PostConfigureDatabase
+ method: POST
+ path: /api/v3/configure/database
+ summary: Create a database
+ tags:
+ - Database
+ - operationId: DeleteConfigureDatabase
+ method: DELETE
+ path: /api/v3/configure/database
+ summary: Delete a database
+ tags:
+ - Database
+ - operationId: DeleteDatabaseRetentionPeriod
+ method: DELETE
+ path: /api/v3/configure/database/retention_period
+ summary: Remove database retention period
+ tags:
+ - Database
+ tagDescription: Manage databases
+ source: static/openapi/influxdb-influxdb3-core/tags/tags/ref-database.yaml
+ staticFilePath: /openapi/influxdb-influxdb3-core/tags/tags/ref-database.yaml
+ - path: api/headers-and-parameters
+ fields:
+ name: Headers and parameters
+ describes: []
+ title: Headers and parameters
+ description: >
+ Most InfluxDB API endpoints require parameters in the request--for
+ example, specifying the database to use.
+
+
+ ### Common parameters
+
+
+ The following table shows common parameters used by many InfluxDB API
+ endpoints.
+
+ Many endpoints may require other parameters in the query string or in
+ the
+
+ request body that perform functions specific to those endpoints.
+
+
+ | Query parameter | Value type |
+ Description |
+
+ |:------------------------ |:---------------------
+ |:-------------------------------------------|
+
+ | `db` | string | The database name |
+
+
+ InfluxDB HTTP API endpoints use standard HTTP request and response
+ headers.
+
+ The following table shows common headers used by many InfluxDB API
+ endpoints.
+
+ Some endpoints may use other headers that perform functions more
+ specific to those endpoints--for example,
+
+ the write endpoints accept the `Content-Encoding` header to indicate
+ that line protocol is compressed in the request body.
+
+
+ | Header | Value type |
+ Description |
+
+ |:------------------------ |:---------------------
+ |:-------------------------------------------|
+
+ | `Accept` | string | The content type
+ that the client can understand. |
+
+ | `Authorization` | string | The authorization
+ scheme and credential. |
+
+ | `Content-Length` | integer | The size of the
+ entity-body, in bytes. |
+
+ | `Content-Type` | string | The format of the
+ data in the request body. |
+ tag: Headers and parameters
+ isConceptual: true
+ menuGroup: Concepts
+ operations: []
+ tagDescription: >
+ Most InfluxDB API endpoints require parameters in the request--for
+ example, specifying the database to use.
+
+
+ ### Common parameters
+
+
+ The following table shows common parameters used by many InfluxDB API
+ endpoints.
+
+ Many endpoints may require other parameters in the query string or in
+ the
+
+ request body that perform functions specific to those endpoints.
+
+
+ | Query parameter | Value type |
+ Description |
+
+ |:------------------------ |:---------------------
+ |:-------------------------------------------|
+
+ | `db` | string | The database name |
+
+
+ InfluxDB HTTP API endpoints use standard HTTP request and response
+ headers.
+
+ The following table shows common headers used by many InfluxDB API
+ endpoints.
+
+ Some endpoints may use other headers that perform functions more
+ specific to those endpoints--for example,
+
+ the write endpoints accept the `Content-Encoding` header to indicate
+ that line protocol is compressed in the request body.
+
+
+ | Header | Value type |
+ Description |
+
+ |:------------------------ |:---------------------
+ |:-------------------------------------------|
+
+ | `Accept` | string | The content type
+ that the client can understand. |
+
+ | `Authorization` | string | The authorization
+ scheme and credential. |
+
+ | `Content-Length` | integer | The size of the
+ entity-body, in bytes. |
+
+ | `Content-Type` | string | The format of the
+ data in the request body. |
+ source: >-
+ static/openapi/influxdb-influxdb3-core/tags/tags/ref-headers-and-parameters.yaml
+ staticFilePath: >-
+ /openapi/influxdb-influxdb3-core/tags/tags/ref-headers-and-parameters.yaml
+ - path: api/processing-engine
+ fields:
+ name: Processing engine
+ describes:
+ - /api/v3/configure/processing_engine_trigger
+ - /api/v3/configure/processing_engine_trigger/disable
+ - /api/v3/configure/processing_engine_trigger/enable
+ - /api/v3/configure/plugin_environment/install_packages
+ - /api/v3/configure/plugin_environment/install_requirements
+ - /api/v3/plugin_test/wal
+ - /api/v3/plugin_test/schedule
+ - /api/v3/engine/{request_path}
+ - /api/v3/plugins/files
+ - /api/v3/plugins/directory
+ title: Processing engine
+ description: >
+ Manage Processing engine triggers, test plugins, and send requests to
+ trigger On Request plugins.
+
+
+ InfluxDB 3 Core provides the InfluxDB 3 processing engine, an embedded
+ Python VM that can dynamically load and trigger Python plugins in
+ response to events in your database.
+
+ Use Processing engine plugins and triggers to run code and perform tasks
+ for different database events.
+
+
+ To get started with the processing engine, see the [Processing engine
+ and Python plugins](/influxdb3/core/processing-engine/) guide.
+ tag: Processing engine
+ isConceptual: false
+ menuGroup: Processing Engine
+ operations:
+ - operationId: PostConfigureProcessingEngineTrigger
+ method: POST
+ path: /api/v3/configure/processing_engine_trigger
+ summary: Create processing engine trigger
+ tags:
+ - Processing engine
+ - operationId: DeleteConfigureProcessingEngineTrigger
+ method: DELETE
+ path: /api/v3/configure/processing_engine_trigger
+ summary: Delete processing engine trigger
+ tags:
+ - Processing engine
+ - operationId: PostDisableProcessingEngineTrigger
+ method: POST
+ path: /api/v3/configure/processing_engine_trigger/disable
+ summary: Disable processing engine trigger
+ tags:
+ - Processing engine
+ - operationId: PostEnableProcessingEngineTrigger
+ method: POST
+ path: /api/v3/configure/processing_engine_trigger/enable
+ summary: Enable processing engine trigger
+ tags:
+ - Processing engine
+ - operationId: PostInstallPluginPackages
+ method: POST
+ path: /api/v3/configure/plugin_environment/install_packages
+ summary: Install plugin packages
+ tags:
+ - Processing engine
+ - operationId: PostInstallPluginRequirements
+ method: POST
+ path: /api/v3/configure/plugin_environment/install_requirements
+ summary: Install plugin requirements
+ tags:
+ - Processing engine
+ - operationId: PostTestWALPlugin
+ method: POST
+ path: /api/v3/plugin_test/wal
+ summary: Test WAL plugin
+ tags:
+ - Processing engine
+ - operationId: PostTestSchedulingPlugin
+ method: POST
+ path: /api/v3/plugin_test/schedule
+ summary: Test scheduling plugin
+ tags:
+ - Processing engine
+ - operationId: GetProcessingEnginePluginRequest
+ method: GET
+ path: /api/v3/engine/{request_path}
+ summary: On Request processing engine plugin request
+ tags:
+ - Processing engine
+ - operationId: PostProcessingEnginePluginRequest
+ method: POST
+ path: /api/v3/engine/{request_path}
+ summary: On Request processing engine plugin request
+ tags:
+ - Processing engine
+ - operationId: PutPluginFile
+ method: PUT
+ path: /api/v3/plugins/files
+ summary: Update plugin file
+ tags:
+ - Processing engine
+ - operationId: PutPluginDirectory
+ method: PUT
+ path: /api/v3/plugins/directory
+ summary: Update plugin directory
+ tags:
+ - Processing engine
+ tagDescription: >
+ Manage Processing engine triggers, test plugins, and send requests to
+ trigger On Request plugins.
+
+
+ InfluxDB 3 Core provides the InfluxDB 3 processing engine, an embedded
+ Python VM that can dynamically load and trigger Python plugins in
+ response to events in your database.
+
+ Use Processing engine plugins and triggers to run code and perform tasks
+ for different database events.
+
+
+ To get started with the processing engine, see the [Processing engine
+ and Python plugins](/influxdb3/core/processing-engine/) guide.
+ source: >-
+ static/openapi/influxdb-influxdb3-core/tags/tags/ref-processing-engine.yaml
+ staticFilePath: /openapi/influxdb-influxdb3-core/tags/tags/ref-processing-engine.yaml
+ - path: api/query-data
+ fields:
+ name: Query data
+ describes:
+ - /api/v3/query_sql
+ - /api/v3/query_influxql
+ - /query
+ title: Query data
+ description: Query data using SQL or InfluxQL
+ tag: Query data
+ isConceptual: false
+ menuGroup: Data Operations
+ operations:
+ - operationId: GetExecuteQuerySQL
+ method: GET
+ path: /api/v3/query_sql
+ summary: Execute SQL query
+ tags:
+ - Query data
+ - operationId: PostExecuteQuerySQL
+ method: POST
+ path: /api/v3/query_sql
+ summary: Execute SQL query
+ tags:
+ - Query data
+ - operationId: GetExecuteInfluxQLQuery
+ method: GET
+ path: /api/v3/query_influxql
+ summary: Execute InfluxQL query
+ tags:
+ - Query data
+ - operationId: PostExecuteQueryInfluxQL
+ method: POST
+ path: /api/v3/query_influxql
+ summary: Execute InfluxQL query
+ tags:
+ - Query data
+ - operationId: GetV1ExecuteQuery
+ method: GET
+ path: /query
+ summary: Execute InfluxQL query (v1-compatible)
+ tags:
+ - Query data
+ - Compatibility endpoints
+ - operationId: PostExecuteV1Query
+ method: POST
+ path: /query
+ summary: Execute InfluxQL query (v1-compatible)
+ tags:
+ - Query data
+ - Compatibility endpoints
+ tagDescription: Query data using SQL or InfluxQL
+ source: static/openapi/influxdb-influxdb3-core/tags/tags/ref-query-data.yaml
+ staticFilePath: /openapi/influxdb-influxdb3-core/tags/tags/ref-query-data.yaml
+ - path: api/quick-start
+ fields:
+ name: Quick start
+ describes: []
+ title: Quick start
+ description: >
+ 1. [Create an admin token](#section/Authentication) to authorize API
+ requests.
+
+ ```bash
+ curl -X POST "http://localhost:8181/api/v3/configure/token/admin"
+ ```
+ 2. [Check the status](#section/Server-information) of the InfluxDB
+ server.
+
+ ```bash
+ curl "http://localhost:8181/health" \
+ --header "Authorization: Bearer ADMIN_TOKEN"
+ ```
+
+ 3. [Write data](#operation/PostWriteLP) to InfluxDB.
+
+ ```bash
+ curl "http://localhost:8181/api/v3/write_lp?db=sensors&precision=auto"
+ --header "Authorization: Bearer ADMIN_TOKEN" \
+ --data-raw "home,room=Kitchen temp=72.0
+ home,room=Living\ room temp=71.5"
+ ```
+
+ If all data is written, the response is `204 No Content`.
+
+ 4. [Query data](#operation/GetExecuteQuerySQL) from InfluxDB.
+
+ ```bash
+ curl -G "http://localhost:8181/api/v3/query_sql" \
+ --header "Authorization: Bearer ADMIN_TOKEN" \
+ --data-urlencode "db=sensors" \
+ --data-urlencode "q=SELECT * FROM home WHERE room='Living room'" \
+ --data-urlencode "format=jsonl"
+ ```
+
+ Output:
+
+ ```jsonl
+ {"room":"Living room","temp":71.5,"time":"2025-02-25T20:19:34.984098"}
+ ```
+
+ For more information about using InfluxDB 3 Core, see the [Get
+ started](/influxdb3/core/get-started/) guide.
+ tag: Quick start
+ isConceptual: true
+ menuGroup: Concepts
+ operations: []
+ tagDescription: >
+ 1. [Create an admin token](#section/Authentication) to authorize API
+ requests.
+
+ ```bash
+ curl -X POST "http://localhost:8181/api/v3/configure/token/admin"
+ ```
+ 2. [Check the status](#section/Server-information) of the InfluxDB
+ server.
+
+ ```bash
+ curl "http://localhost:8181/health" \
+ --header "Authorization: Bearer ADMIN_TOKEN"
+ ```
+
+ 3. [Write data](#operation/PostWriteLP) to InfluxDB.
+
+ ```bash
+ curl "http://localhost:8181/api/v3/write_lp?db=sensors&precision=auto"
+ --header "Authorization: Bearer ADMIN_TOKEN" \
+ --data-raw "home,room=Kitchen temp=72.0
+ home,room=Living\ room temp=71.5"
+ ```
+
+ If all data is written, the response is `204 No Content`.
+
+ 4. [Query data](#operation/GetExecuteQuerySQL) from InfluxDB.
+
+ ```bash
+ curl -G "http://localhost:8181/api/v3/query_sql" \
+ --header "Authorization: Bearer ADMIN_TOKEN" \
+ --data-urlencode "db=sensors" \
+ --data-urlencode "q=SELECT * FROM home WHERE room='Living room'" \
+ --data-urlencode "format=jsonl"
+ ```
+
+ Output:
+
+ ```jsonl
+ {"room":"Living room","temp":71.5,"time":"2025-02-25T20:19:34.984098"}
+ ```
+
+ For more information about using InfluxDB 3 Core, see the [Get
+ started](/influxdb3/core/get-started/) guide.
+ source: static/openapi/influxdb-influxdb3-core/tags/tags/ref-quick-start.yaml
+ staticFilePath: /openapi/influxdb-influxdb3-core/tags/tags/ref-quick-start.yaml
+ - path: api/server-information
+ fields:
+ name: Server information
+ describes:
+ - /health
+ - /api/v1/health
+ - /ping
+ - /metrics
+ title: Server information
+ description: Retrieve server metrics, status, and version information
+ tag: Server information
+ isConceptual: false
+ menuGroup: Server
+ operations:
+ - operationId: GetHealth
+ method: GET
+ path: /health
+ summary: Health check
+ tags:
+ - Server information
+ - operationId: GetHealthV1
+ method: GET
+ path: /api/v1/health
+ summary: Health check (v1)
+ tags:
+ - Server information
+ - Compatibility endpoints
+ - operationId: GetPing
+ method: GET
+ path: /ping
+ summary: Ping the server
+ tags:
+ - Server information
+ - operationId: GetMetrics
+ method: GET
+ path: /metrics
+ summary: Metrics
+ tags:
+ - Server information
+ tagDescription: Retrieve server metrics, status, and version information
+ source: >-
+ static/openapi/influxdb-influxdb3-core/tags/tags/ref-server-information.yaml
+ staticFilePath: /openapi/influxdb-influxdb3-core/tags/tags/ref-server-information.yaml
+ - path: api/table
+ fields:
+ name: Table
+ describes:
+ - /api/v3/configure/table
+ - /api/v3/configure/distinct_cache
+ - /api/v3/configure/last_cache
+ title: Table
+ description: Manage table schemas and data
+ tag: Table
+ isConceptual: false
+ menuGroup: Administration
+ operations:
+ - operationId: PostConfigureTable
+ method: POST
+ path: /api/v3/configure/table
+ summary: Create a table
+ tags:
+ - Table
+ - operationId: DeleteConfigureTable
+ method: DELETE
+ path: /api/v3/configure/table
+ summary: Delete a table
+ tags:
+ - Table
+ - operationId: PostConfigureDistinctCache
+ method: POST
+ path: /api/v3/configure/distinct_cache
+ summary: Create distinct cache
+ tags:
+ - Cache data
+ - Table
+ - operationId: DeleteConfigureDistinctCache
+ method: DELETE
+ path: /api/v3/configure/distinct_cache
+ summary: Delete distinct cache
+ tags:
+ - Cache data
+ - Table
+ - operationId: PostConfigureLastCache
+ method: POST
+ path: /api/v3/configure/last_cache
+ summary: Create last cache
+ tags:
+ - Cache data
+ - Table
+ - operationId: DeleteConfigureLastCache
+ method: DELETE
+ path: /api/v3/configure/last_cache
+ summary: Delete last cache
+ tags:
+ - Cache data
+ - Table
+ tagDescription: Manage table schemas and data
+ source: static/openapi/influxdb-influxdb3-core/tags/tags/ref-table.yaml
+ staticFilePath: /openapi/influxdb-influxdb3-core/tags/tags/ref-table.yaml
+ - path: api/token
+ fields:
+ name: Token
+ describes:
+ - /api/v3/configure/token/admin
+ - /api/v3/configure/token/admin/regenerate
+ - /api/v3/configure/token
+ - /api/v3/configure/token/named_admin
+ title: Token
+ description: Manage tokens for authentication and authorization
+ tag: Token
+ isConceptual: false
+ menuGroup: Administration
+ operations:
+ - operationId: PostCreateAdminToken
+ method: POST
+ path: /api/v3/configure/token/admin
+ summary: Create admin token
+ tags:
+ - Authentication
+ - Token
+ - operationId: PostRegenerateAdminToken
+ method: POST
+ path: /api/v3/configure/token/admin/regenerate
+ summary: Regenerate admin token
+ tags:
+ - Authentication
+ - Token
+ - operationId: DeleteToken
+ method: DELETE
+ path: /api/v3/configure/token
+ summary: Delete token
+ tags:
+ - Authentication
+ - Token
+ - operationId: PostCreateNamedAdminToken
+ method: POST
+ path: /api/v3/configure/token/named_admin
+ summary: Create named admin token
+ tags:
+ - Authentication
+ - Token
+ tagDescription: Manage tokens for authentication and authorization
+ source: static/openapi/influxdb-influxdb3-core/tags/tags/ref-token.yaml
+ staticFilePath: /openapi/influxdb-influxdb3-core/tags/tags/ref-token.yaml
+ - path: api/write-data
+ fields:
+ name: Write data
+ describes:
+ - /write
+ - /api/v2/write
+ - /api/v3/write_lp
+ title: Write data
+ description: >
+ Write data to InfluxDB 3 using line protocol format.
+
+
+ #### Timestamp precision across write APIs
+
+
+ InfluxDB 3 provides multiple write endpoints for compatibility with
+ different InfluxDB versions.
+
+ The following table compares timestamp precision support across v1, v2,
+ and v3 write APIs:
+
+
+ | Precision | v1 (`/write`) | v2 (`/api/v2/write`) | v3
+ (`/api/v3/write_lp`) |
+
+ |-----------|---------------|----------------------|-------------------------|
+
+ | **Auto detection** | ❌ No | ❌ No | ✅ `auto` (default) |
+
+ | **Seconds** | ✅ `s` | ✅ `s` | ✅ `second` |
+
+ | **Milliseconds** | ✅ `ms` | ✅ `ms` | ✅ `millisecond` |
+
+ | **Microseconds** | ✅ `u` or `µ` | ✅ `us` | ✅ `microsecond` |
+
+ | **Nanoseconds** | ✅ `ns` | ✅ `ns` | ✅ `nanosecond` |
+
+ | **Minutes** | ✅ `m` | ❌ No | ❌ No |
+
+ | **Hours** | ✅ `h` | ❌ No | ❌ No |
+
+ | **Default** | Nanosecond | Nanosecond | **Auto** (guessed) |
+
+
+ All timestamps are stored internally as nanoseconds.
+ tag: Write data
+ isConceptual: false
+ menuGroup: Data Operations
+ operations:
+ - operationId: PostV1Write
+ method: POST
+ path: /write
+ summary: Write line protocol (v1-compatible)
+ tags:
+ - Compatibility endpoints
+ - Write data
+ - operationId: PostV2Write
+ method: POST
+ path: /api/v2/write
+ summary: Write line protocol (v2-compatible)
+ tags:
+ - Compatibility endpoints
+ - Write data
+ - operationId: PostWriteLP
+ method: POST
+ path: /api/v3/write_lp
+ summary: Write line protocol
+ tags:
+ - Write data
+ tagDescription: >
+ Write data to InfluxDB 3 using line protocol format.
+
+
+ #### Timestamp precision across write APIs
+
+
+ InfluxDB 3 provides multiple write endpoints for compatibility with
+ different InfluxDB versions.
+
+ The following table compares timestamp precision support across v1, v2,
+ and v3 write APIs:
+
+
+ | Precision | v1 (`/write`) | v2 (`/api/v2/write`) | v3
+ (`/api/v3/write_lp`) |
+
+ |-----------|---------------|----------------------|-------------------------|
+
+ | **Auto detection** | ❌ No | ❌ No | ✅ `auto` (default) |
+
+ | **Seconds** | ✅ `s` | ✅ `s` | ✅ `second` |
+
+ | **Milliseconds** | ✅ `ms` | ✅ `ms` | ✅ `millisecond` |
+
+ | **Microseconds** | ✅ `u` or `µ` | ✅ `us` | ✅ `microsecond` |
+
+ | **Nanoseconds** | ✅ `ns` | ✅ `ns` | ✅ `nanosecond` |
+
+ | **Minutes** | ✅ `m` | ❌ No | ❌ No |
+
+ | **Hours** | ✅ `h` | ❌ No | ❌ No |
+
+ | **Default** | Nanosecond | Nanosecond | **Auto** (guessed) |
+
+
+ All timestamps are stored internally as nanoseconds.
+ source: static/openapi/influxdb-influxdb3-core/tags/tags/ref-write-data.yaml
+ staticFilePath: /openapi/influxdb-influxdb3-core/tags/tags/ref-write-data.yaml
diff --git a/data/article_data/influxdb/influxdb3_enterprise/articles.yml b/data/article_data/influxdb/influxdb3_enterprise/articles.yml
new file mode 100644
index 000000000..1a31bf353
--- /dev/null
+++ b/data/article_data/influxdb/influxdb3_enterprise/articles.yml
@@ -0,0 +1,246 @@
+articles:
+ - path: api/v1/health
+ fields:
+ name: /api/v1/health
+ describes:
+ - /api/v1/health
+ menuName: /api/v1/health
+ title: /api/v1/health
+ tags:
+ - api-v1
+ - health
+ apiTags:
+ - Server information
+ - Compatibility endpoints
+ source: >-
+ static/openapi/influxdb-influxdb3-enterprise/paths/ref-api-v1-health.yaml
+ staticFilePath: /openapi/influxdb-influxdb3-enterprise/paths/ref-api-v1-health.yaml
+ - path: api/v2/write
+ fields:
+ name: /api/v2/write
+ describes:
+ - /api/v2/write
+ menuName: /api/v2/write
+ title: /api/v2/write
+ tags:
+ - api-v2
+ - write
+ apiTags:
+ - Compatibility endpoints
+ - Write data
+ source: static/openapi/influxdb-influxdb3-enterprise/paths/ref-api-v2-write.yaml
+ staticFilePath: /openapi/influxdb-influxdb3-enterprise/paths/ref-api-v2-write.yaml
+ - path: api/v3/configure
+ fields:
+ name: /api/v3/configure
+ describes:
+ - /api/v3/configure/database
+ - /api/v3/configure/database/retention_period
+ - /api/v3/configure/database/{db}
+ - /api/v3/configure/distinct_cache
+ - /api/v3/configure/enterprise/token
+ - /api/v3/configure/last_cache
+ - /api/v3/configure/plugin_environment/install_packages
+ - /api/v3/configure/plugin_environment/install_requirements
+ - /api/v3/configure/processing_engine_trigger
+ - /api/v3/configure/processing_engine_trigger/disable
+ - /api/v3/configure/processing_engine_trigger/enable
+ - /api/v3/configure/table
+ - /api/v3/configure/token
+ - /api/v3/configure/token/admin
+ - /api/v3/configure/token/admin/regenerate
+ - /api/v3/configure/token/named_admin
+ menuName: /api/v3/configure
+ title: /api/v3/configure
+ tags:
+ - api-v3
+ - configure
+ apiTags:
+ - Database
+ - Cache data
+ - Table
+ - Authentication
+ - Token
+ - Processing engine
+ source: >-
+ static/openapi/influxdb-influxdb3-enterprise/paths/ref-api-v3-configure.yaml
+ staticFilePath: /openapi/influxdb-influxdb3-enterprise/paths/ref-api-v3-configure.yaml
+ - path: api/v3/engine
+ fields:
+ name: /api/v3/engine
+ describes:
+ - /api/v3/engine/{request_path}
+ menuName: /api/v3/engine
+ title: /api/v3/engine
+ tags:
+ - api-v3
+ - engine
+ apiTags:
+ - Processing engine
+ source: >-
+ static/openapi/influxdb-influxdb3-enterprise/paths/ref-api-v3-engine.yaml
+ staticFilePath: /openapi/influxdb-influxdb3-enterprise/paths/ref-api-v3-engine.yaml
+ - path: api/v3/plugin_test
+ fields:
+ name: /api/v3/plugin_test
+ describes:
+ - /api/v3/plugin_test/schedule
+ - /api/v3/plugin_test/wal
+ menuName: /api/v3/plugin_test
+ title: /api/v3/plugin_test
+ tags:
+ - api-v3
+ - plugin_test
+ apiTags:
+ - Processing engine
+ source: >-
+ static/openapi/influxdb-influxdb3-enterprise/paths/ref-api-v3-plugin_test.yaml
+ staticFilePath: /openapi/influxdb-influxdb3-enterprise/paths/ref-api-v3-plugin_test.yaml
+ - path: api/v3/plugins
+ fields:
+ name: /api/v3/plugins
+ describes:
+ - /api/v3/plugins/directory
+ - /api/v3/plugins/files
+ menuName: /api/v3/plugins
+ title: /api/v3/plugins
+ tags:
+ - api-v3
+ - plugins
+ apiTags:
+ - Processing engine
+ source: >-
+ static/openapi/influxdb-influxdb3-enterprise/paths/ref-api-v3-plugins.yaml
+ staticFilePath: /openapi/influxdb-influxdb3-enterprise/paths/ref-api-v3-plugins.yaml
+ - path: api/v3/query_influxql
+ fields:
+ name: /api/v3/query_influxql
+ describes:
+ - /api/v3/query_influxql
+ menuName: /api/v3/query_influxql
+ title: /api/v3/query_influxql
+ tags:
+ - api-v3
+ - query_influxql
+ apiTags:
+ - Query data
+ source: >-
+ static/openapi/influxdb-influxdb3-enterprise/paths/ref-api-v3-query_influxql.yaml
+ staticFilePath: >-
+ /openapi/influxdb-influxdb3-enterprise/paths/ref-api-v3-query_influxql.yaml
+ - path: api/v3/query_sql
+ fields:
+ name: /api/v3/query_sql
+ describes:
+ - /api/v3/query_sql
+ menuName: /api/v3/query_sql
+ title: /api/v3/query_sql
+ tags:
+ - api-v3
+ - query_sql
+ apiTags:
+ - Query data
+ source: >-
+ static/openapi/influxdb-influxdb3-enterprise/paths/ref-api-v3-query_sql.yaml
+ staticFilePath: /openapi/influxdb-influxdb3-enterprise/paths/ref-api-v3-query_sql.yaml
+ - path: api/v3/show
+ fields:
+ name: /api/v3/show
+ describes:
+ - /api/v3/show/license
+ menuName: /api/v3/show
+ title: /api/v3/show
+ tags:
+ - api-v3
+ - show
+ apiTags:
+ - Server information
+ source: static/openapi/influxdb-influxdb3-enterprise/paths/ref-api-v3-show.yaml
+ staticFilePath: /openapi/influxdb-influxdb3-enterprise/paths/ref-api-v3-show.yaml
+ - path: api/v3/write_lp
+ fields:
+ name: /api/v3/write_lp
+ describes:
+ - /api/v3/write_lp
+ menuName: /api/v3/write_lp
+ title: /api/v3/write_lp
+ tags:
+ - api-v3
+ - write_lp
+ apiTags:
+ - Write data
+ source: >-
+ static/openapi/influxdb-influxdb3-enterprise/paths/ref-api-v3-write_lp.yaml
+ staticFilePath: /openapi/influxdb-influxdb3-enterprise/paths/ref-api-v3-write_lp.yaml
+ - path: api/health
+ fields:
+ name: /health
+ describes:
+ - /health
+ menuName: /health
+ title: /health
+ tags:
+ - ''
+ - health
+ apiTags:
+ - Server information
+ source: static/openapi/influxdb-influxdb3-enterprise/paths/ref-health.yaml
+ staticFilePath: /openapi/influxdb-influxdb3-enterprise/paths/ref-health.yaml
+ - path: api/metrics
+ fields:
+ name: /metrics
+ describes:
+ - /metrics
+ menuName: /metrics
+ title: /metrics
+ tags:
+ - ''
+ - metrics
+ apiTags:
+ - Server information
+ source: static/openapi/influxdb-influxdb3-enterprise/paths/ref-metrics.yaml
+ staticFilePath: /openapi/influxdb-influxdb3-enterprise/paths/ref-metrics.yaml
+ - path: api/ping
+ fields:
+ name: /ping
+ describes:
+ - /ping
+ menuName: /ping
+ title: /ping
+ tags:
+ - ''
+ - ping
+ apiTags:
+ - Server information
+ source: static/openapi/influxdb-influxdb3-enterprise/paths/ref-ping.yaml
+ staticFilePath: /openapi/influxdb-influxdb3-enterprise/paths/ref-ping.yaml
+ - path: api/query
+ fields:
+ name: /query
+ describes:
+ - /query
+ menuName: /query
+ title: /query
+ tags:
+ - ''
+ - query
+ apiTags:
+ - Query data
+ - Compatibility endpoints
+ source: static/openapi/influxdb-influxdb3-enterprise/paths/ref-query.yaml
+ staticFilePath: /openapi/influxdb-influxdb3-enterprise/paths/ref-query.yaml
+ - path: api/write
+ fields:
+ name: /write
+ describes:
+ - /write
+ menuName: /write
+ title: /write
+ tags:
+ - ''
+ - write
+ apiTags:
+ - Compatibility endpoints
+ - Write data
+ source: static/openapi/influxdb-influxdb3-enterprise/paths/ref-write.yaml
+ staticFilePath: /openapi/influxdb-influxdb3-enterprise/paths/ref-write.yaml
diff --git a/data/article_data/influxdb/oss-v2/articles.yml b/data/article_data/influxdb/oss-v2/articles.yml
new file mode 100644
index 000000000..aa37b5a61
--- /dev/null
+++ b/data/article_data/influxdb/oss-v2/articles.yml
@@ -0,0 +1,757 @@
+articles:
+ - path: api/v2/authorizations
+ fields:
+ name: /api/v2/authorizations
+ describes:
+ - /api/v2/authorizations
+ - /api/v2/authorizations/{authID}
+ title: |-
+ /api/v2/authorizations
+ InfluxDB OSS API Service
+ tags:
+ - api-v2
+ - authorizations
+ source: static/openapi/influxdb-oss-v2/paths/ref-api-v2-authorizations.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/paths/ref-api-v2-authorizations.yaml
+ - path: api/v2/backup
+ fields:
+ name: /api/v2/backup
+ describes:
+ - /api/v2/backup/kv
+ - /api/v2/backup/metadata
+ - /api/v2/backup/shards/{shardID}
+ title: |-
+ /api/v2/backup
+ InfluxDB OSS API Service
+ tags:
+ - api-v2
+ - backup
+ source: static/openapi/influxdb-oss-v2/paths/ref-api-v2-backup.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/paths/ref-api-v2-backup.yaml
+ - path: api/v2/buckets
+ fields:
+ name: /api/v2/buckets
+ describes:
+ - /api/v2/buckets
+ - /api/v2/buckets/{bucketID}
+ - /api/v2/buckets/{bucketID}/labels
+ - /api/v2/buckets/{bucketID}/labels/{labelID}
+ - /api/v2/buckets/{bucketID}/members
+ - /api/v2/buckets/{bucketID}/members/{userID}
+ - /api/v2/buckets/{bucketID}/owners
+ - /api/v2/buckets/{bucketID}/owners/{userID}
+ title: |-
+ /api/v2/buckets
+ InfluxDB OSS API Service
+ tags:
+ - api-v2
+ - buckets
+ source: static/openapi/influxdb-oss-v2/paths/ref-api-v2-buckets.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/paths/ref-api-v2-buckets.yaml
+ - path: api/v2/checks
+ fields:
+ name: /api/v2/checks
+ describes:
+ - /api/v2/checks
+ - /api/v2/checks/{checkID}
+ - /api/v2/checks/{checkID}/labels
+ - /api/v2/checks/{checkID}/labels/{labelID}
+ - /api/v2/checks/{checkID}/query
+ title: |-
+ /api/v2/checks
+ InfluxDB OSS API Service
+ tags:
+ - api-v2
+ - checks
+ source: static/openapi/influxdb-oss-v2/paths/ref-api-v2-checks.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/paths/ref-api-v2-checks.yaml
+ - path: api/v2/config
+ fields:
+ name: /api/v2/config
+ describes:
+ - /api/v2/config
+ title: |-
+ /api/v2/config
+ InfluxDB OSS API Service
+ tags:
+ - api-v2
+ - config
+ source: static/openapi/influxdb-oss-v2/paths/ref-api-v2-config.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/paths/ref-api-v2-config.yaml
+ - path: api/v2/dashboards
+ fields:
+ name: /api/v2/dashboards
+ describes:
+ - /api/v2/dashboards
+ - /api/v2/dashboards/{dashboardID}
+ - /api/v2/dashboards/{dashboardID}/cells
+ - /api/v2/dashboards/{dashboardID}/cells/{cellID}
+ - /api/v2/dashboards/{dashboardID}/cells/{cellID}/view
+ - /api/v2/dashboards/{dashboardID}/labels
+ - /api/v2/dashboards/{dashboardID}/labels/{labelID}
+ - /api/v2/dashboards/{dashboardID}/members
+ - /api/v2/dashboards/{dashboardID}/members/{userID}
+ - /api/v2/dashboards/{dashboardID}/owners
+ - /api/v2/dashboards/{dashboardID}/owners/{userID}
+ title: |-
+ /api/v2/dashboards
+ InfluxDB OSS API Service
+ tags:
+ - api-v2
+ - dashboards
+ source: static/openapi/influxdb-oss-v2/paths/ref-api-v2-dashboards.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/paths/ref-api-v2-dashboards.yaml
+ - path: api/v2/dbrps
+ fields:
+ name: /api/v2/dbrps
+ describes:
+ - /api/v2/dbrps
+ - /api/v2/dbrps/{dbrpID}
+ title: |-
+ /api/v2/dbrps
+ InfluxDB OSS API Service
+ tags:
+ - api-v2
+ - dbrps
+ source: static/openapi/influxdb-oss-v2/paths/ref-api-v2-dbrps.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/paths/ref-api-v2-dbrps.yaml
+ - path: api/v2/delete
+ fields:
+ name: /api/v2/delete
+ describes:
+ - /api/v2/delete
+ title: |-
+ /api/v2/delete
+ InfluxDB OSS API Service
+ tags:
+ - api-v2
+ - delete
+ source: static/openapi/influxdb-oss-v2/paths/ref-api-v2-delete.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/paths/ref-api-v2-delete.yaml
+ - path: api/v2/flags
+ fields:
+ name: /api/v2/flags
+ describes:
+ - /api/v2/flags
+ title: |-
+ /api/v2/flags
+ InfluxDB OSS API Service
+ tags:
+ - api-v2
+ - flags
+ source: static/openapi/influxdb-oss-v2/paths/ref-api-v2-flags.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/paths/ref-api-v2-flags.yaml
+ - path: api/v2/labels
+ fields:
+ name: /api/v2/labels
+ describes:
+ - /api/v2/labels
+ - /api/v2/labels/{labelID}
+ title: |-
+ /api/v2/labels
+ InfluxDB OSS API Service
+ tags:
+ - api-v2
+ - labels
+ source: static/openapi/influxdb-oss-v2/paths/ref-api-v2-labels.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/paths/ref-api-v2-labels.yaml
+ - path: api/v2/maps
+ fields:
+ name: /api/v2/maps
+ describes:
+ - /api/v2/maps/mapToken
+ title: |-
+ /api/v2/maps
+ InfluxDB OSS API Service
+ tags:
+ - api-v2
+ - maps
+ source: static/openapi/influxdb-oss-v2/paths/ref-api-v2-maps.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/paths/ref-api-v2-maps.yaml
+ - path: api/v2/me
+ fields:
+ name: /api/v2/me
+ describes:
+ - /api/v2/me
+ - /api/v2/me/password
+ title: |-
+ /api/v2/me
+ InfluxDB OSS API Service
+ tags:
+ - api-v2
+ - me
+ source: static/openapi/influxdb-oss-v2/paths/ref-api-v2-me.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/paths/ref-api-v2-me.yaml
+ - path: api/v2/notificationEndpoints
+ fields:
+ name: /api/v2/notificationEndpoints
+ describes:
+ - /api/v2/notificationEndpoints
+ - /api/v2/notificationEndpoints/{endpointID}
+ - /api/v2/notificationEndpoints/{endpointID}/labels
+ - /api/v2/notificationEndpoints/{endpointID}/labels/{labelID}
+ title: |-
+ /api/v2/notificationEndpoints
+ InfluxDB OSS API Service
+ tags:
+ - api-v2
+ - notificationEndpoints
+ source: >-
+ static/openapi/influxdb-oss-v2/paths/ref-api-v2-notificationEndpoints.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/paths/ref-api-v2-notificationEndpoints.yaml
+ - path: api/v2/notificationRules
+ fields:
+ name: /api/v2/notificationRules
+ describes:
+ - /api/v2/notificationRules
+ - /api/v2/notificationRules/{ruleID}
+ - /api/v2/notificationRules/{ruleID}/labels
+ - /api/v2/notificationRules/{ruleID}/labels/{labelID}
+ - /api/v2/notificationRules/{ruleID}/query
+ title: |-
+ /api/v2/notificationRules
+ InfluxDB OSS API Service
+ tags:
+ - api-v2
+ - notificationRules
+ source: static/openapi/influxdb-oss-v2/paths/ref-api-v2-notificationRules.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/paths/ref-api-v2-notificationRules.yaml
+ - path: api/v2/orgs
+ fields:
+ name: /api/v2/orgs
+ describes:
+ - /api/v2/orgs
+ - /api/v2/orgs/{orgID}
+ - /api/v2/orgs/{orgID}/members
+ - /api/v2/orgs/{orgID}/members/{userID}
+ - /api/v2/orgs/{orgID}/owners
+ - /api/v2/orgs/{orgID}/owners/{userID}
+ - /api/v2/orgs/{orgID}/secrets
+ - /api/v2/orgs/{orgID}/secrets/delete
+ - /api/v2/orgs/{orgID}/secrets/{secretID}
+ title: |-
+ /api/v2/orgs
+ InfluxDB OSS API Service
+ tags:
+ - api-v2
+ - orgs
+ source: static/openapi/influxdb-oss-v2/paths/ref-api-v2-orgs.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/paths/ref-api-v2-orgs.yaml
+ - path: api/v2/query
+ fields:
+ name: /api/v2/query
+ describes:
+ - /api/v2/query
+ - /api/v2/query/analyze
+ - /api/v2/query/ast
+ - /api/v2/query/suggestions
+ - /api/v2/query/suggestions/{name}
+ title: |-
+ /api/v2/query
+ InfluxDB OSS API Service
+ tags:
+ - api-v2
+ - query
+ source: static/openapi/influxdb-oss-v2/paths/ref-api-v2-query.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/paths/ref-api-v2-query.yaml
+ - path: api/v2/remotes
+ fields:
+ name: /api/v2/remotes
+ describes:
+ - /api/v2/remotes
+ - /api/v2/remotes/{remoteID}
+ title: |-
+ /api/v2/remotes
+ InfluxDB OSS API Service
+ tags:
+ - api-v2
+ - remotes
+ source: static/openapi/influxdb-oss-v2/paths/ref-api-v2-remotes.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/paths/ref-api-v2-remotes.yaml
+ - path: api/v2/replications
+ fields:
+ name: /api/v2/replications
+ describes:
+ - /api/v2/replications
+ - /api/v2/replications/{replicationID}
+ - /api/v2/replications/{replicationID}/validate
+ title: |-
+ /api/v2/replications
+ InfluxDB OSS API Service
+ tags:
+ - api-v2
+ - replications
+ source: static/openapi/influxdb-oss-v2/paths/ref-api-v2-replications.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/paths/ref-api-v2-replications.yaml
+ - path: api/v2/resources
+ fields:
+ name: /api/v2/resources
+ describes:
+ - /api/v2/resources
+ title: |-
+ /api/v2/resources
+ InfluxDB OSS API Service
+ tags:
+ - api-v2
+ - resources
+ source: static/openapi/influxdb-oss-v2/paths/ref-api-v2-resources.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/paths/ref-api-v2-resources.yaml
+ - path: api/v2/restore
+ fields:
+ name: /api/v2/restore
+ describes:
+ - /api/v2/restore/bucket/{bucketID}
+ - /api/v2/restore/bucketMetadata
+ - /api/v2/restore/kv
+ - /api/v2/restore/shards/{shardID}
+ - /api/v2/restore/sql
+ title: |-
+ /api/v2/restore
+ InfluxDB OSS API Service
+ tags:
+ - api-v2
+ - restore
+ source: static/openapi/influxdb-oss-v2/paths/ref-api-v2-restore.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/paths/ref-api-v2-restore.yaml
+ - path: api/v2/scrapers
+ fields:
+ name: /api/v2/scrapers
+ describes:
+ - /api/v2/scrapers
+ - /api/v2/scrapers/{scraperTargetID}
+ - /api/v2/scrapers/{scraperTargetID}/labels
+ - /api/v2/scrapers/{scraperTargetID}/labels/{labelID}
+ - /api/v2/scrapers/{scraperTargetID}/members
+ - /api/v2/scrapers/{scraperTargetID}/members/{userID}
+ - /api/v2/scrapers/{scraperTargetID}/owners
+ - /api/v2/scrapers/{scraperTargetID}/owners/{userID}
+ title: |-
+ /api/v2/scrapers
+ InfluxDB OSS API Service
+ tags:
+ - api-v2
+ - scrapers
+ source: static/openapi/influxdb-oss-v2/paths/ref-api-v2-scrapers.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/paths/ref-api-v2-scrapers.yaml
+ - path: api/v2/setup
+ fields:
+ name: /api/v2/setup
+ describes:
+ - /api/v2/setup
+ title: |-
+ /api/v2/setup
+ InfluxDB OSS API Service
+ tags:
+ - api-v2
+ - setup
+ source: static/openapi/influxdb-oss-v2/paths/ref-api-v2-setup.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/paths/ref-api-v2-setup.yaml
+ - path: api/v2/signin
+ fields:
+ name: /api/v2/signin
+ describes:
+ - /api/v2/signin
+ title: |-
+ /api/v2/signin
+ InfluxDB OSS API Service
+ tags:
+ - api-v2
+ - signin
+ source: static/openapi/influxdb-oss-v2/paths/ref-api-v2-signin.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/paths/ref-api-v2-signin.yaml
+ - path: api/v2/signout
+ fields:
+ name: /api/v2/signout
+ describes:
+ - /api/v2/signout
+ title: |-
+ /api/v2/signout
+ InfluxDB OSS API Service
+ tags:
+ - api-v2
+ - signout
+ source: static/openapi/influxdb-oss-v2/paths/ref-api-v2-signout.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/paths/ref-api-v2-signout.yaml
+ - path: api/v2/sources
+ fields:
+ name: /api/v2/sources
+ describes:
+ - /api/v2/sources
+ - /api/v2/sources/{sourceID}
+ - /api/v2/sources/{sourceID}/buckets
+ - /api/v2/sources/{sourceID}/health
+ title: |-
+ /api/v2/sources
+ InfluxDB OSS API Service
+ tags:
+ - api-v2
+ - sources
+ source: static/openapi/influxdb-oss-v2/paths/ref-api-v2-sources.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/paths/ref-api-v2-sources.yaml
+ - path: api/v2/stacks
+ fields:
+ name: /api/v2/stacks
+ describes:
+ - /api/v2/stacks
+ - /api/v2/stacks/{stack_id}
+ - /api/v2/stacks/{stack_id}/uninstall
+ title: |-
+ /api/v2/stacks
+ InfluxDB OSS API Service
+ tags:
+ - api-v2
+ - stacks
+ source: static/openapi/influxdb-oss-v2/paths/ref-api-v2-stacks.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/paths/ref-api-v2-stacks.yaml
+ - path: api/v2/tasks
+ fields:
+ name: /api/v2/tasks
+ describes:
+ - /api/v2/tasks
+ - /api/v2/tasks/{taskID}
+ - /api/v2/tasks/{taskID}/labels
+ - /api/v2/tasks/{taskID}/labels/{labelID}
+ - /api/v2/tasks/{taskID}/logs
+ - /api/v2/tasks/{taskID}/members
+ - /api/v2/tasks/{taskID}/members/{userID}
+ - /api/v2/tasks/{taskID}/owners
+ - /api/v2/tasks/{taskID}/owners/{userID}
+ - /api/v2/tasks/{taskID}/runs
+ - /api/v2/tasks/{taskID}/runs/{runID}
+ - /api/v2/tasks/{taskID}/runs/{runID}/logs
+ - /api/v2/tasks/{taskID}/runs/{runID}/retry
+ title: |-
+ /api/v2/tasks
+ InfluxDB OSS API Service
+ tags:
+ - api-v2
+ - tasks
+ source: static/openapi/influxdb-oss-v2/paths/ref-api-v2-tasks.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/paths/ref-api-v2-tasks.yaml
+ - path: api/v2/telegraf
+ fields:
+ name: /api/v2/telegraf
+ describes:
+ - /api/v2/telegraf/plugins
+ title: |-
+ /api/v2/telegraf
+ InfluxDB OSS API Service
+ tags:
+ - api-v2
+ - telegraf
+ source: static/openapi/influxdb-oss-v2/paths/ref-api-v2-telegraf.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/paths/ref-api-v2-telegraf.yaml
+ - path: api/v2/telegrafs
+ fields:
+ name: /api/v2/telegrafs
+ describes:
+ - /api/v2/telegrafs
+ - /api/v2/telegrafs/{telegrafID}
+ - /api/v2/telegrafs/{telegrafID}/labels
+ - /api/v2/telegrafs/{telegrafID}/labels/{labelID}
+ - /api/v2/telegrafs/{telegrafID}/members
+ - /api/v2/telegrafs/{telegrafID}/members/{userID}
+ - /api/v2/telegrafs/{telegrafID}/owners
+ - /api/v2/telegrafs/{telegrafID}/owners/{userID}
+ title: |-
+ /api/v2/telegrafs
+ InfluxDB OSS API Service
+ tags:
+ - api-v2
+ - telegrafs
+ source: static/openapi/influxdb-oss-v2/paths/ref-api-v2-telegrafs.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/paths/ref-api-v2-telegrafs.yaml
+ - path: api/v2/templates
+ fields:
+ name: /api/v2/templates
+ describes:
+ - /api/v2/templates/apply
+ - /api/v2/templates/export
+ title: |-
+ /api/v2/templates
+ InfluxDB OSS API Service
+ tags:
+ - api-v2
+ - templates
+ source: static/openapi/influxdb-oss-v2/paths/ref-api-v2-templates.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/paths/ref-api-v2-templates.yaml
+ - path: api/v2/users
+ fields:
+ name: /api/v2/users
+ describes:
+ - /api/v2/users
+ - /api/v2/users/{userID}
+ - /api/v2/users/{userID}/password
+ title: |-
+ /api/v2/users
+ InfluxDB OSS API Service
+ tags:
+ - api-v2
+ - users
+ source: static/openapi/influxdb-oss-v2/paths/ref-api-v2-users.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/paths/ref-api-v2-users.yaml
+ - path: api/v2/variables
+ fields:
+ name: /api/v2/variables
+ describes:
+ - /api/v2/variables
+ - /api/v2/variables/{variableID}
+ - /api/v2/variables/{variableID}/labels
+ - /api/v2/variables/{variableID}/labels/{labelID}
+ title: |-
+ /api/v2/variables
+ InfluxDB OSS API Service
+ tags:
+ - api-v2
+ - variables
+ source: static/openapi/influxdb-oss-v2/paths/ref-api-v2-variables.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/paths/ref-api-v2-variables.yaml
+ - path: api/v2/write
+ fields:
+ name: /api/v2/write
+ describes:
+ - /api/v2/write
+ title: |-
+ /api/v2/write
+ InfluxDB OSS API Service
+ tags:
+ - api-v2
+ - write
+ source: static/openapi/influxdb-oss-v2/paths/ref-api-v2-write.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/paths/ref-api-v2-write.yaml
+ - path: api/v2
+ fields:
+ name: /api/v2
+ describes:
+ - /api/v2
+ title: |-
+ /api/v2
+ InfluxDB OSS API Service
+ tags:
+ - api
+ - v2
+ source: static/openapi/influxdb-oss-v2/paths/ref-api-v2.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/paths/ref-api-v2.yaml
+ - path: debug/pprof/all
+ fields:
+ name: /debug/pprof/all
+ describes:
+ - /debug/pprof/all
+ title: |-
+ /debug/pprof/all
+ InfluxDB OSS API Service
+ tags:
+ - debug-pprof
+ - all
+ source: static/openapi/influxdb-oss-v2/paths/ref-debug-pprof-all.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/paths/ref-debug-pprof-all.yaml
+ - path: debug/pprof/allocs
+ fields:
+ name: /debug/pprof/allocs
+ describes:
+ - /debug/pprof/allocs
+ title: |-
+ /debug/pprof/allocs
+ InfluxDB OSS API Service
+ tags:
+ - debug-pprof
+ - allocs
+ source: static/openapi/influxdb-oss-v2/paths/ref-debug-pprof-allocs.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/paths/ref-debug-pprof-allocs.yaml
+ - path: debug/pprof/block
+ fields:
+ name: /debug/pprof/block
+ describes:
+ - /debug/pprof/block
+ title: |-
+ /debug/pprof/block
+ InfluxDB OSS API Service
+ tags:
+ - debug-pprof
+ - block
+ source: static/openapi/influxdb-oss-v2/paths/ref-debug-pprof-block.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/paths/ref-debug-pprof-block.yaml
+ - path: debug/pprof/cmdline
+ fields:
+ name: /debug/pprof/cmdline
+ describes:
+ - /debug/pprof/cmdline
+ title: |-
+ /debug/pprof/cmdline
+ InfluxDB OSS API Service
+ tags:
+ - debug-pprof
+ - cmdline
+ source: static/openapi/influxdb-oss-v2/paths/ref-debug-pprof-cmdline.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/paths/ref-debug-pprof-cmdline.yaml
+ - path: debug/pprof/goroutine
+ fields:
+ name: /debug/pprof/goroutine
+ describes:
+ - /debug/pprof/goroutine
+ title: |-
+ /debug/pprof/goroutine
+ InfluxDB OSS API Service
+ tags:
+ - debug-pprof
+ - goroutine
+ source: static/openapi/influxdb-oss-v2/paths/ref-debug-pprof-goroutine.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/paths/ref-debug-pprof-goroutine.yaml
+ - path: debug/pprof/heap
+ fields:
+ name: /debug/pprof/heap
+ describes:
+ - /debug/pprof/heap
+ title: |-
+ /debug/pprof/heap
+ InfluxDB OSS API Service
+ tags:
+ - debug-pprof
+ - heap
+ source: static/openapi/influxdb-oss-v2/paths/ref-debug-pprof-heap.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/paths/ref-debug-pprof-heap.yaml
+ - path: debug/pprof/mutex
+ fields:
+ name: /debug/pprof/mutex
+ describes:
+ - /debug/pprof/mutex
+ title: |-
+ /debug/pprof/mutex
+ InfluxDB OSS API Service
+ tags:
+ - debug-pprof
+ - mutex
+ source: static/openapi/influxdb-oss-v2/paths/ref-debug-pprof-mutex.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/paths/ref-debug-pprof-mutex.yaml
+ - path: debug/pprof/profile
+ fields:
+ name: /debug/pprof/profile
+ describes:
+ - /debug/pprof/profile
+ title: |-
+ /debug/pprof/profile
+ InfluxDB OSS API Service
+ tags:
+ - debug-pprof
+ - profile
+ source: static/openapi/influxdb-oss-v2/paths/ref-debug-pprof-profile.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/paths/ref-debug-pprof-profile.yaml
+ - path: debug/pprof/threadcreate
+ fields:
+ name: /debug/pprof/threadcreate
+ describes:
+ - /debug/pprof/threadcreate
+ title: |-
+ /debug/pprof/threadcreate
+ InfluxDB OSS API Service
+ tags:
+ - debug-pprof
+ - threadcreate
+ source: static/openapi/influxdb-oss-v2/paths/ref-debug-pprof-threadcreate.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/paths/ref-debug-pprof-threadcreate.yaml
+ - path: debug/pprof/trace
+ fields:
+ name: /debug/pprof/trace
+ describes:
+ - /debug/pprof/trace
+ title: |-
+ /debug/pprof/trace
+ InfluxDB OSS API Service
+ tags:
+ - debug-pprof
+ - trace
+ source: static/openapi/influxdb-oss-v2/paths/ref-debug-pprof-trace.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/paths/ref-debug-pprof-trace.yaml
+ - path: health
+ fields:
+ name: /health
+ describes:
+ - /health
+ title: |-
+ /health
+ InfluxDB OSS API Service
+ tags:
+ - ''
+ - health
+ source: static/openapi/influxdb-oss-v2/paths/ref-health.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/paths/ref-health.yaml
+ - path: legacy/authorizations
+ fields:
+ name: /legacy/authorizations
+ describes:
+ - /legacy/authorizations
+ - /legacy/authorizations/{authID}
+ - /legacy/authorizations/{authID}/password
+ title: |-
+ /legacy/authorizations
+ InfluxDB OSS API Service
+ tags:
+ - legacy
+ - authorizations
+ source: static/openapi/influxdb-oss-v2/paths/ref-legacy-authorizations.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/paths/ref-legacy-authorizations.yaml
+ - path: metrics
+ fields:
+ name: /metrics
+ describes:
+ - /metrics
+ title: |-
+ /metrics
+ InfluxDB OSS API Service
+ tags:
+ - ''
+ - metrics
+ source: static/openapi/influxdb-oss-v2/paths/ref-metrics.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/paths/ref-metrics.yaml
+ - path: ping
+ fields:
+ name: /ping
+ describes:
+ - /ping
+ title: |-
+ /ping
+ InfluxDB OSS API Service
+ tags:
+ - ''
+ - ping
+ source: static/openapi/influxdb-oss-v2/paths/ref-ping.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/paths/ref-ping.yaml
+ - path: query
+ fields:
+ name: /query
+ describes:
+ - /query
+ title: |-
+ /query
+ InfluxDB OSS API Service
+ tags:
+ - ''
+ - query
+ source: static/openapi/influxdb-oss-v2/paths/ref-query.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/paths/ref-query.yaml
+ - path: ready
+ fields:
+ name: /ready
+ describes:
+ - /ready
+ title: |-
+ /ready
+ InfluxDB OSS API Service
+ tags:
+ - ''
+ - ready
+ source: static/openapi/influxdb-oss-v2/paths/ref-ready.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/paths/ref-ready.yaml
+ - path: write
+ fields:
+ name: /write
+ describes:
+ - /write
+ title: |-
+ /write
+ InfluxDB OSS API Service
+ tags:
+ - ''
+ - write
+ source: static/openapi/influxdb-oss-v2/paths/ref-write.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/paths/ref-write.yaml
diff --git a/layouts/partials/api/sidebar-nav.html b/layouts/partials/api/sidebar-nav.html
new file mode 100644
index 000000000..0acb89d75
--- /dev/null
+++ b/layouts/partials/api/sidebar-nav.html
@@ -0,0 +1,244 @@
+{{/*
+ API Reference Navigation for Sidebar
+
+ Displays a collapsible navigation tree for API endpoints,
+ organized by functional groups defined in data/api_nav_groups.yml.
+
+ Uses Hugo data from data/article-data/ to build navigation.
+ Supports both tag-based (new) and path-based (legacy) article data.
+*/}}
+
+{{/* Get product path data for data lookup */}}
+{{ $productPathData := findRE "[^/]+.*?" .RelPermalink }}
+{{ $product := index $productPathData 0 }}
+{{ $version := index $productPathData 1 }}
+
+{{/* Build data key for article data lookup */}}
+{{/* Hugo converts hyphens to underscores in data file keys */}}
+{{ $dataKey := "" }}
+{{ if eq $product "influxdb3" }}
+ {{ $dataKey = print "influxdb3_" $version }}
+{{ else if eq $product "influxdb" }}
+ {{ $dataKey = print $version }}
+{{ else }}
+ {{ $dataKey = $product }}
+{{ end }}
+
+{{/* Get article data for this product */}}
+{{/*
+ Hugo data path: data/article_data/influxdb/influxdb3_core/articles.yml
+ Access: .Site.Data.article_data.influxdb.influxdb3_core.articles.articles
+
+ The double "articles" is because:
+ - First "articles" is the filename (articles.yml)
+ - Second "articles" is the key inside the YAML file
+*/}}
+{{ $articles := slice }}
+{{ with .Site.Data.article_data }}
+ {{ with index . "influxdb" }}
+ {{ with index . $dataKey }}
+ {{ with index . "articles" }}
+ {{ with index . "articles" }}
+ {{ $articles = . }}
+ {{ end }}
+ {{ end }}
+ {{ end }}
+ {{ end }}
+{{ end }}
+
+{{/* Get navigation groups configuration */}}
+{{ $navGroups := .Site.Data.api_nav_groups.groups }}
+
+{{/* Check if articles use tag-based structure */}}
+{{ $isTagBased := false }}
+{{ if gt (len $articles) 0 }}
+ {{ $firstArticle := index $articles 0 }}
+ {{ if reflect.IsMap $firstArticle }}
+ {{ with index $firstArticle "fields" }}
+ {{ if reflect.IsMap . }}
+ {{ if isset . "tag" }}
+ {{ $isTagBased = true }}
+ {{ end }}
+ {{ end }}
+ {{ end }}
+ {{ end }}
+{{ end }}
+
+{{ if and (gt (len $articles) 0) $navGroups $isTagBased }}
+{{/* Tag-based navigation */}}
+
+{{ else if gt (len $articles) 0 }}
+{{/* Legacy path-based navigation (fallback) */}}
+
+{{ end }}