From eb6feb75d273d45ca0c224d5fdb56566643be116 Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Thu, 8 Jan 2026 10:56:05 -0600 Subject: [PATCH] fix(api): remove curly braces from URL paths and clean up section pages MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Fix apiPathToSlug() to strip curly braces from path parameters (e.g., {db} → db) to avoid URL encoding issues in Hugo - Update Quick start tag description to include intro sentence: "Authenticate, write, and query with the API:" - Remove {{< children >}} shortcode from API section _index.md files (layout's section-children.html partial already handles tag listing) - Delete old cloud-serverless API pages with curly braces in paths - Regenerate article data for all products --- api-docs/influxdb3/core/v3/ref.yml | 2 + api-docs/influxdb3/enterprise/v3/ref.yml | 2 + .../scripts/dist/generate-openapi-articles.js | 30 +- api-docs/scripts/generate-openapi-articles.ts | 6 + .../influxdb3/cloud-serverless/api/_index.md | 2 - .../authorizations/{authID}/delete/_index.md | 12 - .../v2/authorizations/{authID}/get/_index.md | 12 - .../authorizations/{authID}/patch/_index.md | 12 - .../v2/buckets/{bucketID}/delete/_index.md | 12 - .../api/v2/buckets/{bucketID}/get/_index.md | 12 - .../buckets/{bucketID}/labels/get/_index.md | 12 - .../buckets/{bucketID}/labels/post/_index.md | 12 - .../labels/{labelID}/delete/_index.md | 13 - .../buckets/{bucketID}/members/get/_index.md | 12 - .../buckets/{bucketID}/members/post/_index.md | 12 - .../members/{userID}/delete/_index.md | 13 - .../buckets/{bucketID}/owners/get/_index.md | 12 - .../buckets/{bucketID}/owners/post/_index.md | 12 - .../owners/{userID}/delete/_index.md | 13 - .../api/v2/buckets/{bucketID}/patch/_index.md | 12 - .../schema/measurements/get/_index.md | 13 - .../schema/measurements/post/_index.md | 13 - .../{measurementID}/get/_index.md | 15 - .../{measurementID}/patch/_index.md | 15 - .../api/v2/dbrps/{dbrpID}/delete/_index.md | 12 - .../api/v2/dbrps/{dbrpID}/get/_index.md | 12 - .../api/v2/dbrps/{dbrpID}/patch/_index.md | 12 - .../api/v2/orgs/{orgID}/delete/_index.md | 12 - .../api/v2/orgs/{orgID}/get/_index.md | 12 - .../api/v2/orgs/{orgID}/limits/get/_index.md | 12 - .../api/v2/orgs/{orgID}/members/get/_index.md | 12 - .../v2/orgs/{orgID}/members/post/_index.md | 12 - .../{orgID}/members/{userID}/delete/_index.md | 12 - .../api/v2/orgs/{orgID}/owners/get/_index.md | 12 - .../api/v2/orgs/{orgID}/owners/post/_index.md | 12 - .../{orgID}/owners/{userID}/delete/_index.md | 12 - .../api/v2/orgs/{orgID}/patch/_index.md | 12 - .../{orgID}/secrets/delete/post/_index.md | 12 - .../api/v2/orgs/{orgID}/secrets/get/_index.md | 12 - .../v2/orgs/{orgID}/secrets/patch/_index.md | 12 - .../secrets/{secretID}/delete/_index.md | 13 - .../api/v2/orgs/{orgID}/usage/get/_index.md | 12 - .../v2/query/suggestions/{name}/get/_index.md | 12 - .../v2/scripts/{scriptID}/delete/_index.md | 12 - .../api/v2/scripts/{scriptID}/get/_index.md | 12 - .../scripts/{scriptID}/invoke/post/_index.md | 12 - .../scripts/{scriptID}/params/get/_index.md | 12 - .../api/v2/scripts/{scriptID}/patch/_index.md | 12 - .../api/v2/stacks/{stack_id}/delete/_index.md | 12 - .../api/v2/stacks/{stack_id}/get/_index.md | 12 - .../api/v2/stacks/{stack_id}/patch/_index.md | 12 - .../{stack_id}/uninstall/post/_index.md | 12 - .../api/v2/tasks/{taskID}/delete/_index.md | 12 - .../api/v2/tasks/{taskID}/get/_index.md | 12 - .../v2/tasks/{taskID}/labels/get/_index.md | 12 - .../v2/tasks/{taskID}/labels/post/_index.md | 12 - .../labels/{labelID}/delete/_index.md | 13 - .../api/v2/tasks/{taskID}/logs/get/_index.md | 12 - .../v2/tasks/{taskID}/members/get/_index.md | 12 - .../v2/tasks/{taskID}/members/post/_index.md | 12 - .../members/{userID}/delete/_index.md | 13 - .../v2/tasks/{taskID}/owners/get/_index.md | 12 - .../v2/tasks/{taskID}/owners/post/_index.md | 12 - .../{taskID}/owners/{userID}/delete/_index.md | 13 - .../api/v2/tasks/{taskID}/patch/_index.md | 12 - .../api/v2/tasks/{taskID}/runs/get/_index.md | 12 - .../api/v2/tasks/{taskID}/runs/post/_index.md | 12 - .../{taskID}/runs/{runID}/delete/_index.md | 12 - .../tasks/{taskID}/runs/{runID}/get/_index.md | 12 - .../{taskID}/runs/{runID}/logs/get/_index.md | 13 - .../runs/{runID}/retry/post/_index.md | 13 - .../telegrafs/{telegrafID}/delete/_index.md | 12 - .../v2/telegrafs/{telegrafID}/get/_index.md | 12 - .../{telegrafID}/labels/get/_index.md | 13 - .../{telegrafID}/labels/post/_index.md | 13 - .../labels/{labelID}/delete/_index.md | 13 - .../{telegrafID}/members/get/_index.md | 13 - .../{telegrafID}/members/post/_index.md | 13 - .../members/{userID}/delete/_index.md | 13 - .../{telegrafID}/owners/get/_index.md | 13 - .../{telegrafID}/owners/post/_index.md | 13 - .../owners/{userID}/delete/_index.md | 13 - .../v2/telegrafs/{telegrafID}/put/_index.md | 12 - .../variables/{variableID}/delete/_index.md | 12 - .../v2/variables/{variableID}/get/_index.md | 12 - .../{variableID}/labels/get/_index.md | 13 - .../{variableID}/labels/post/_index.md | 13 - .../labels/{labelID}/delete/_index.md | 13 - .../v2/variables/{variableID}/patch/_index.md | 12 - .../v2/variables/{variableID}/put/_index.md | 12 - .../influxdb/cloud-dedicated/articles.json | 188 ++++- .../influxdb/cloud-dedicated/articles.yml | 688 +++++++++++++++++- .../influxdb/clustered/articles.json | 196 ++++- .../influxdb/clustered/articles.yml | 649 ++++++++++++++++- .../influxdb/influxdb3_core/articles.json | 4 +- .../influxdb/influxdb3_core/articles.yml | 6 + .../influxdb3_enterprise/articles.json | 4 +- .../influxdb3_enterprise/articles.yml | 6 + 98 files changed, 1661 insertions(+), 1171 deletions(-) delete mode 100644 content/influxdb3/cloud-serverless/api/v2/authorizations/{authID}/delete/_index.md delete mode 100644 content/influxdb3/cloud-serverless/api/v2/authorizations/{authID}/get/_index.md delete mode 100644 content/influxdb3/cloud-serverless/api/v2/authorizations/{authID}/patch/_index.md delete mode 100644 content/influxdb3/cloud-serverless/api/v2/buckets/{bucketID}/delete/_index.md delete mode 100644 content/influxdb3/cloud-serverless/api/v2/buckets/{bucketID}/get/_index.md delete mode 100644 content/influxdb3/cloud-serverless/api/v2/buckets/{bucketID}/labels/get/_index.md delete mode 100644 content/influxdb3/cloud-serverless/api/v2/buckets/{bucketID}/labels/post/_index.md delete mode 100644 content/influxdb3/cloud-serverless/api/v2/buckets/{bucketID}/labels/{labelID}/delete/_index.md delete mode 100644 content/influxdb3/cloud-serverless/api/v2/buckets/{bucketID}/members/get/_index.md delete mode 100644 content/influxdb3/cloud-serverless/api/v2/buckets/{bucketID}/members/post/_index.md delete mode 100644 content/influxdb3/cloud-serverless/api/v2/buckets/{bucketID}/members/{userID}/delete/_index.md delete mode 100644 content/influxdb3/cloud-serverless/api/v2/buckets/{bucketID}/owners/get/_index.md delete mode 100644 content/influxdb3/cloud-serverless/api/v2/buckets/{bucketID}/owners/post/_index.md delete mode 100644 content/influxdb3/cloud-serverless/api/v2/buckets/{bucketID}/owners/{userID}/delete/_index.md delete mode 100644 content/influxdb3/cloud-serverless/api/v2/buckets/{bucketID}/patch/_index.md delete mode 100644 content/influxdb3/cloud-serverless/api/v2/buckets/{bucketID}/schema/measurements/get/_index.md delete mode 100644 content/influxdb3/cloud-serverless/api/v2/buckets/{bucketID}/schema/measurements/post/_index.md delete mode 100644 content/influxdb3/cloud-serverless/api/v2/buckets/{bucketID}/schema/measurements/{measurementID}/get/_index.md delete mode 100644 content/influxdb3/cloud-serverless/api/v2/buckets/{bucketID}/schema/measurements/{measurementID}/patch/_index.md delete mode 100644 content/influxdb3/cloud-serverless/api/v2/dbrps/{dbrpID}/delete/_index.md delete mode 100644 content/influxdb3/cloud-serverless/api/v2/dbrps/{dbrpID}/get/_index.md delete mode 100644 content/influxdb3/cloud-serverless/api/v2/dbrps/{dbrpID}/patch/_index.md delete mode 100644 content/influxdb3/cloud-serverless/api/v2/orgs/{orgID}/delete/_index.md delete mode 100644 content/influxdb3/cloud-serverless/api/v2/orgs/{orgID}/get/_index.md delete mode 100644 content/influxdb3/cloud-serverless/api/v2/orgs/{orgID}/limits/get/_index.md delete mode 100644 content/influxdb3/cloud-serverless/api/v2/orgs/{orgID}/members/get/_index.md delete mode 100644 content/influxdb3/cloud-serverless/api/v2/orgs/{orgID}/members/post/_index.md delete mode 100644 content/influxdb3/cloud-serverless/api/v2/orgs/{orgID}/members/{userID}/delete/_index.md delete mode 100644 content/influxdb3/cloud-serverless/api/v2/orgs/{orgID}/owners/get/_index.md delete mode 100644 content/influxdb3/cloud-serverless/api/v2/orgs/{orgID}/owners/post/_index.md delete mode 100644 content/influxdb3/cloud-serverless/api/v2/orgs/{orgID}/owners/{userID}/delete/_index.md delete mode 100644 content/influxdb3/cloud-serverless/api/v2/orgs/{orgID}/patch/_index.md delete mode 100644 content/influxdb3/cloud-serverless/api/v2/orgs/{orgID}/secrets/delete/post/_index.md delete mode 100644 content/influxdb3/cloud-serverless/api/v2/orgs/{orgID}/secrets/get/_index.md delete mode 100644 content/influxdb3/cloud-serverless/api/v2/orgs/{orgID}/secrets/patch/_index.md delete mode 100644 content/influxdb3/cloud-serverless/api/v2/orgs/{orgID}/secrets/{secretID}/delete/_index.md delete mode 100644 content/influxdb3/cloud-serverless/api/v2/orgs/{orgID}/usage/get/_index.md delete mode 100644 content/influxdb3/cloud-serverless/api/v2/query/suggestions/{name}/get/_index.md delete mode 100644 content/influxdb3/cloud-serverless/api/v2/scripts/{scriptID}/delete/_index.md delete mode 100644 content/influxdb3/cloud-serverless/api/v2/scripts/{scriptID}/get/_index.md delete mode 100644 content/influxdb3/cloud-serverless/api/v2/scripts/{scriptID}/invoke/post/_index.md delete mode 100644 content/influxdb3/cloud-serverless/api/v2/scripts/{scriptID}/params/get/_index.md delete mode 100644 content/influxdb3/cloud-serverless/api/v2/scripts/{scriptID}/patch/_index.md delete mode 100644 content/influxdb3/cloud-serverless/api/v2/stacks/{stack_id}/delete/_index.md delete mode 100644 content/influxdb3/cloud-serverless/api/v2/stacks/{stack_id}/get/_index.md delete mode 100644 content/influxdb3/cloud-serverless/api/v2/stacks/{stack_id}/patch/_index.md delete mode 100644 content/influxdb3/cloud-serverless/api/v2/stacks/{stack_id}/uninstall/post/_index.md delete mode 100644 content/influxdb3/cloud-serverless/api/v2/tasks/{taskID}/delete/_index.md delete mode 100644 content/influxdb3/cloud-serverless/api/v2/tasks/{taskID}/get/_index.md delete mode 100644 content/influxdb3/cloud-serverless/api/v2/tasks/{taskID}/labels/get/_index.md delete mode 100644 content/influxdb3/cloud-serverless/api/v2/tasks/{taskID}/labels/post/_index.md delete mode 100644 content/influxdb3/cloud-serverless/api/v2/tasks/{taskID}/labels/{labelID}/delete/_index.md delete mode 100644 content/influxdb3/cloud-serverless/api/v2/tasks/{taskID}/logs/get/_index.md delete mode 100644 content/influxdb3/cloud-serverless/api/v2/tasks/{taskID}/members/get/_index.md delete mode 100644 content/influxdb3/cloud-serverless/api/v2/tasks/{taskID}/members/post/_index.md delete mode 100644 content/influxdb3/cloud-serverless/api/v2/tasks/{taskID}/members/{userID}/delete/_index.md delete mode 100644 content/influxdb3/cloud-serverless/api/v2/tasks/{taskID}/owners/get/_index.md delete mode 100644 content/influxdb3/cloud-serverless/api/v2/tasks/{taskID}/owners/post/_index.md delete mode 100644 content/influxdb3/cloud-serverless/api/v2/tasks/{taskID}/owners/{userID}/delete/_index.md delete mode 100644 content/influxdb3/cloud-serverless/api/v2/tasks/{taskID}/patch/_index.md delete mode 100644 content/influxdb3/cloud-serverless/api/v2/tasks/{taskID}/runs/get/_index.md delete mode 100644 content/influxdb3/cloud-serverless/api/v2/tasks/{taskID}/runs/post/_index.md delete mode 100644 content/influxdb3/cloud-serverless/api/v2/tasks/{taskID}/runs/{runID}/delete/_index.md delete mode 100644 content/influxdb3/cloud-serverless/api/v2/tasks/{taskID}/runs/{runID}/get/_index.md delete mode 100644 content/influxdb3/cloud-serverless/api/v2/tasks/{taskID}/runs/{runID}/logs/get/_index.md delete mode 100644 content/influxdb3/cloud-serverless/api/v2/tasks/{taskID}/runs/{runID}/retry/post/_index.md delete mode 100644 content/influxdb3/cloud-serverless/api/v2/telegrafs/{telegrafID}/delete/_index.md delete mode 100644 content/influxdb3/cloud-serverless/api/v2/telegrafs/{telegrafID}/get/_index.md delete mode 100644 content/influxdb3/cloud-serverless/api/v2/telegrafs/{telegrafID}/labels/get/_index.md delete mode 100644 content/influxdb3/cloud-serverless/api/v2/telegrafs/{telegrafID}/labels/post/_index.md delete mode 100644 content/influxdb3/cloud-serverless/api/v2/telegrafs/{telegrafID}/labels/{labelID}/delete/_index.md delete mode 100644 content/influxdb3/cloud-serverless/api/v2/telegrafs/{telegrafID}/members/get/_index.md delete mode 100644 content/influxdb3/cloud-serverless/api/v2/telegrafs/{telegrafID}/members/post/_index.md delete mode 100644 content/influxdb3/cloud-serverless/api/v2/telegrafs/{telegrafID}/members/{userID}/delete/_index.md delete mode 100644 content/influxdb3/cloud-serverless/api/v2/telegrafs/{telegrafID}/owners/get/_index.md delete mode 100644 content/influxdb3/cloud-serverless/api/v2/telegrafs/{telegrafID}/owners/post/_index.md delete mode 100644 content/influxdb3/cloud-serverless/api/v2/telegrafs/{telegrafID}/owners/{userID}/delete/_index.md delete mode 100644 content/influxdb3/cloud-serverless/api/v2/telegrafs/{telegrafID}/put/_index.md delete mode 100644 content/influxdb3/cloud-serverless/api/v2/variables/{variableID}/delete/_index.md delete mode 100644 content/influxdb3/cloud-serverless/api/v2/variables/{variableID}/get/_index.md delete mode 100644 content/influxdb3/cloud-serverless/api/v2/variables/{variableID}/labels/get/_index.md delete mode 100644 content/influxdb3/cloud-serverless/api/v2/variables/{variableID}/labels/post/_index.md delete mode 100644 content/influxdb3/cloud-serverless/api/v2/variables/{variableID}/labels/{labelID}/delete/_index.md delete mode 100644 content/influxdb3/cloud-serverless/api/v2/variables/{variableID}/patch/_index.md delete mode 100644 content/influxdb3/cloud-serverless/api/v2/variables/{variableID}/put/_index.md diff --git a/api-docs/influxdb3/core/v3/ref.yml b/api-docs/influxdb3/core/v3/ref.yml index 422abdffc..2bdbdbd6d 100644 --- a/api-docs/influxdb3/core/v3/ref.yml +++ b/api-docs/influxdb3/core/v3/ref.yml @@ -141,6 +141,8 @@ tags: description: Query data using SQL or InfluxQL - name: Quick start description: | + Authenticate, write, and query with the API: + 1. [Create an admin token](#section/Authentication) to authorize API requests. ```bash diff --git a/api-docs/influxdb3/enterprise/v3/ref.yml b/api-docs/influxdb3/enterprise/v3/ref.yml index 71d490893..1d1f8a13e 100644 --- a/api-docs/influxdb3/enterprise/v3/ref.yml +++ b/api-docs/influxdb3/enterprise/v3/ref.yml @@ -118,6 +118,8 @@ tags: description: Query data using SQL or InfluxQL - name: Quick start description: | + Authenticate, write, and query with the API: + 1. [Create an admin token](#section/Authentication) to authorize API requests. ```bash curl -X POST "http://localhost:8181/api/v3/configure/token/admin" diff --git a/api-docs/scripts/dist/generate-openapi-articles.js b/api-docs/scripts/dist/generate-openapi-articles.js index e3152c3c7..c75a0aefb 100644 --- a/api-docs/scripts/dist/generate-openapi-articles.js +++ b/api-docs/scripts/dist/generate-openapi-articles.js @@ -36,13 +36,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? ( }) : function(o, v) { o["default"] = v; }); -var __importStar = (this && this.__importStar) || function (mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k); - __setModuleDefault(result, mod); - return result; -}; +var __importStar = (this && this.__importStar) || (function () { + var ownKeys = function(o) { + ownKeys = Object.getOwnPropertyNames || function (o) { + var ar = []; + for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k; + return ar; + }; + return ownKeys(o); + }; + return function (mod) { + if (mod && mod.__esModule) return mod; + var result = {}; + if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); + __setModuleDefault(result, mod); + return result; + }; +})(); Object.defineProperty(exports, "__esModule", { value: true }); exports.LINK_PATTERN = exports.MARKDOWN_FIELDS = exports.productConfigs = void 0; exports.processProduct = processProduct; @@ -370,10 +380,12 @@ ${yaml.dump(frontmatter)}--- * - Removes leading "/api" prefix (added by parent directory structure) * - Ensures all paths have a version prefix (defaults to v1 if none) * - Removes leading slash + * - Removes curly braces from path parameters (e.g., {db} → db) * * Examples: * - "/write" → "v1/write" * - "/api/v3/configure/database" → "v3/configure/database" + * - "/api/v3/configure/database/{db}" → "v3/configure/database/db" * - "/api/v2/write" → "v2/write" * - "/health" → "v1/health" * @@ -389,6 +401,9 @@ function apiPathToSlug(apiPath) { if (!/^v\d+\//.test(normalizedPath)) { normalizedPath = `v1/${normalizedPath}`; } + // Remove curly braces from path parameters (e.g., {db} → db) + // to avoid URL encoding issues in Hugo + normalizedPath = normalizedPath.replace(/[{}]/g, ''); return normalizedPath; } /** @@ -552,6 +567,7 @@ const productConfigs = { description: 'InfluxDB Clustered', menuKey: 'influxdb3_clustered', skipParentMenu: true, + useTagBasedGeneration: true, }, }; exports.productConfigs = productConfigs; diff --git a/api-docs/scripts/generate-openapi-articles.ts b/api-docs/scripts/generate-openapi-articles.ts index ba8b6f910..96ef23951 100644 --- a/api-docs/scripts/generate-openapi-articles.ts +++ b/api-docs/scripts/generate-openapi-articles.ts @@ -547,10 +547,12 @@ interface GenerateOperationPagesOptions { * - Removes leading "/api" prefix (added by parent directory structure) * - Ensures all paths have a version prefix (defaults to v1 if none) * - Removes leading slash + * - Removes curly braces from path parameters (e.g., {db} → db) * * Examples: * - "/write" → "v1/write" * - "/api/v3/configure/database" → "v3/configure/database" + * - "/api/v3/configure/database/{db}" → "v3/configure/database/db" * - "/api/v2/write" → "v2/write" * - "/health" → "v1/health" * @@ -568,6 +570,10 @@ function apiPathToSlug(apiPath: string): string { normalizedPath = `v1/${normalizedPath}`; } + // Remove curly braces from path parameters (e.g., {db} → db) + // to avoid URL encoding issues in Hugo + normalizedPath = normalizedPath.replace(/[{}]/g, ''); + return normalizedPath; } diff --git a/content/influxdb3/cloud-serverless/api/_index.md b/content/influxdb3/cloud-serverless/api/_index.md index eb0cc58da..a29e77799 100644 --- a/content/influxdb3/cloud-serverless/api/_index.md +++ b/content/influxdb3/cloud-serverless/api/_index.md @@ -8,5 +8,3 @@ type: api --- Use the {{% product-name %}} HTTP API to write data, query data, and manage databases, tables, and tokens. - -{{< children >}} diff --git a/content/influxdb3/cloud-serverless/api/v2/authorizations/{authID}/delete/_index.md b/content/influxdb3/cloud-serverless/api/v2/authorizations/{authID}/delete/_index.md deleted file mode 100644 index 3db6dc8c4..000000000 --- a/content/influxdb3/cloud-serverless/api/v2/authorizations/{authID}/delete/_index.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Delete an authorization -description: API reference for DELETE /api/v2/authorizations/{authID} -type: api-operation -layout: operation -specFile: /openapi/influxdb-cloud-serverless/paths/api-v2-authorizations-authID.yaml -matchPaths: delete -operationId: DeleteAuthorizationsID -method: DELETE -apiPath: /api/v2/authorizations/{authID} -tag: Security and access endpoints ---- diff --git a/content/influxdb3/cloud-serverless/api/v2/authorizations/{authID}/get/_index.md b/content/influxdb3/cloud-serverless/api/v2/authorizations/{authID}/get/_index.md deleted file mode 100644 index eaae88b89..000000000 --- a/content/influxdb3/cloud-serverless/api/v2/authorizations/{authID}/get/_index.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Retrieve an authorization -description: API reference for GET /api/v2/authorizations/{authID} -type: api-operation -layout: operation -specFile: /openapi/influxdb-cloud-serverless/paths/api-v2-authorizations-authID.yaml -matchPaths: get -operationId: GetAuthorizationsID -method: GET -apiPath: /api/v2/authorizations/{authID} -tag: Security and access endpoints ---- diff --git a/content/influxdb3/cloud-serverless/api/v2/authorizations/{authID}/patch/_index.md b/content/influxdb3/cloud-serverless/api/v2/authorizations/{authID}/patch/_index.md deleted file mode 100644 index 92afae976..000000000 --- a/content/influxdb3/cloud-serverless/api/v2/authorizations/{authID}/patch/_index.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Update an API token to be active or inactive -description: API reference for PATCH /api/v2/authorizations/{authID} -type: api-operation -layout: operation -specFile: /openapi/influxdb-cloud-serverless/paths/api-v2-authorizations-authID.yaml -matchPaths: patch -operationId: PatchAuthorizationsID -method: PATCH -apiPath: /api/v2/authorizations/{authID} -tag: Security and access endpoints ---- diff --git a/content/influxdb3/cloud-serverless/api/v2/buckets/{bucketID}/delete/_index.md b/content/influxdb3/cloud-serverless/api/v2/buckets/{bucketID}/delete/_index.md deleted file mode 100644 index 7f0e8620b..000000000 --- a/content/influxdb3/cloud-serverless/api/v2/buckets/{bucketID}/delete/_index.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Delete a bucket -description: API reference for DELETE /api/v2/buckets/{bucketID} -type: api-operation -layout: operation -specFile: /openapi/influxdb-cloud-serverless/paths/api-v2-buckets-bucketID.yaml -matchPaths: delete -operationId: DeleteBucketsID -method: DELETE -apiPath: /api/v2/buckets/{bucketID} -tag: Buckets ---- diff --git a/content/influxdb3/cloud-serverless/api/v2/buckets/{bucketID}/get/_index.md b/content/influxdb3/cloud-serverless/api/v2/buckets/{bucketID}/get/_index.md deleted file mode 100644 index ab4c27564..000000000 --- a/content/influxdb3/cloud-serverless/api/v2/buckets/{bucketID}/get/_index.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Retrieve a bucket -description: API reference for GET /api/v2/buckets/{bucketID} -type: api-operation -layout: operation -specFile: /openapi/influxdb-cloud-serverless/paths/api-v2-buckets-bucketID.yaml -matchPaths: get -operationId: GetBucketsID -method: GET -apiPath: /api/v2/buckets/{bucketID} -tag: Buckets ---- diff --git a/content/influxdb3/cloud-serverless/api/v2/buckets/{bucketID}/labels/get/_index.md b/content/influxdb3/cloud-serverless/api/v2/buckets/{bucketID}/labels/get/_index.md deleted file mode 100644 index 36980ea8e..000000000 --- a/content/influxdb3/cloud-serverless/api/v2/buckets/{bucketID}/labels/get/_index.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: List all labels for a bucket -description: API reference for GET /api/v2/buckets/{bucketID}/labels -type: api-operation -layout: operation -specFile: /openapi/influxdb-cloud-serverless/paths/api-v2-buckets-bucketID-labels.yaml -matchPaths: get -operationId: GetBucketsIDLabels -method: GET -apiPath: /api/v2/buckets/{bucketID}/labels -tag: Buckets ---- diff --git a/content/influxdb3/cloud-serverless/api/v2/buckets/{bucketID}/labels/post/_index.md b/content/influxdb3/cloud-serverless/api/v2/buckets/{bucketID}/labels/post/_index.md deleted file mode 100644 index 863971aa9..000000000 --- a/content/influxdb3/cloud-serverless/api/v2/buckets/{bucketID}/labels/post/_index.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Add a label to a bucket -description: API reference for POST /api/v2/buckets/{bucketID}/labels -type: api-operation -layout: operation -specFile: /openapi/influxdb-cloud-serverless/paths/api-v2-buckets-bucketID-labels.yaml -matchPaths: post -operationId: PostBucketsIDLabels -method: POST -apiPath: /api/v2/buckets/{bucketID}/labels -tag: Buckets ---- diff --git a/content/influxdb3/cloud-serverless/api/v2/buckets/{bucketID}/labels/{labelID}/delete/_index.md b/content/influxdb3/cloud-serverless/api/v2/buckets/{bucketID}/labels/{labelID}/delete/_index.md deleted file mode 100644 index 21dfb34d0..000000000 --- a/content/influxdb3/cloud-serverless/api/v2/buckets/{bucketID}/labels/{labelID}/delete/_index.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: Delete a label from a bucket -description: API reference for DELETE /api/v2/buckets/{bucketID}/labels/{labelID} -type: api-operation -layout: operation -specFile: >- - /openapi/influxdb-cloud-serverless/paths/api-v2-buckets-bucketID-labels-labelID.yaml -matchPaths: delete -operationId: DeleteBucketsIDLabelsID -method: DELETE -apiPath: /api/v2/buckets/{bucketID}/labels/{labelID} -tag: Buckets ---- diff --git a/content/influxdb3/cloud-serverless/api/v2/buckets/{bucketID}/members/get/_index.md b/content/influxdb3/cloud-serverless/api/v2/buckets/{bucketID}/members/get/_index.md deleted file mode 100644 index 651e35dff..000000000 --- a/content/influxdb3/cloud-serverless/api/v2/buckets/{bucketID}/members/get/_index.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: List all users with member privileges for a bucket -description: API reference for GET /api/v2/buckets/{bucketID}/members -type: api-operation -layout: operation -specFile: /openapi/influxdb-cloud-serverless/paths/api-v2-buckets-bucketID-members.yaml -matchPaths: get -operationId: GetBucketsIDMembers -method: GET -apiPath: /api/v2/buckets/{bucketID}/members -tag: Buckets ---- diff --git a/content/influxdb3/cloud-serverless/api/v2/buckets/{bucketID}/members/post/_index.md b/content/influxdb3/cloud-serverless/api/v2/buckets/{bucketID}/members/post/_index.md deleted file mode 100644 index 1e20e5fc3..000000000 --- a/content/influxdb3/cloud-serverless/api/v2/buckets/{bucketID}/members/post/_index.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Add a member to a bucket -description: API reference for POST /api/v2/buckets/{bucketID}/members -type: api-operation -layout: operation -specFile: /openapi/influxdb-cloud-serverless/paths/api-v2-buckets-bucketID-members.yaml -matchPaths: post -operationId: PostBucketsIDMembers -method: POST -apiPath: /api/v2/buckets/{bucketID}/members -tag: Buckets ---- diff --git a/content/influxdb3/cloud-serverless/api/v2/buckets/{bucketID}/members/{userID}/delete/_index.md b/content/influxdb3/cloud-serverless/api/v2/buckets/{bucketID}/members/{userID}/delete/_index.md deleted file mode 100644 index 6c8179c6e..000000000 --- a/content/influxdb3/cloud-serverless/api/v2/buckets/{bucketID}/members/{userID}/delete/_index.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: Remove a member from a bucket -description: API reference for DELETE /api/v2/buckets/{bucketID}/members/{userID} -type: api-operation -layout: operation -specFile: >- - /openapi/influxdb-cloud-serverless/paths/api-v2-buckets-bucketID-members-userID.yaml -matchPaths: delete -operationId: DeleteBucketsIDMembersID -method: DELETE -apiPath: /api/v2/buckets/{bucketID}/members/{userID} -tag: Buckets ---- diff --git a/content/influxdb3/cloud-serverless/api/v2/buckets/{bucketID}/owners/get/_index.md b/content/influxdb3/cloud-serverless/api/v2/buckets/{bucketID}/owners/get/_index.md deleted file mode 100644 index 5baaa9ae5..000000000 --- a/content/influxdb3/cloud-serverless/api/v2/buckets/{bucketID}/owners/get/_index.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: List all owners of a bucket -description: API reference for GET /api/v2/buckets/{bucketID}/owners -type: api-operation -layout: operation -specFile: /openapi/influxdb-cloud-serverless/paths/api-v2-buckets-bucketID-owners.yaml -matchPaths: get -operationId: GetBucketsIDOwners -method: GET -apiPath: /api/v2/buckets/{bucketID}/owners -tag: Buckets ---- diff --git a/content/influxdb3/cloud-serverless/api/v2/buckets/{bucketID}/owners/post/_index.md b/content/influxdb3/cloud-serverless/api/v2/buckets/{bucketID}/owners/post/_index.md deleted file mode 100644 index 05c1d764b..000000000 --- a/content/influxdb3/cloud-serverless/api/v2/buckets/{bucketID}/owners/post/_index.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Add an owner to a bucket -description: API reference for POST /api/v2/buckets/{bucketID}/owners -type: api-operation -layout: operation -specFile: /openapi/influxdb-cloud-serverless/paths/api-v2-buckets-bucketID-owners.yaml -matchPaths: post -operationId: PostBucketsIDOwners -method: POST -apiPath: /api/v2/buckets/{bucketID}/owners -tag: Buckets ---- diff --git a/content/influxdb3/cloud-serverless/api/v2/buckets/{bucketID}/owners/{userID}/delete/_index.md b/content/influxdb3/cloud-serverless/api/v2/buckets/{bucketID}/owners/{userID}/delete/_index.md deleted file mode 100644 index 77ada134b..000000000 --- a/content/influxdb3/cloud-serverless/api/v2/buckets/{bucketID}/owners/{userID}/delete/_index.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: Remove an owner from a bucket -description: API reference for DELETE /api/v2/buckets/{bucketID}/owners/{userID} -type: api-operation -layout: operation -specFile: >- - /openapi/influxdb-cloud-serverless/paths/api-v2-buckets-bucketID-owners-userID.yaml -matchPaths: delete -operationId: DeleteBucketsIDOwnersID -method: DELETE -apiPath: /api/v2/buckets/{bucketID}/owners/{userID} -tag: Buckets ---- diff --git a/content/influxdb3/cloud-serverless/api/v2/buckets/{bucketID}/patch/_index.md b/content/influxdb3/cloud-serverless/api/v2/buckets/{bucketID}/patch/_index.md deleted file mode 100644 index d22ab6a48..000000000 --- a/content/influxdb3/cloud-serverless/api/v2/buckets/{bucketID}/patch/_index.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Update a bucket -description: API reference for PATCH /api/v2/buckets/{bucketID} -type: api-operation -layout: operation -specFile: /openapi/influxdb-cloud-serverless/paths/api-v2-buckets-bucketID.yaml -matchPaths: patch -operationId: PatchBucketsID -method: PATCH -apiPath: /api/v2/buckets/{bucketID} -tag: Buckets ---- diff --git a/content/influxdb3/cloud-serverless/api/v2/buckets/{bucketID}/schema/measurements/get/_index.md b/content/influxdb3/cloud-serverless/api/v2/buckets/{bucketID}/schema/measurements/get/_index.md deleted file mode 100644 index 8321a4a73..000000000 --- a/content/influxdb3/cloud-serverless/api/v2/buckets/{bucketID}/schema/measurements/get/_index.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: List measurement schemas of a bucket -description: API reference for GET /api/v2/buckets/{bucketID}/schema/measurements -type: api-operation -layout: operation -specFile: >- - /openapi/influxdb-cloud-serverless/paths/api-v2-buckets-bucketID-schema-measurements.yaml -matchPaths: get -operationId: getMeasurementSchemas -method: GET -apiPath: /api/v2/buckets/{bucketID}/schema/measurements -tag: Bucket Schemas ---- diff --git a/content/influxdb3/cloud-serverless/api/v2/buckets/{bucketID}/schema/measurements/post/_index.md b/content/influxdb3/cloud-serverless/api/v2/buckets/{bucketID}/schema/measurements/post/_index.md deleted file mode 100644 index 8c880aa46..000000000 --- a/content/influxdb3/cloud-serverless/api/v2/buckets/{bucketID}/schema/measurements/post/_index.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: Create a measurement schema for a bucket -description: API reference for POST /api/v2/buckets/{bucketID}/schema/measurements -type: api-operation -layout: operation -specFile: >- - /openapi/influxdb-cloud-serverless/paths/api-v2-buckets-bucketID-schema-measurements.yaml -matchPaths: post -operationId: createMeasurementSchema -method: POST -apiPath: /api/v2/buckets/{bucketID}/schema/measurements -tag: Bucket Schemas ---- diff --git a/content/influxdb3/cloud-serverless/api/v2/buckets/{bucketID}/schema/measurements/{measurementID}/get/_index.md b/content/influxdb3/cloud-serverless/api/v2/buckets/{bucketID}/schema/measurements/{measurementID}/get/_index.md deleted file mode 100644 index cc8535972..000000000 --- a/content/influxdb3/cloud-serverless/api/v2/buckets/{bucketID}/schema/measurements/{measurementID}/get/_index.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: Retrieve a measurement schema -description: >- - API reference for GET - /api/v2/buckets/{bucketID}/schema/measurements/{measurementID} -type: api-operation -layout: operation -specFile: >- - /openapi/influxdb-cloud-serverless/paths/api-v2-buckets-bucketID-schema-measurements-measurementID.yaml -matchPaths: get -operationId: getMeasurementSchema -method: GET -apiPath: /api/v2/buckets/{bucketID}/schema/measurements/{measurementID} -tag: Bucket Schemas ---- diff --git a/content/influxdb3/cloud-serverless/api/v2/buckets/{bucketID}/schema/measurements/{measurementID}/patch/_index.md b/content/influxdb3/cloud-serverless/api/v2/buckets/{bucketID}/schema/measurements/{measurementID}/patch/_index.md deleted file mode 100644 index 6711652ca..000000000 --- a/content/influxdb3/cloud-serverless/api/v2/buckets/{bucketID}/schema/measurements/{measurementID}/patch/_index.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: Update a measurement schema -description: >- - API reference for PATCH - /api/v2/buckets/{bucketID}/schema/measurements/{measurementID} -type: api-operation -layout: operation -specFile: >- - /openapi/influxdb-cloud-serverless/paths/api-v2-buckets-bucketID-schema-measurements-measurementID.yaml -matchPaths: patch -operationId: updateMeasurementSchema -method: PATCH -apiPath: /api/v2/buckets/{bucketID}/schema/measurements/{measurementID} -tag: Bucket Schemas ---- diff --git a/content/influxdb3/cloud-serverless/api/v2/dbrps/{dbrpID}/delete/_index.md b/content/influxdb3/cloud-serverless/api/v2/dbrps/{dbrpID}/delete/_index.md deleted file mode 100644 index ec6d57109..000000000 --- a/content/influxdb3/cloud-serverless/api/v2/dbrps/{dbrpID}/delete/_index.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Delete a database retention policy -description: API reference for DELETE /api/v2/dbrps/{dbrpID} -type: api-operation -layout: operation -specFile: /openapi/influxdb-cloud-serverless/paths/api-v2-dbrps-dbrpID.yaml -matchPaths: delete -operationId: DeleteDBRPID -method: DELETE -apiPath: /api/v2/dbrps/{dbrpID} -tag: DBRPs ---- diff --git a/content/influxdb3/cloud-serverless/api/v2/dbrps/{dbrpID}/get/_index.md b/content/influxdb3/cloud-serverless/api/v2/dbrps/{dbrpID}/get/_index.md deleted file mode 100644 index bc7db4126..000000000 --- a/content/influxdb3/cloud-serverless/api/v2/dbrps/{dbrpID}/get/_index.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Retrieve a database retention policy mapping -description: API reference for GET /api/v2/dbrps/{dbrpID} -type: api-operation -layout: operation -specFile: /openapi/influxdb-cloud-serverless/paths/api-v2-dbrps-dbrpID.yaml -matchPaths: get -operationId: GetDBRPsID -method: GET -apiPath: /api/v2/dbrps/{dbrpID} -tag: DBRPs ---- diff --git a/content/influxdb3/cloud-serverless/api/v2/dbrps/{dbrpID}/patch/_index.md b/content/influxdb3/cloud-serverless/api/v2/dbrps/{dbrpID}/patch/_index.md deleted file mode 100644 index 95269ee74..000000000 --- a/content/influxdb3/cloud-serverless/api/v2/dbrps/{dbrpID}/patch/_index.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Update a database retention policy mapping -description: API reference for PATCH /api/v2/dbrps/{dbrpID} -type: api-operation -layout: operation -specFile: /openapi/influxdb-cloud-serverless/paths/api-v2-dbrps-dbrpID.yaml -matchPaths: patch -operationId: PatchDBRPID -method: PATCH -apiPath: /api/v2/dbrps/{dbrpID} -tag: DBRPs ---- diff --git a/content/influxdb3/cloud-serverless/api/v2/orgs/{orgID}/delete/_index.md b/content/influxdb3/cloud-serverless/api/v2/orgs/{orgID}/delete/_index.md deleted file mode 100644 index f881823c7..000000000 --- a/content/influxdb3/cloud-serverless/api/v2/orgs/{orgID}/delete/_index.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Delete an organization -description: API reference for DELETE /api/v2/orgs/{orgID} -type: api-operation -layout: operation -specFile: /openapi/influxdb-cloud-serverless/paths/api-v2-orgs-orgID.yaml -matchPaths: delete -operationId: DeleteOrgsID -method: DELETE -apiPath: /api/v2/orgs/{orgID} -tag: Organizations ---- diff --git a/content/influxdb3/cloud-serverless/api/v2/orgs/{orgID}/get/_index.md b/content/influxdb3/cloud-serverless/api/v2/orgs/{orgID}/get/_index.md deleted file mode 100644 index 8d05fe68f..000000000 --- a/content/influxdb3/cloud-serverless/api/v2/orgs/{orgID}/get/_index.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Retrieve an organization -description: API reference for GET /api/v2/orgs/{orgID} -type: api-operation -layout: operation -specFile: /openapi/influxdb-cloud-serverless/paths/api-v2-orgs-orgID.yaml -matchPaths: get -operationId: GetOrgsID -method: GET -apiPath: /api/v2/orgs/{orgID} -tag: Organizations ---- diff --git a/content/influxdb3/cloud-serverless/api/v2/orgs/{orgID}/limits/get/_index.md b/content/influxdb3/cloud-serverless/api/v2/orgs/{orgID}/limits/get/_index.md deleted file mode 100644 index a093d926f..000000000 --- a/content/influxdb3/cloud-serverless/api/v2/orgs/{orgID}/limits/get/_index.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Retrieve limits for an organization -description: API reference for GET /api/v2/orgs/{orgID}/limits -type: api-operation -layout: operation -specFile: /openapi/influxdb-cloud-serverless/paths/api-v2-orgs-orgID-limits.yaml -matchPaths: get -operationId: GetOrgLimitsID -method: GET -apiPath: /api/v2/orgs/{orgID}/limits -tag: Limits ---- diff --git a/content/influxdb3/cloud-serverless/api/v2/orgs/{orgID}/members/get/_index.md b/content/influxdb3/cloud-serverless/api/v2/orgs/{orgID}/members/get/_index.md deleted file mode 100644 index acccd224f..000000000 --- a/content/influxdb3/cloud-serverless/api/v2/orgs/{orgID}/members/get/_index.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: List all members of an organization -description: API reference for GET /api/v2/orgs/{orgID}/members -type: api-operation -layout: operation -specFile: /openapi/influxdb-cloud-serverless/paths/api-v2-orgs-orgID-members.yaml -matchPaths: get -operationId: GetOrgsIDMembers -method: GET -apiPath: /api/v2/orgs/{orgID}/members -tag: Organizations ---- diff --git a/content/influxdb3/cloud-serverless/api/v2/orgs/{orgID}/members/post/_index.md b/content/influxdb3/cloud-serverless/api/v2/orgs/{orgID}/members/post/_index.md deleted file mode 100644 index 8b9bf0814..000000000 --- a/content/influxdb3/cloud-serverless/api/v2/orgs/{orgID}/members/post/_index.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Add a member to an organization -description: API reference for POST /api/v2/orgs/{orgID}/members -type: api-operation -layout: operation -specFile: /openapi/influxdb-cloud-serverless/paths/api-v2-orgs-orgID-members.yaml -matchPaths: post -operationId: PostOrgsIDMembers -method: POST -apiPath: /api/v2/orgs/{orgID}/members -tag: Organizations ---- diff --git a/content/influxdb3/cloud-serverless/api/v2/orgs/{orgID}/members/{userID}/delete/_index.md b/content/influxdb3/cloud-serverless/api/v2/orgs/{orgID}/members/{userID}/delete/_index.md deleted file mode 100644 index 9738ca68f..000000000 --- a/content/influxdb3/cloud-serverless/api/v2/orgs/{orgID}/members/{userID}/delete/_index.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Remove a member from an organization -description: API reference for DELETE /api/v2/orgs/{orgID}/members/{userID} -type: api-operation -layout: operation -specFile: /openapi/influxdb-cloud-serverless/paths/api-v2-orgs-orgID-members-userID.yaml -matchPaths: delete -operationId: DeleteOrgsIDMembersID -method: DELETE -apiPath: /api/v2/orgs/{orgID}/members/{userID} -tag: Organizations ---- diff --git a/content/influxdb3/cloud-serverless/api/v2/orgs/{orgID}/owners/get/_index.md b/content/influxdb3/cloud-serverless/api/v2/orgs/{orgID}/owners/get/_index.md deleted file mode 100644 index a01d7afd5..000000000 --- a/content/influxdb3/cloud-serverless/api/v2/orgs/{orgID}/owners/get/_index.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: List all owners of an organization -description: API reference for GET /api/v2/orgs/{orgID}/owners -type: api-operation -layout: operation -specFile: /openapi/influxdb-cloud-serverless/paths/api-v2-orgs-orgID-owners.yaml -matchPaths: get -operationId: GetOrgsIDOwners -method: GET -apiPath: /api/v2/orgs/{orgID}/owners -tag: Organizations ---- diff --git a/content/influxdb3/cloud-serverless/api/v2/orgs/{orgID}/owners/post/_index.md b/content/influxdb3/cloud-serverless/api/v2/orgs/{orgID}/owners/post/_index.md deleted file mode 100644 index 28f1bd758..000000000 --- a/content/influxdb3/cloud-serverless/api/v2/orgs/{orgID}/owners/post/_index.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Add an owner to an organization -description: API reference for POST /api/v2/orgs/{orgID}/owners -type: api-operation -layout: operation -specFile: /openapi/influxdb-cloud-serverless/paths/api-v2-orgs-orgID-owners.yaml -matchPaths: post -operationId: PostOrgsIDOwners -method: POST -apiPath: /api/v2/orgs/{orgID}/owners -tag: Organizations ---- diff --git a/content/influxdb3/cloud-serverless/api/v2/orgs/{orgID}/owners/{userID}/delete/_index.md b/content/influxdb3/cloud-serverless/api/v2/orgs/{orgID}/owners/{userID}/delete/_index.md deleted file mode 100644 index a7d3b23fc..000000000 --- a/content/influxdb3/cloud-serverless/api/v2/orgs/{orgID}/owners/{userID}/delete/_index.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Remove an owner from an organization -description: API reference for DELETE /api/v2/orgs/{orgID}/owners/{userID} -type: api-operation -layout: operation -specFile: /openapi/influxdb-cloud-serverless/paths/api-v2-orgs-orgID-owners-userID.yaml -matchPaths: delete -operationId: DeleteOrgsIDOwnersID -method: DELETE -apiPath: /api/v2/orgs/{orgID}/owners/{userID} -tag: Organizations ---- diff --git a/content/influxdb3/cloud-serverless/api/v2/orgs/{orgID}/patch/_index.md b/content/influxdb3/cloud-serverless/api/v2/orgs/{orgID}/patch/_index.md deleted file mode 100644 index b80e49578..000000000 --- a/content/influxdb3/cloud-serverless/api/v2/orgs/{orgID}/patch/_index.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Update an organization -description: API reference for PATCH /api/v2/orgs/{orgID} -type: api-operation -layout: operation -specFile: /openapi/influxdb-cloud-serverless/paths/api-v2-orgs-orgID.yaml -matchPaths: patch -operationId: PatchOrgsID -method: PATCH -apiPath: /api/v2/orgs/{orgID} -tag: Organizations ---- diff --git a/content/influxdb3/cloud-serverless/api/v2/orgs/{orgID}/secrets/delete/post/_index.md b/content/influxdb3/cloud-serverless/api/v2/orgs/{orgID}/secrets/delete/post/_index.md deleted file mode 100644 index d34ec4b05..000000000 --- a/content/influxdb3/cloud-serverless/api/v2/orgs/{orgID}/secrets/delete/post/_index.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Delete secrets from an organization -description: API reference for POST /api/v2/orgs/{orgID}/secrets/delete -type: api-operation -layout: operation -specFile: /openapi/influxdb-cloud-serverless/paths/api-v2-orgs-orgID-secrets-delete.yaml -matchPaths: post -operationId: PostOrgsIDSecrets -method: POST -apiPath: /api/v2/orgs/{orgID}/secrets/delete -tag: Secrets ---- diff --git a/content/influxdb3/cloud-serverless/api/v2/orgs/{orgID}/secrets/get/_index.md b/content/influxdb3/cloud-serverless/api/v2/orgs/{orgID}/secrets/get/_index.md deleted file mode 100644 index 102d0ea12..000000000 --- a/content/influxdb3/cloud-serverless/api/v2/orgs/{orgID}/secrets/get/_index.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: List all secret keys for an organization -description: API reference for GET /api/v2/orgs/{orgID}/secrets -type: api-operation -layout: operation -specFile: /openapi/influxdb-cloud-serverless/paths/api-v2-orgs-orgID-secrets.yaml -matchPaths: get -operationId: GetOrgsIDSecrets -method: GET -apiPath: /api/v2/orgs/{orgID}/secrets -tag: Secrets ---- diff --git a/content/influxdb3/cloud-serverless/api/v2/orgs/{orgID}/secrets/patch/_index.md b/content/influxdb3/cloud-serverless/api/v2/orgs/{orgID}/secrets/patch/_index.md deleted file mode 100644 index 3e0e631f7..000000000 --- a/content/influxdb3/cloud-serverless/api/v2/orgs/{orgID}/secrets/patch/_index.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Update secrets in an organization -description: API reference for PATCH /api/v2/orgs/{orgID}/secrets -type: api-operation -layout: operation -specFile: /openapi/influxdb-cloud-serverless/paths/api-v2-orgs-orgID-secrets.yaml -matchPaths: patch -operationId: PatchOrgsIDSecrets -method: PATCH -apiPath: /api/v2/orgs/{orgID}/secrets -tag: Secrets ---- diff --git a/content/influxdb3/cloud-serverless/api/v2/orgs/{orgID}/secrets/{secretID}/delete/_index.md b/content/influxdb3/cloud-serverless/api/v2/orgs/{orgID}/secrets/{secretID}/delete/_index.md deleted file mode 100644 index 77a1ddf13..000000000 --- a/content/influxdb3/cloud-serverless/api/v2/orgs/{orgID}/secrets/{secretID}/delete/_index.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: Delete a secret from an organization -description: API reference for DELETE /api/v2/orgs/{orgID}/secrets/{secretID} -type: api-operation -layout: operation -specFile: >- - /openapi/influxdb-cloud-serverless/paths/api-v2-orgs-orgID-secrets-secretID.yaml -matchPaths: delete -operationId: DeleteOrgsIDSecretsID -method: DELETE -apiPath: /api/v2/orgs/{orgID}/secrets/{secretID} -tag: Secrets ---- diff --git a/content/influxdb3/cloud-serverless/api/v2/orgs/{orgID}/usage/get/_index.md b/content/influxdb3/cloud-serverless/api/v2/orgs/{orgID}/usage/get/_index.md deleted file mode 100644 index 15b0d90d2..000000000 --- a/content/influxdb3/cloud-serverless/api/v2/orgs/{orgID}/usage/get/_index.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Retrieve usage for an organization -description: API reference for GET /api/v2/orgs/{orgID}/usage -type: api-operation -layout: operation -specFile: /openapi/influxdb-cloud-serverless/paths/api-v2-orgs-orgID-usage.yaml -matchPaths: get -operationId: GetOrgUsageID -method: GET -apiPath: /api/v2/orgs/{orgID}/usage -tag: Usage ---- diff --git a/content/influxdb3/cloud-serverless/api/v2/query/suggestions/{name}/get/_index.md b/content/influxdb3/cloud-serverless/api/v2/query/suggestions/{name}/get/_index.md deleted file mode 100644 index c4903aa1c..000000000 --- a/content/influxdb3/cloud-serverless/api/v2/query/suggestions/{name}/get/_index.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Retrieve a query suggestion for a branching suggestion -description: API reference for GET /api/v2/query/suggestions/{name} -type: api-operation -layout: operation -specFile: /openapi/influxdb-cloud-serverless/paths/api-v2-query-suggestions-name.yaml -matchPaths: get -operationId: GetQuerySuggestionsName -method: GET -apiPath: /api/v2/query/suggestions/{name} -tag: Query ---- diff --git a/content/influxdb3/cloud-serverless/api/v2/scripts/{scriptID}/delete/_index.md b/content/influxdb3/cloud-serverless/api/v2/scripts/{scriptID}/delete/_index.md deleted file mode 100644 index 3205d4661..000000000 --- a/content/influxdb3/cloud-serverless/api/v2/scripts/{scriptID}/delete/_index.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Delete a script -description: API reference for DELETE /api/v2/scripts/{scriptID} -type: api-operation -layout: operation -specFile: /openapi/influxdb-cloud-serverless/paths/api-v2-scripts-scriptID.yaml -matchPaths: delete -operationId: DeleteScriptsID -method: DELETE -apiPath: /api/v2/scripts/{scriptID} -tag: Invokable Scripts ---- diff --git a/content/influxdb3/cloud-serverless/api/v2/scripts/{scriptID}/get/_index.md b/content/influxdb3/cloud-serverless/api/v2/scripts/{scriptID}/get/_index.md deleted file mode 100644 index fae78e0db..000000000 --- a/content/influxdb3/cloud-serverless/api/v2/scripts/{scriptID}/get/_index.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Retrieve a script -description: API reference for GET /api/v2/scripts/{scriptID} -type: api-operation -layout: operation -specFile: /openapi/influxdb-cloud-serverless/paths/api-v2-scripts-scriptID.yaml -matchPaths: get -operationId: GetScriptsID -method: GET -apiPath: /api/v2/scripts/{scriptID} -tag: Invokable Scripts ---- diff --git a/content/influxdb3/cloud-serverless/api/v2/scripts/{scriptID}/invoke/post/_index.md b/content/influxdb3/cloud-serverless/api/v2/scripts/{scriptID}/invoke/post/_index.md deleted file mode 100644 index 4de14a011..000000000 --- a/content/influxdb3/cloud-serverless/api/v2/scripts/{scriptID}/invoke/post/_index.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Invoke a script -description: API reference for POST /api/v2/scripts/{scriptID}/invoke -type: api-operation -layout: operation -specFile: /openapi/influxdb-cloud-serverless/paths/api-v2-scripts-scriptID-invoke.yaml -matchPaths: post -operationId: PostScriptsIDInvoke -method: POST -apiPath: /api/v2/scripts/{scriptID}/invoke -tag: Invokable Scripts ---- diff --git a/content/influxdb3/cloud-serverless/api/v2/scripts/{scriptID}/params/get/_index.md b/content/influxdb3/cloud-serverless/api/v2/scripts/{scriptID}/params/get/_index.md deleted file mode 100644 index e4387ccba..000000000 --- a/content/influxdb3/cloud-serverless/api/v2/scripts/{scriptID}/params/get/_index.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Find script parameters. -description: API reference for GET /api/v2/scripts/{scriptID}/params -type: api-operation -layout: operation -specFile: /openapi/influxdb-cloud-serverless/paths/api-v2-scripts-scriptID-params.yaml -matchPaths: get -operationId: GetScriptsIDParams -method: GET -apiPath: /api/v2/scripts/{scriptID}/params -tag: Invokable Scripts ---- diff --git a/content/influxdb3/cloud-serverless/api/v2/scripts/{scriptID}/patch/_index.md b/content/influxdb3/cloud-serverless/api/v2/scripts/{scriptID}/patch/_index.md deleted file mode 100644 index 9fabd2100..000000000 --- a/content/influxdb3/cloud-serverless/api/v2/scripts/{scriptID}/patch/_index.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Update a script -description: API reference for PATCH /api/v2/scripts/{scriptID} -type: api-operation -layout: operation -specFile: /openapi/influxdb-cloud-serverless/paths/api-v2-scripts-scriptID.yaml -matchPaths: patch -operationId: PatchScriptsID -method: PATCH -apiPath: /api/v2/scripts/{scriptID} -tag: Invokable Scripts ---- diff --git a/content/influxdb3/cloud-serverless/api/v2/stacks/{stack_id}/delete/_index.md b/content/influxdb3/cloud-serverless/api/v2/stacks/{stack_id}/delete/_index.md deleted file mode 100644 index aa53d16d7..000000000 --- a/content/influxdb3/cloud-serverless/api/v2/stacks/{stack_id}/delete/_index.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Delete a stack and associated resources -description: API reference for DELETE /api/v2/stacks/{stack_id} -type: api-operation -layout: operation -specFile: /openapi/influxdb-cloud-serverless/paths/api-v2-stacks-stack_id.yaml -matchPaths: delete -operationId: DeleteStack -method: DELETE -apiPath: /api/v2/stacks/{stack_id} -tag: Templates ---- diff --git a/content/influxdb3/cloud-serverless/api/v2/stacks/{stack_id}/get/_index.md b/content/influxdb3/cloud-serverless/api/v2/stacks/{stack_id}/get/_index.md deleted file mode 100644 index 2ae9053b7..000000000 --- a/content/influxdb3/cloud-serverless/api/v2/stacks/{stack_id}/get/_index.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Retrieve a stack -description: API reference for GET /api/v2/stacks/{stack_id} -type: api-operation -layout: operation -specFile: /openapi/influxdb-cloud-serverless/paths/api-v2-stacks-stack_id.yaml -matchPaths: get -operationId: ReadStack -method: GET -apiPath: /api/v2/stacks/{stack_id} -tag: Templates ---- diff --git a/content/influxdb3/cloud-serverless/api/v2/stacks/{stack_id}/patch/_index.md b/content/influxdb3/cloud-serverless/api/v2/stacks/{stack_id}/patch/_index.md deleted file mode 100644 index 6caa2e627..000000000 --- a/content/influxdb3/cloud-serverless/api/v2/stacks/{stack_id}/patch/_index.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Update a stack -description: API reference for PATCH /api/v2/stacks/{stack_id} -type: api-operation -layout: operation -specFile: /openapi/influxdb-cloud-serverless/paths/api-v2-stacks-stack_id.yaml -matchPaths: patch -operationId: UpdateStack -method: PATCH -apiPath: /api/v2/stacks/{stack_id} -tag: Templates ---- diff --git a/content/influxdb3/cloud-serverless/api/v2/stacks/{stack_id}/uninstall/post/_index.md b/content/influxdb3/cloud-serverless/api/v2/stacks/{stack_id}/uninstall/post/_index.md deleted file mode 100644 index 4a7b66faf..000000000 --- a/content/influxdb3/cloud-serverless/api/v2/stacks/{stack_id}/uninstall/post/_index.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Uninstall a stack -description: API reference for POST /api/v2/stacks/{stack_id}/uninstall -type: api-operation -layout: operation -specFile: /openapi/influxdb-cloud-serverless/paths/api-v2-stacks-stack_id-uninstall.yaml -matchPaths: post -operationId: UninstallStack -method: POST -apiPath: /api/v2/stacks/{stack_id}/uninstall -tag: Templates ---- diff --git a/content/influxdb3/cloud-serverless/api/v2/tasks/{taskID}/delete/_index.md b/content/influxdb3/cloud-serverless/api/v2/tasks/{taskID}/delete/_index.md deleted file mode 100644 index c2d7836b2..000000000 --- a/content/influxdb3/cloud-serverless/api/v2/tasks/{taskID}/delete/_index.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Delete a task -description: API reference for DELETE /api/v2/tasks/{taskID} -type: api-operation -layout: operation -specFile: /openapi/influxdb-cloud-serverless/paths/api-v2-tasks-taskID.yaml -matchPaths: delete -operationId: DeleteTasksID -method: DELETE -apiPath: /api/v2/tasks/{taskID} -tag: Tasks ---- diff --git a/content/influxdb3/cloud-serverless/api/v2/tasks/{taskID}/get/_index.md b/content/influxdb3/cloud-serverless/api/v2/tasks/{taskID}/get/_index.md deleted file mode 100644 index 10614e95a..000000000 --- a/content/influxdb3/cloud-serverless/api/v2/tasks/{taskID}/get/_index.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Retrieve a task -description: API reference for GET /api/v2/tasks/{taskID} -type: api-operation -layout: operation -specFile: /openapi/influxdb-cloud-serverless/paths/api-v2-tasks-taskID.yaml -matchPaths: get -operationId: GetTasksID -method: GET -apiPath: /api/v2/tasks/{taskID} -tag: Tasks ---- diff --git a/content/influxdb3/cloud-serverless/api/v2/tasks/{taskID}/labels/get/_index.md b/content/influxdb3/cloud-serverless/api/v2/tasks/{taskID}/labels/get/_index.md deleted file mode 100644 index cc92a883e..000000000 --- a/content/influxdb3/cloud-serverless/api/v2/tasks/{taskID}/labels/get/_index.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: List labels for a task -description: API reference for GET /api/v2/tasks/{taskID}/labels -type: api-operation -layout: operation -specFile: /openapi/influxdb-cloud-serverless/paths/api-v2-tasks-taskID-labels.yaml -matchPaths: get -operationId: GetTasksIDLabels -method: GET -apiPath: /api/v2/tasks/{taskID}/labels -tag: Tasks ---- diff --git a/content/influxdb3/cloud-serverless/api/v2/tasks/{taskID}/labels/post/_index.md b/content/influxdb3/cloud-serverless/api/v2/tasks/{taskID}/labels/post/_index.md deleted file mode 100644 index eb9d77efc..000000000 --- a/content/influxdb3/cloud-serverless/api/v2/tasks/{taskID}/labels/post/_index.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Add a label to a task -description: API reference for POST /api/v2/tasks/{taskID}/labels -type: api-operation -layout: operation -specFile: /openapi/influxdb-cloud-serverless/paths/api-v2-tasks-taskID-labels.yaml -matchPaths: post -operationId: PostTasksIDLabels -method: POST -apiPath: /api/v2/tasks/{taskID}/labels -tag: Tasks ---- diff --git a/content/influxdb3/cloud-serverless/api/v2/tasks/{taskID}/labels/{labelID}/delete/_index.md b/content/influxdb3/cloud-serverless/api/v2/tasks/{taskID}/labels/{labelID}/delete/_index.md deleted file mode 100644 index ade6e02ba..000000000 --- a/content/influxdb3/cloud-serverless/api/v2/tasks/{taskID}/labels/{labelID}/delete/_index.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: Delete a label from a task -description: API reference for DELETE /api/v2/tasks/{taskID}/labels/{labelID} -type: api-operation -layout: operation -specFile: >- - /openapi/influxdb-cloud-serverless/paths/api-v2-tasks-taskID-labels-labelID.yaml -matchPaths: delete -operationId: DeleteTasksIDLabelsID -method: DELETE -apiPath: /api/v2/tasks/{taskID}/labels/{labelID} -tag: Tasks ---- diff --git a/content/influxdb3/cloud-serverless/api/v2/tasks/{taskID}/logs/get/_index.md b/content/influxdb3/cloud-serverless/api/v2/tasks/{taskID}/logs/get/_index.md deleted file mode 100644 index f5e1aa957..000000000 --- a/content/influxdb3/cloud-serverless/api/v2/tasks/{taskID}/logs/get/_index.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Retrieve all logs for a task -description: API reference for GET /api/v2/tasks/{taskID}/logs -type: api-operation -layout: operation -specFile: /openapi/influxdb-cloud-serverless/paths/api-v2-tasks-taskID-logs.yaml -matchPaths: get -operationId: GetTasksIDLogs -method: GET -apiPath: /api/v2/tasks/{taskID}/logs -tag: Tasks ---- diff --git a/content/influxdb3/cloud-serverless/api/v2/tasks/{taskID}/members/get/_index.md b/content/influxdb3/cloud-serverless/api/v2/tasks/{taskID}/members/get/_index.md deleted file mode 100644 index 63d02ed1c..000000000 --- a/content/influxdb3/cloud-serverless/api/v2/tasks/{taskID}/members/get/_index.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: List all task members -description: API reference for GET /api/v2/tasks/{taskID}/members -type: api-operation -layout: operation -specFile: /openapi/influxdb-cloud-serverless/paths/api-v2-tasks-taskID-members.yaml -matchPaths: get -operationId: GetTasksIDMembers -method: GET -apiPath: /api/v2/tasks/{taskID}/members -tag: Tasks ---- diff --git a/content/influxdb3/cloud-serverless/api/v2/tasks/{taskID}/members/post/_index.md b/content/influxdb3/cloud-serverless/api/v2/tasks/{taskID}/members/post/_index.md deleted file mode 100644 index 617263a08..000000000 --- a/content/influxdb3/cloud-serverless/api/v2/tasks/{taskID}/members/post/_index.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Add a member to a task -description: API reference for POST /api/v2/tasks/{taskID}/members -type: api-operation -layout: operation -specFile: /openapi/influxdb-cloud-serverless/paths/api-v2-tasks-taskID-members.yaml -matchPaths: post -operationId: PostTasksIDMembers -method: POST -apiPath: /api/v2/tasks/{taskID}/members -tag: Tasks ---- diff --git a/content/influxdb3/cloud-serverless/api/v2/tasks/{taskID}/members/{userID}/delete/_index.md b/content/influxdb3/cloud-serverless/api/v2/tasks/{taskID}/members/{userID}/delete/_index.md deleted file mode 100644 index 158869a0b..000000000 --- a/content/influxdb3/cloud-serverless/api/v2/tasks/{taskID}/members/{userID}/delete/_index.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: Remove a member from a task -description: API reference for DELETE /api/v2/tasks/{taskID}/members/{userID} -type: api-operation -layout: operation -specFile: >- - /openapi/influxdb-cloud-serverless/paths/api-v2-tasks-taskID-members-userID.yaml -matchPaths: delete -operationId: DeleteTasksIDMembersID -method: DELETE -apiPath: /api/v2/tasks/{taskID}/members/{userID} -tag: Tasks ---- diff --git a/content/influxdb3/cloud-serverless/api/v2/tasks/{taskID}/owners/get/_index.md b/content/influxdb3/cloud-serverless/api/v2/tasks/{taskID}/owners/get/_index.md deleted file mode 100644 index eac5ebbad..000000000 --- a/content/influxdb3/cloud-serverless/api/v2/tasks/{taskID}/owners/get/_index.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: List all owners of a task -description: API reference for GET /api/v2/tasks/{taskID}/owners -type: api-operation -layout: operation -specFile: /openapi/influxdb-cloud-serverless/paths/api-v2-tasks-taskID-owners.yaml -matchPaths: get -operationId: GetTasksIDOwners -method: GET -apiPath: /api/v2/tasks/{taskID}/owners -tag: Tasks ---- diff --git a/content/influxdb3/cloud-serverless/api/v2/tasks/{taskID}/owners/post/_index.md b/content/influxdb3/cloud-serverless/api/v2/tasks/{taskID}/owners/post/_index.md deleted file mode 100644 index 25add0708..000000000 --- a/content/influxdb3/cloud-serverless/api/v2/tasks/{taskID}/owners/post/_index.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Add an owner for a task -description: API reference for POST /api/v2/tasks/{taskID}/owners -type: api-operation -layout: operation -specFile: /openapi/influxdb-cloud-serverless/paths/api-v2-tasks-taskID-owners.yaml -matchPaths: post -operationId: PostTasksIDOwners -method: POST -apiPath: /api/v2/tasks/{taskID}/owners -tag: Tasks ---- diff --git a/content/influxdb3/cloud-serverless/api/v2/tasks/{taskID}/owners/{userID}/delete/_index.md b/content/influxdb3/cloud-serverless/api/v2/tasks/{taskID}/owners/{userID}/delete/_index.md deleted file mode 100644 index d6d83b367..000000000 --- a/content/influxdb3/cloud-serverless/api/v2/tasks/{taskID}/owners/{userID}/delete/_index.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: Remove an owner from a task -description: API reference for DELETE /api/v2/tasks/{taskID}/owners/{userID} -type: api-operation -layout: operation -specFile: >- - /openapi/influxdb-cloud-serverless/paths/api-v2-tasks-taskID-owners-userID.yaml -matchPaths: delete -operationId: DeleteTasksIDOwnersID -method: DELETE -apiPath: /api/v2/tasks/{taskID}/owners/{userID} -tag: Tasks ---- diff --git a/content/influxdb3/cloud-serverless/api/v2/tasks/{taskID}/patch/_index.md b/content/influxdb3/cloud-serverless/api/v2/tasks/{taskID}/patch/_index.md deleted file mode 100644 index a6f937c7d..000000000 --- a/content/influxdb3/cloud-serverless/api/v2/tasks/{taskID}/patch/_index.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Update a task -description: API reference for PATCH /api/v2/tasks/{taskID} -type: api-operation -layout: operation -specFile: /openapi/influxdb-cloud-serverless/paths/api-v2-tasks-taskID.yaml -matchPaths: patch -operationId: PatchTasksID -method: PATCH -apiPath: /api/v2/tasks/{taskID} -tag: Tasks ---- diff --git a/content/influxdb3/cloud-serverless/api/v2/tasks/{taskID}/runs/get/_index.md b/content/influxdb3/cloud-serverless/api/v2/tasks/{taskID}/runs/get/_index.md deleted file mode 100644 index b3a4ceef1..000000000 --- a/content/influxdb3/cloud-serverless/api/v2/tasks/{taskID}/runs/get/_index.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: List runs for a task -description: API reference for GET /api/v2/tasks/{taskID}/runs -type: api-operation -layout: operation -specFile: /openapi/influxdb-cloud-serverless/paths/api-v2-tasks-taskID-runs.yaml -matchPaths: get -operationId: GetTasksIDRuns -method: GET -apiPath: /api/v2/tasks/{taskID}/runs -tag: Tasks ---- diff --git a/content/influxdb3/cloud-serverless/api/v2/tasks/{taskID}/runs/post/_index.md b/content/influxdb3/cloud-serverless/api/v2/tasks/{taskID}/runs/post/_index.md deleted file mode 100644 index 4ee913c41..000000000 --- a/content/influxdb3/cloud-serverless/api/v2/tasks/{taskID}/runs/post/_index.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Start a task run, overriding the schedule -description: API reference for POST /api/v2/tasks/{taskID}/runs -type: api-operation -layout: operation -specFile: /openapi/influxdb-cloud-serverless/paths/api-v2-tasks-taskID-runs.yaml -matchPaths: post -operationId: PostTasksIDRuns -method: POST -apiPath: /api/v2/tasks/{taskID}/runs -tag: Tasks ---- diff --git a/content/influxdb3/cloud-serverless/api/v2/tasks/{taskID}/runs/{runID}/delete/_index.md b/content/influxdb3/cloud-serverless/api/v2/tasks/{taskID}/runs/{runID}/delete/_index.md deleted file mode 100644 index 39765bc38..000000000 --- a/content/influxdb3/cloud-serverless/api/v2/tasks/{taskID}/runs/{runID}/delete/_index.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Cancel a running task -description: API reference for DELETE /api/v2/tasks/{taskID}/runs/{runID} -type: api-operation -layout: operation -specFile: /openapi/influxdb-cloud-serverless/paths/api-v2-tasks-taskID-runs-runID.yaml -matchPaths: delete -operationId: DeleteTasksIDRunsID -method: DELETE -apiPath: /api/v2/tasks/{taskID}/runs/{runID} -tag: Tasks ---- diff --git a/content/influxdb3/cloud-serverless/api/v2/tasks/{taskID}/runs/{runID}/get/_index.md b/content/influxdb3/cloud-serverless/api/v2/tasks/{taskID}/runs/{runID}/get/_index.md deleted file mode 100644 index 845046fcb..000000000 --- a/content/influxdb3/cloud-serverless/api/v2/tasks/{taskID}/runs/{runID}/get/_index.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Retrieve a run for a task. -description: API reference for GET /api/v2/tasks/{taskID}/runs/{runID} -type: api-operation -layout: operation -specFile: /openapi/influxdb-cloud-serverless/paths/api-v2-tasks-taskID-runs-runID.yaml -matchPaths: get -operationId: GetTasksIDRunsID -method: GET -apiPath: /api/v2/tasks/{taskID}/runs/{runID} -tag: Tasks ---- diff --git a/content/influxdb3/cloud-serverless/api/v2/tasks/{taskID}/runs/{runID}/logs/get/_index.md b/content/influxdb3/cloud-serverless/api/v2/tasks/{taskID}/runs/{runID}/logs/get/_index.md deleted file mode 100644 index 051b702fc..000000000 --- a/content/influxdb3/cloud-serverless/api/v2/tasks/{taskID}/runs/{runID}/logs/get/_index.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: Retrieve all logs for a run -description: API reference for GET /api/v2/tasks/{taskID}/runs/{runID}/logs -type: api-operation -layout: operation -specFile: >- - /openapi/influxdb-cloud-serverless/paths/api-v2-tasks-taskID-runs-runID-logs.yaml -matchPaths: get -operationId: GetTasksIDRunsIDLogs -method: GET -apiPath: /api/v2/tasks/{taskID}/runs/{runID}/logs -tag: Tasks ---- diff --git a/content/influxdb3/cloud-serverless/api/v2/tasks/{taskID}/runs/{runID}/retry/post/_index.md b/content/influxdb3/cloud-serverless/api/v2/tasks/{taskID}/runs/{runID}/retry/post/_index.md deleted file mode 100644 index cbe27f5aa..000000000 --- a/content/influxdb3/cloud-serverless/api/v2/tasks/{taskID}/runs/{runID}/retry/post/_index.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: Retry a task run -description: API reference for POST /api/v2/tasks/{taskID}/runs/{runID}/retry -type: api-operation -layout: operation -specFile: >- - /openapi/influxdb-cloud-serverless/paths/api-v2-tasks-taskID-runs-runID-retry.yaml -matchPaths: post -operationId: PostTasksIDRunsIDRetry -method: POST -apiPath: /api/v2/tasks/{taskID}/runs/{runID}/retry -tag: Tasks ---- diff --git a/content/influxdb3/cloud-serverless/api/v2/telegrafs/{telegrafID}/delete/_index.md b/content/influxdb3/cloud-serverless/api/v2/telegrafs/{telegrafID}/delete/_index.md deleted file mode 100644 index cf63fea87..000000000 --- a/content/influxdb3/cloud-serverless/api/v2/telegrafs/{telegrafID}/delete/_index.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Delete a Telegraf configuration -description: API reference for DELETE /api/v2/telegrafs/{telegrafID} -type: api-operation -layout: operation -specFile: /openapi/influxdb-cloud-serverless/paths/api-v2-telegrafs-telegrafID.yaml -matchPaths: delete -operationId: DeleteTelegrafsID -method: DELETE -apiPath: /api/v2/telegrafs/{telegrafID} -tag: Telegrafs ---- diff --git a/content/influxdb3/cloud-serverless/api/v2/telegrafs/{telegrafID}/get/_index.md b/content/influxdb3/cloud-serverless/api/v2/telegrafs/{telegrafID}/get/_index.md deleted file mode 100644 index dd60f8161..000000000 --- a/content/influxdb3/cloud-serverless/api/v2/telegrafs/{telegrafID}/get/_index.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Retrieve a Telegraf configuration -description: API reference for GET /api/v2/telegrafs/{telegrafID} -type: api-operation -layout: operation -specFile: /openapi/influxdb-cloud-serverless/paths/api-v2-telegrafs-telegrafID.yaml -matchPaths: get -operationId: GetTelegrafsID -method: GET -apiPath: /api/v2/telegrafs/{telegrafID} -tag: Telegrafs ---- diff --git a/content/influxdb3/cloud-serverless/api/v2/telegrafs/{telegrafID}/labels/get/_index.md b/content/influxdb3/cloud-serverless/api/v2/telegrafs/{telegrafID}/labels/get/_index.md deleted file mode 100644 index d15a00106..000000000 --- a/content/influxdb3/cloud-serverless/api/v2/telegrafs/{telegrafID}/labels/get/_index.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: List all labels for a Telegraf config -description: API reference for GET /api/v2/telegrafs/{telegrafID}/labels -type: api-operation -layout: operation -specFile: >- - /openapi/influxdb-cloud-serverless/paths/api-v2-telegrafs-telegrafID-labels.yaml -matchPaths: get -operationId: GetTelegrafsIDLabels -method: GET -apiPath: /api/v2/telegrafs/{telegrafID}/labels -tag: Telegrafs ---- diff --git a/content/influxdb3/cloud-serverless/api/v2/telegrafs/{telegrafID}/labels/post/_index.md b/content/influxdb3/cloud-serverless/api/v2/telegrafs/{telegrafID}/labels/post/_index.md deleted file mode 100644 index a3b5fc7e2..000000000 --- a/content/influxdb3/cloud-serverless/api/v2/telegrafs/{telegrafID}/labels/post/_index.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: Add a label to a Telegraf config -description: API reference for POST /api/v2/telegrafs/{telegrafID}/labels -type: api-operation -layout: operation -specFile: >- - /openapi/influxdb-cloud-serverless/paths/api-v2-telegrafs-telegrafID-labels.yaml -matchPaths: post -operationId: PostTelegrafsIDLabels -method: POST -apiPath: /api/v2/telegrafs/{telegrafID}/labels -tag: Telegrafs ---- diff --git a/content/influxdb3/cloud-serverless/api/v2/telegrafs/{telegrafID}/labels/{labelID}/delete/_index.md b/content/influxdb3/cloud-serverless/api/v2/telegrafs/{telegrafID}/labels/{labelID}/delete/_index.md deleted file mode 100644 index f139d3793..000000000 --- a/content/influxdb3/cloud-serverless/api/v2/telegrafs/{telegrafID}/labels/{labelID}/delete/_index.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: Delete a label from a Telegraf config -description: API reference for DELETE /api/v2/telegrafs/{telegrafID}/labels/{labelID} -type: api-operation -layout: operation -specFile: >- - /openapi/influxdb-cloud-serverless/paths/api-v2-telegrafs-telegrafID-labels-labelID.yaml -matchPaths: delete -operationId: DeleteTelegrafsIDLabelsID -method: DELETE -apiPath: /api/v2/telegrafs/{telegrafID}/labels/{labelID} -tag: Telegrafs ---- diff --git a/content/influxdb3/cloud-serverless/api/v2/telegrafs/{telegrafID}/members/get/_index.md b/content/influxdb3/cloud-serverless/api/v2/telegrafs/{telegrafID}/members/get/_index.md deleted file mode 100644 index cb5356783..000000000 --- a/content/influxdb3/cloud-serverless/api/v2/telegrafs/{telegrafID}/members/get/_index.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: List all users with member privileges for a Telegraf config -description: API reference for GET /api/v2/telegrafs/{telegrafID}/members -type: api-operation -layout: operation -specFile: >- - /openapi/influxdb-cloud-serverless/paths/api-v2-telegrafs-telegrafID-members.yaml -matchPaths: get -operationId: GetTelegrafsIDMembers -method: GET -apiPath: /api/v2/telegrafs/{telegrafID}/members -tag: Telegrafs ---- diff --git a/content/influxdb3/cloud-serverless/api/v2/telegrafs/{telegrafID}/members/post/_index.md b/content/influxdb3/cloud-serverless/api/v2/telegrafs/{telegrafID}/members/post/_index.md deleted file mode 100644 index 903f40163..000000000 --- a/content/influxdb3/cloud-serverless/api/v2/telegrafs/{telegrafID}/members/post/_index.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: Add a member to a Telegraf config -description: API reference for POST /api/v2/telegrafs/{telegrafID}/members -type: api-operation -layout: operation -specFile: >- - /openapi/influxdb-cloud-serverless/paths/api-v2-telegrafs-telegrafID-members.yaml -matchPaths: post -operationId: PostTelegrafsIDMembers -method: POST -apiPath: /api/v2/telegrafs/{telegrafID}/members -tag: Telegrafs ---- diff --git a/content/influxdb3/cloud-serverless/api/v2/telegrafs/{telegrafID}/members/{userID}/delete/_index.md b/content/influxdb3/cloud-serverless/api/v2/telegrafs/{telegrafID}/members/{userID}/delete/_index.md deleted file mode 100644 index f55c4c361..000000000 --- a/content/influxdb3/cloud-serverless/api/v2/telegrafs/{telegrafID}/members/{userID}/delete/_index.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: Remove a member from a Telegraf config -description: API reference for DELETE /api/v2/telegrafs/{telegrafID}/members/{userID} -type: api-operation -layout: operation -specFile: >- - /openapi/influxdb-cloud-serverless/paths/api-v2-telegrafs-telegrafID-members-userID.yaml -matchPaths: delete -operationId: DeleteTelegrafsIDMembersID -method: DELETE -apiPath: /api/v2/telegrafs/{telegrafID}/members/{userID} -tag: Telegrafs ---- diff --git a/content/influxdb3/cloud-serverless/api/v2/telegrafs/{telegrafID}/owners/get/_index.md b/content/influxdb3/cloud-serverless/api/v2/telegrafs/{telegrafID}/owners/get/_index.md deleted file mode 100644 index b75f09a89..000000000 --- a/content/influxdb3/cloud-serverless/api/v2/telegrafs/{telegrafID}/owners/get/_index.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: List all owners of a Telegraf configuration -description: API reference for GET /api/v2/telegrafs/{telegrafID}/owners -type: api-operation -layout: operation -specFile: >- - /openapi/influxdb-cloud-serverless/paths/api-v2-telegrafs-telegrafID-owners.yaml -matchPaths: get -operationId: GetTelegrafsIDOwners -method: GET -apiPath: /api/v2/telegrafs/{telegrafID}/owners -tag: Telegrafs ---- diff --git a/content/influxdb3/cloud-serverless/api/v2/telegrafs/{telegrafID}/owners/post/_index.md b/content/influxdb3/cloud-serverless/api/v2/telegrafs/{telegrafID}/owners/post/_index.md deleted file mode 100644 index c12339d2c..000000000 --- a/content/influxdb3/cloud-serverless/api/v2/telegrafs/{telegrafID}/owners/post/_index.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: Add an owner to a Telegraf configuration -description: API reference for POST /api/v2/telegrafs/{telegrafID}/owners -type: api-operation -layout: operation -specFile: >- - /openapi/influxdb-cloud-serverless/paths/api-v2-telegrafs-telegrafID-owners.yaml -matchPaths: post -operationId: PostTelegrafsIDOwners -method: POST -apiPath: /api/v2/telegrafs/{telegrafID}/owners -tag: Telegrafs ---- diff --git a/content/influxdb3/cloud-serverless/api/v2/telegrafs/{telegrafID}/owners/{userID}/delete/_index.md b/content/influxdb3/cloud-serverless/api/v2/telegrafs/{telegrafID}/owners/{userID}/delete/_index.md deleted file mode 100644 index 08e0afe31..000000000 --- a/content/influxdb3/cloud-serverless/api/v2/telegrafs/{telegrafID}/owners/{userID}/delete/_index.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: Remove an owner from a Telegraf config -description: API reference for DELETE /api/v2/telegrafs/{telegrafID}/owners/{userID} -type: api-operation -layout: operation -specFile: >- - /openapi/influxdb-cloud-serverless/paths/api-v2-telegrafs-telegrafID-owners-userID.yaml -matchPaths: delete -operationId: DeleteTelegrafsIDOwnersID -method: DELETE -apiPath: /api/v2/telegrafs/{telegrafID}/owners/{userID} -tag: Telegrafs ---- diff --git a/content/influxdb3/cloud-serverless/api/v2/telegrafs/{telegrafID}/put/_index.md b/content/influxdb3/cloud-serverless/api/v2/telegrafs/{telegrafID}/put/_index.md deleted file mode 100644 index 23c21101d..000000000 --- a/content/influxdb3/cloud-serverless/api/v2/telegrafs/{telegrafID}/put/_index.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Update a Telegraf configuration -description: API reference for PUT /api/v2/telegrafs/{telegrafID} -type: api-operation -layout: operation -specFile: /openapi/influxdb-cloud-serverless/paths/api-v2-telegrafs-telegrafID.yaml -matchPaths: put -operationId: PutTelegrafsID -method: PUT -apiPath: /api/v2/telegrafs/{telegrafID} -tag: Telegrafs ---- diff --git a/content/influxdb3/cloud-serverless/api/v2/variables/{variableID}/delete/_index.md b/content/influxdb3/cloud-serverless/api/v2/variables/{variableID}/delete/_index.md deleted file mode 100644 index e968cfd1e..000000000 --- a/content/influxdb3/cloud-serverless/api/v2/variables/{variableID}/delete/_index.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Delete a variable -description: API reference for DELETE /api/v2/variables/{variableID} -type: api-operation -layout: operation -specFile: /openapi/influxdb-cloud-serverless/paths/api-v2-variables-variableID.yaml -matchPaths: delete -operationId: DeleteVariablesID -method: DELETE -apiPath: /api/v2/variables/{variableID} -tag: Variables ---- diff --git a/content/influxdb3/cloud-serverless/api/v2/variables/{variableID}/get/_index.md b/content/influxdb3/cloud-serverless/api/v2/variables/{variableID}/get/_index.md deleted file mode 100644 index 01b613cc6..000000000 --- a/content/influxdb3/cloud-serverless/api/v2/variables/{variableID}/get/_index.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Retrieve a variable -description: API reference for GET /api/v2/variables/{variableID} -type: api-operation -layout: operation -specFile: /openapi/influxdb-cloud-serverless/paths/api-v2-variables-variableID.yaml -matchPaths: get -operationId: GetVariablesID -method: GET -apiPath: /api/v2/variables/{variableID} -tag: Variables ---- diff --git a/content/influxdb3/cloud-serverless/api/v2/variables/{variableID}/labels/get/_index.md b/content/influxdb3/cloud-serverless/api/v2/variables/{variableID}/labels/get/_index.md deleted file mode 100644 index 85eb06ed1..000000000 --- a/content/influxdb3/cloud-serverless/api/v2/variables/{variableID}/labels/get/_index.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: List all labels for a variable -description: API reference for GET /api/v2/variables/{variableID}/labels -type: api-operation -layout: operation -specFile: >- - /openapi/influxdb-cloud-serverless/paths/api-v2-variables-variableID-labels.yaml -matchPaths: get -operationId: GetVariablesIDLabels -method: GET -apiPath: /api/v2/variables/{variableID}/labels -tag: Variables ---- diff --git a/content/influxdb3/cloud-serverless/api/v2/variables/{variableID}/labels/post/_index.md b/content/influxdb3/cloud-serverless/api/v2/variables/{variableID}/labels/post/_index.md deleted file mode 100644 index 14e72e32a..000000000 --- a/content/influxdb3/cloud-serverless/api/v2/variables/{variableID}/labels/post/_index.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: Add a label to a variable -description: API reference for POST /api/v2/variables/{variableID}/labels -type: api-operation -layout: operation -specFile: >- - /openapi/influxdb-cloud-serverless/paths/api-v2-variables-variableID-labels.yaml -matchPaths: post -operationId: PostVariablesIDLabels -method: POST -apiPath: /api/v2/variables/{variableID}/labels -tag: Variables ---- diff --git a/content/influxdb3/cloud-serverless/api/v2/variables/{variableID}/labels/{labelID}/delete/_index.md b/content/influxdb3/cloud-serverless/api/v2/variables/{variableID}/labels/{labelID}/delete/_index.md deleted file mode 100644 index adedf3e99..000000000 --- a/content/influxdb3/cloud-serverless/api/v2/variables/{variableID}/labels/{labelID}/delete/_index.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: Delete a label from a variable -description: API reference for DELETE /api/v2/variables/{variableID}/labels/{labelID} -type: api-operation -layout: operation -specFile: >- - /openapi/influxdb-cloud-serverless/paths/api-v2-variables-variableID-labels-labelID.yaml -matchPaths: delete -operationId: DeleteVariablesIDLabelsID -method: DELETE -apiPath: /api/v2/variables/{variableID}/labels/{labelID} -tag: Variables ---- diff --git a/content/influxdb3/cloud-serverless/api/v2/variables/{variableID}/patch/_index.md b/content/influxdb3/cloud-serverless/api/v2/variables/{variableID}/patch/_index.md deleted file mode 100644 index 02a4063cf..000000000 --- a/content/influxdb3/cloud-serverless/api/v2/variables/{variableID}/patch/_index.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Update a variable -description: API reference for PATCH /api/v2/variables/{variableID} -type: api-operation -layout: operation -specFile: /openapi/influxdb-cloud-serverless/paths/api-v2-variables-variableID.yaml -matchPaths: patch -operationId: PatchVariablesID -method: PATCH -apiPath: /api/v2/variables/{variableID} -tag: Variables ---- diff --git a/content/influxdb3/cloud-serverless/api/v2/variables/{variableID}/put/_index.md b/content/influxdb3/cloud-serverless/api/v2/variables/{variableID}/put/_index.md deleted file mode 100644 index 7919cf43d..000000000 --- a/content/influxdb3/cloud-serverless/api/v2/variables/{variableID}/put/_index.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Replace a variable -description: API reference for PUT /api/v2/variables/{variableID} -type: api-operation -layout: operation -specFile: /openapi/influxdb-cloud-serverless/paths/api-v2-variables-variableID.yaml -matchPaths: put -operationId: PutVariablesID -method: PUT -apiPath: /api/v2/variables/{variableID} -tag: Variables ---- diff --git a/data/article_data/influxdb/cloud-dedicated/articles.json b/data/article_data/influxdb/cloud-dedicated/articles.json index be8302220..d99ab45e4 100644 --- a/data/article_data/influxdb/cloud-dedicated/articles.json +++ b/data/article_data/influxdb/cloud-dedicated/articles.json @@ -1,29 +1,185 @@ { "articles": [ { - "path": "api/accounts/{accountId}/clusters", + "path": "api/authentication", "fields": { - "name": "/accounts/{accountId}/clusters", + "name": "Authentication", + "describes": [], + "title": "Authentication", + "description": "With InfluxDB 3 Cloud Dedicated, the InfluxDB Management API endpoints require the following credentials:\n\n- `ACCOUNT_ID`: The ID of the [account](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that the cluster belongs to. To view account ID and cluster ID, [list cluster details](/influxdb3/cloud-dedicated/admin/clusters/list/#detailed-output-in-json).\n- `CLUSTER_ID`: The ID of the [cluster](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that you want to manage. To view account ID and cluster ID, [list cluster details](/influxdb3/cloud-dedicated/admin/clusters/list/#detailed-output-in-json).\n- `Authorization MANAGEMENT_TOKEN`: the `Authorization` HTTP header with a [management token](/influxdb3/cloud-dedicated/admin/tokens/management/).\n\n See how to [create a management token](/influxdb3/cloud-dedicated/admin/tokens/management/).\n\n By default, management tokens in InfluxDB 3 are short-lived tokens issued by an OAuth2 identity provider that grant a specific user administrative access to your InfluxDB cluster. However, for automation purposes, you can manually create management tokens that authenticate directly with your InfluxDB cluster and do not require human interaction with your identity provider.\n \n", + "tag": "Authentication", + "isConceptual": true, + "menuGroup": "Concepts", + "operations": [], + "tagDescription": "With InfluxDB 3 Cloud Dedicated, the InfluxDB Management API endpoints require the following credentials:\n\n- `ACCOUNT_ID`: The ID of the [account](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that the cluster belongs to. To view account ID and cluster ID, [list cluster details](/influxdb3/cloud-dedicated/admin/clusters/list/#detailed-output-in-json).\n- `CLUSTER_ID`: The ID of the [cluster](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that you want to manage. To view account ID and cluster ID, [list cluster details](/influxdb3/cloud-dedicated/admin/clusters/list/#detailed-output-in-json).\n- `Authorization MANAGEMENT_TOKEN`: the `Authorization` HTTP header with a [management token](/influxdb3/cloud-dedicated/admin/tokens/management/).\n\n See how to [create a management token](/influxdb3/cloud-dedicated/admin/tokens/management/).\n\n By default, management tokens in InfluxDB 3 are short-lived tokens issued by an OAuth2 identity provider that grant a specific user administrative access to your InfluxDB cluster. However, for automation purposes, you can manually create management tokens that authenticate directly with your InfluxDB cluster and do not require human interaction with your identity provider.\n \n", + "showSecuritySchemes": true, + "source": "static/openapi/influxdb-cloud-dedicated/tags/tags/influxdb-cloud-dedicated-authentication.yaml", + "staticFilePath": "/openapi/influxdb-cloud-dedicated/tags/tags/influxdb-cloud-dedicated-authentication.yaml" + } + }, + { + "path": "api/database-tokens", + "fields": { + "name": "Database tokens", "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" + "title": "Database tokens", + "description": "Manage database read/write tokens for a cluster", + "tag": "Database tokens", + "isConceptual": false, + "menuGroup": "Other", + "operations": [ + { + "operationId": "GetDatabaseTokens", + "method": "GET", + "path": "/accounts/{accountId}/clusters/{clusterId}/tokens", + "summary": "Get all database tokens for a cluster", + "tags": [ + "Database tokens" + ] + }, + { + "operationId": "CreateDatabaseToken", + "method": "POST", + "path": "/accounts/{accountId}/clusters/{clusterId}/tokens", + "summary": "Create a database token", + "tags": [ + "Database tokens" + ] + }, + { + "operationId": "GetDatabaseToken", + "method": "GET", + "path": "/accounts/{accountId}/clusters/{clusterId}/tokens/{tokenId}", + "summary": "Get a database token", + "tags": [ + "Database tokens" + ] + }, + { + "operationId": "UpdateDatabaseToken", + "method": "PATCH", + "path": "/accounts/{accountId}/clusters/{clusterId}/tokens/{tokenId}", + "summary": "Update a database token", + "tags": [ + "Database tokens" + ] + }, + { + "operationId": "DeleteDatabaseToken", + "method": "DELETE", + "path": "/accounts/{accountId}/clusters/{clusterId}/tokens/{tokenId}", + "summary": "Delete a database token", + "tags": [ + "Database tokens" + ] + } ], - "apiTags": [ - "Databases", - "Tables", - "Database tokens" + "tagDescription": "Manage database read/write tokens for a cluster", + "source": "static/openapi/influxdb-cloud-dedicated/tags/tags/influxdb-cloud-dedicated-database-tokens.yaml", + "staticFilePath": "/openapi/influxdb-cloud-dedicated/tags/tags/influxdb-cloud-dedicated-database-tokens.yaml" + } + }, + { + "path": "api/databases", + "fields": { + "name": "Databases", + "describes": [ + "/accounts/{accountId}/clusters/{clusterId}/databases", + "/accounts/{accountId}/clusters/{clusterId}/databases/{databaseName}" ], - "source": "static/openapi/influxdb-cloud-dedicated/paths/influxdb-cloud-dedicated-accounts-{accountId}-clusters.yaml", - "staticFilePath": "/openapi/influxdb-cloud-dedicated/paths/influxdb-cloud-dedicated-accounts-{accountId}-clusters.yaml" + "title": "Databases", + "description": "Manage databases for a cluster", + "tag": "Databases", + "isConceptual": false, + "menuGroup": "Other", + "operations": [ + { + "operationId": "GetClusterDatabases", + "method": "GET", + "path": "/accounts/{accountId}/clusters/{clusterId}/databases", + "summary": "Get all databases for a cluster", + "tags": [ + "Databases" + ] + }, + { + "operationId": "CreateClusterDatabase", + "method": "POST", + "path": "/accounts/{accountId}/clusters/{clusterId}/databases", + "summary": "Create a database", + "tags": [ + "Databases" + ] + }, + { + "operationId": "UpdateClusterDatabase", + "method": "PATCH", + "path": "/accounts/{accountId}/clusters/{clusterId}/databases/{databaseName}", + "summary": "Update a database", + "tags": [ + "Databases" + ] + }, + { + "operationId": "DeleteClusterDatabase", + "method": "DELETE", + "path": "/accounts/{accountId}/clusters/{clusterId}/databases/{databaseName}", + "summary": "Delete a database", + "tags": [ + "Databases" + ] + } + ], + "tagDescription": "Manage databases for a cluster", + "source": "static/openapi/influxdb-cloud-dedicated/tags/tags/influxdb-cloud-dedicated-databases.yaml", + "staticFilePath": "/openapi/influxdb-cloud-dedicated/tags/tags/influxdb-cloud-dedicated-databases.yaml" + } + }, + { + "path": "api/quickstart", + "fields": { + "name": "Quickstart", + "describes": [], + "title": "Quickstart", + "description": "The following example script shows how to use `curl` to make database and token management requests:\n\n```shell\n #!/bin/bash\n\n # Usage:\n # Note the leading space in the command below to keep secrets out of the shell history\n #\n # ```\n # MANAGEMENT_TOKEN= ACCOUNT_ID= CLUSTER_ID= ./scripts/test_http_api_v0_endpoints.sh\n # ```\n\n # Env var validation\n if [ -z \"${MANAGEMENT_TOKEN}\" ]; then\n echo \"\n [Error]: ❌\n \\$MANAGEMENT_TOKEN env var is required.\n \"\n exit 1\n fi\n\n if [ -z \"${ACCOUNT_ID}\" ]; then\n echo \"\n [Error]: ❌\n \\$ACCOUNT_ID env var is required.\n \"\n exit 1\n fi\n\n if [ -z \"${CLUSTER_ID}\" ]; then\n echo \"\n [Error]: ❌\n \\$CLUSTER_ID env var is required.\n \"\n exit 1\n fi\n\nHOST=\"https://console.influxdata.com\"\n\n # Database request functions\n list_databases () {\n local response=$( \\\n curl \\\n --location \"$HOST/api/v0/accounts/$ACCOUNT_ID/clusters/$CLUSTER_ID/databases\" \\\n --header \"Accept: application/json\" \\\n --header \"Authorization: Bearer $MANAGEMENT_TOKEN\" \\\n )\n echo \"$response\"\n }\n\n create_database () {\n local databaseName=$1\n local response=$( \\\n curl \\\n --location \"$HOST/api/v0/accounts/$ACCOUNT_ID/clusters/$CLUSTER_ID/databases\" \\\n --header \"Accept: application/json\" \\\n --header 'Content-Type: application/json' \\\n --header \"Authorization: Bearer $MANAGEMENT_TOKEN\" \\\n --data '{\n \"name\": \"'$databaseName'\",\n \"maxTables\": 75,\n \"maxColumnsPerTable\": 90,\n \"retentionPeriod\": 600000000000,\n \"partitionTemplate\": [\n {\n \"type\": \"tag\",\n \"value\": \"abc\"\n },\n {\n \"type\": \"bucket\",\n \"value\": {\n \"tagName\": \"def\",\n \"numberOfBuckets\": 5\n }\n }\n ]\n }' \\\n )\n echo \"$response\"\n }\n\n update_database () {\n local databaseName=$1\n local response=$( \\\n curl \\\n --location \"$HOST/api/v0/accounts/$ACCOUNT_ID/clusters/$CLUSTER_ID/databases/$databaseName\" \\\n --request PATCH \\\n --header \"Accept: application/json\" \\\n --header 'Content-Type: application/json' \\\n --header \"Authorization: Bearer $MANAGEMENT_TOKEN\" \\\n --data '{\n \"maxTables\": 150,\n \"maxColumnsPerTable\": 180,\n \"retentionPeriod\": 1200000000000\n }' \\\n )\n echo \"$response\"\n }\n\n delete_database () {\n local databaseName=$1\n local response=$( \\\n curl \\\n --location \"$HOST/api/v0/accounts/$ACCOUNT_ID/clusters/$CLUSTER_ID/databases/$databaseName\" \\\n --request DELETE \\\n --header \"Accept: application/json\" \\\n --header \"Authorization: Bearer $MANAGEMENT_TOKEN\" \\\n )\n echo \"$response\"\n }\n\n # Token request functions\n list_tokens () {\n local response=$( \\\n curl \\\n --location \"$HOST/api/v0/accounts/$ACCOUNT_ID/clusters/$CLUSTER_ID/tokens\" \\\n --header \"Accept: application/json\" \\\n --header \"Authorization: Bearer $MANAGEMENT_TOKEN\" \\\n )\n echo \"$response\"\n }\n\n create_token () {\n local response=$( \\\n curl \\\n --location \"$HOST/api/v0/accounts/$ACCOUNT_ID/clusters/$CLUSTER_ID/tokens\" \\\n --header \"Accept: application/json\" \\\n --header 'Content-Type: application/json' \\\n --header \"Authorization: Bearer $MANAGEMENT_TOKEN\" \\\n --data '{\n \"description\": \"my test token\",\n \"permissions\": [\n {\n \"action\": \"write\",\n \"resource\": \"database_one\"\n },\n {\n \"action\": \"read\",\n \"resource\": \"database_two\"\n }\n ]\n }' \\\n )\n echo \"$response\"\n }\n\n get_token () {\n local token_id=$1\n local response=$( \\\n curl \\\n --location \"$HOST/api/v0/accounts/$ACCOUNT_ID/clusters/$CLUSTER_ID/tokens/$tokenId\" \\\n --header \"Accept: application/json\" \\\n --header \"Authorization: Bearer $MANAGEMENT_TOKEN\" \\\n )\n echo \"$response\"\n }\n\n update_token () {\n local token_id=$1\n local response=$( \\\n curl \\\n --location \"$HOST/api/v0/accounts/$ACCOUNT_ID/clusters/$CLUSTER_ID/tokens/$tokenId\" \\\n --request PATCH \\\n --header \"Accept: application/json\" \\\n --header 'Content-Type: application/json' \\\n --header \"Authorization: Bearer $MANAGEMENT_TOKEN\" \\\n --data '{\n \"description\": \"my updated test token\",\n \"permissions\": [\n {\n \"action\": \"database_one\",\n \"resource\": \"read\"\n }\n ]\n }' \\\n )\n echo \"$response\"\n }\n\n delete_token () {\n local token_id=$1\n local response=$( \\\n curl \\\n --location \"$HOST/api/v0/accounts/$ACCOUNT_ID/clusters/$CLUSTER_ID/tokens/$tokenId\" \\\n --request DELETE \\\n --header \"Accept: application/json\" \\\n --header \"Authorization: Bearer $MANAGEMENT_TOKEN\" \\\n )\n echo \"$response\"\n }\n\n\n # Test database endpoints\n databaseName=\"test_database_$RANDOM\"\n\n printf \"\\n🏗️ Creating database... 🏗️\\n\\n\"\n response=\"$(create_database $databaseName)\"\n echo $response | jq\n printf \"\\n🏗️ Creating database successful 🏗️\\n\\n\"\n\n printf \"\\n⬆️ Updating database... ⬆️\\n\\n\"\n response=\"$(update_database $databaseName)\"\n echo $response | jq\n printf \"\\n⬆️ Updating database successful ⬆️\\n\\n\"\n\n printf \"\\n⬇️ Listing databases... ⬇️\\n\\n\"\n response=\"$(list_databases)\"\n echo $response | jq\n printf \"\\n⬇️ Listing databases successful ⬇️\\n\\n\"\n\n printf \"\\n🗑️ Deleting database... 🗑️\\n\\n\"\n response=\"$(delete_database $databaseName)\"\n echo $response | jq\n printf \"\\n🗑️ Deleting database successful 🗑️\\n\\n\"\n\n\n # Test token endpoints\n printf \"\\n🏗️ Creating token... 🏗️\\n\\n\"\n response=\"$(create_token)\"\n echo $response | jq\n tokenId=$(echo $response | jq '.id')\n printf \"\\n🏗️ Creating token successful 🏗️\\n\\n\"\n\n printf \"\\n⬇️ Getting token... ⬇️\\n\\n\"\n response=\"$(get_token $tokenId)\"\n echo $response | jq\n printf \"\\n⬇️ Getting token successful ⬇️\\n\\n\"\n\n printf \"\\n⬆️ Updating token... ⬆️\\n\\n\"\n response=\"$(update_token $tokenId)\"\n echo $response | jq\n printf \"\\n⬆️ Updating token successful ⬆️\\n\\n\"\n\n printf \"\\n📋 Listing tokens... 📋\\n\\n\"\n response=\"$(list_tokens)\"\n echo $response | jq\n printf \"\\n📋 Listing tokens successful 📋\\n\\n\"\n\n printf \"\\n🗑️ Deleting token... 🗑️\\n\\n\"\n response=\"$(delete_token $tokenId)\"\n echo $response | jq\n printf \"\\n🗑️ Deleting token successful 🗑️\\n\\n\"\n ```\n", + "tag": "Quickstart", + "isConceptual": true, + "menuGroup": "Other", + "operations": [], + "tagDescription": "The following example script shows how to use `curl` to make database and token management requests:\n\n```shell\n #!/bin/bash\n\n # Usage:\n # Note the leading space in the command below to keep secrets out of the shell history\n #\n # ```\n # MANAGEMENT_TOKEN= ACCOUNT_ID= CLUSTER_ID= ./scripts/test_http_api_v0_endpoints.sh\n # ```\n\n # Env var validation\n if [ -z \"${MANAGEMENT_TOKEN}\" ]; then\n echo \"\n [Error]: ❌\n \\$MANAGEMENT_TOKEN env var is required.\n \"\n exit 1\n fi\n\n if [ -z \"${ACCOUNT_ID}\" ]; then\n echo \"\n [Error]: ❌\n \\$ACCOUNT_ID env var is required.\n \"\n exit 1\n fi\n\n if [ -z \"${CLUSTER_ID}\" ]; then\n echo \"\n [Error]: ❌\n \\$CLUSTER_ID env var is required.\n \"\n exit 1\n fi\n\nHOST=\"https://console.influxdata.com\"\n\n # Database request functions\n list_databases () {\n local response=$( \\\n curl \\\n --location \"$HOST/api/v0/accounts/$ACCOUNT_ID/clusters/$CLUSTER_ID/databases\" \\\n --header \"Accept: application/json\" \\\n --header \"Authorization: Bearer $MANAGEMENT_TOKEN\" \\\n )\n echo \"$response\"\n }\n\n create_database () {\n local databaseName=$1\n local response=$( \\\n curl \\\n --location \"$HOST/api/v0/accounts/$ACCOUNT_ID/clusters/$CLUSTER_ID/databases\" \\\n --header \"Accept: application/json\" \\\n --header 'Content-Type: application/json' \\\n --header \"Authorization: Bearer $MANAGEMENT_TOKEN\" \\\n --data '{\n \"name\": \"'$databaseName'\",\n \"maxTables\": 75,\n \"maxColumnsPerTable\": 90,\n \"retentionPeriod\": 600000000000,\n \"partitionTemplate\": [\n {\n \"type\": \"tag\",\n \"value\": \"abc\"\n },\n {\n \"type\": \"bucket\",\n \"value\": {\n \"tagName\": \"def\",\n \"numberOfBuckets\": 5\n }\n }\n ]\n }' \\\n )\n echo \"$response\"\n }\n\n update_database () {\n local databaseName=$1\n local response=$( \\\n curl \\\n --location \"$HOST/api/v0/accounts/$ACCOUNT_ID/clusters/$CLUSTER_ID/databases/$databaseName\" \\\n --request PATCH \\\n --header \"Accept: application/json\" \\\n --header 'Content-Type: application/json' \\\n --header \"Authorization: Bearer $MANAGEMENT_TOKEN\" \\\n --data '{\n \"maxTables\": 150,\n \"maxColumnsPerTable\": 180,\n \"retentionPeriod\": 1200000000000\n }' \\\n )\n echo \"$response\"\n }\n\n delete_database () {\n local databaseName=$1\n local response=$( \\\n curl \\\n --location \"$HOST/api/v0/accounts/$ACCOUNT_ID/clusters/$CLUSTER_ID/databases/$databaseName\" \\\n --request DELETE \\\n --header \"Accept: application/json\" \\\n --header \"Authorization: Bearer $MANAGEMENT_TOKEN\" \\\n )\n echo \"$response\"\n }\n\n # Token request functions\n list_tokens () {\n local response=$( \\\n curl \\\n --location \"$HOST/api/v0/accounts/$ACCOUNT_ID/clusters/$CLUSTER_ID/tokens\" \\\n --header \"Accept: application/json\" \\\n --header \"Authorization: Bearer $MANAGEMENT_TOKEN\" \\\n )\n echo \"$response\"\n }\n\n create_token () {\n local response=$( \\\n curl \\\n --location \"$HOST/api/v0/accounts/$ACCOUNT_ID/clusters/$CLUSTER_ID/tokens\" \\\n --header \"Accept: application/json\" \\\n --header 'Content-Type: application/json' \\\n --header \"Authorization: Bearer $MANAGEMENT_TOKEN\" \\\n --data '{\n \"description\": \"my test token\",\n \"permissions\": [\n {\n \"action\": \"write\",\n \"resource\": \"database_one\"\n },\n {\n \"action\": \"read\",\n \"resource\": \"database_two\"\n }\n ]\n }' \\\n )\n echo \"$response\"\n }\n\n get_token () {\n local token_id=$1\n local response=$( \\\n curl \\\n --location \"$HOST/api/v0/accounts/$ACCOUNT_ID/clusters/$CLUSTER_ID/tokens/$tokenId\" \\\n --header \"Accept: application/json\" \\\n --header \"Authorization: Bearer $MANAGEMENT_TOKEN\" \\\n )\n echo \"$response\"\n }\n\n update_token () {\n local token_id=$1\n local response=$( \\\n curl \\\n --location \"$HOST/api/v0/accounts/$ACCOUNT_ID/clusters/$CLUSTER_ID/tokens/$tokenId\" \\\n --request PATCH \\\n --header \"Accept: application/json\" \\\n --header 'Content-Type: application/json' \\\n --header \"Authorization: Bearer $MANAGEMENT_TOKEN\" \\\n --data '{\n \"description\": \"my updated test token\",\n \"permissions\": [\n {\n \"action\": \"database_one\",\n \"resource\": \"read\"\n }\n ]\n }' \\\n )\n echo \"$response\"\n }\n\n delete_token () {\n local token_id=$1\n local response=$( \\\n curl \\\n --location \"$HOST/api/v0/accounts/$ACCOUNT_ID/clusters/$CLUSTER_ID/tokens/$tokenId\" \\\n --request DELETE \\\n --header \"Accept: application/json\" \\\n --header \"Authorization: Bearer $MANAGEMENT_TOKEN\" \\\n )\n echo \"$response\"\n }\n\n\n # Test database endpoints\n databaseName=\"test_database_$RANDOM\"\n\n printf \"\\n🏗️ Creating database... 🏗️\\n\\n\"\n response=\"$(create_database $databaseName)\"\n echo $response | jq\n printf \"\\n🏗️ Creating database successful 🏗️\\n\\n\"\n\n printf \"\\n⬆️ Updating database... ⬆️\\n\\n\"\n response=\"$(update_database $databaseName)\"\n echo $response | jq\n printf \"\\n⬆️ Updating database successful ⬆️\\n\\n\"\n\n printf \"\\n⬇️ Listing databases... ⬇️\\n\\n\"\n response=\"$(list_databases)\"\n echo $response | jq\n printf \"\\n⬇️ Listing databases successful ⬇️\\n\\n\"\n\n printf \"\\n🗑️ Deleting database... 🗑️\\n\\n\"\n response=\"$(delete_database $databaseName)\"\n echo $response | jq\n printf \"\\n🗑️ Deleting database successful 🗑️\\n\\n\"\n\n\n # Test token endpoints\n printf \"\\n🏗️ Creating token... 🏗️\\n\\n\"\n response=\"$(create_token)\"\n echo $response | jq\n tokenId=$(echo $response | jq '.id')\n printf \"\\n🏗️ Creating token successful 🏗️\\n\\n\"\n\n printf \"\\n⬇️ Getting token... ⬇️\\n\\n\"\n response=\"$(get_token $tokenId)\"\n echo $response | jq\n printf \"\\n⬇️ Getting token successful ⬇️\\n\\n\"\n\n printf \"\\n⬆️ Updating token... ⬆️\\n\\n\"\n response=\"$(update_token $tokenId)\"\n echo $response | jq\n printf \"\\n⬆️ Updating token successful ⬆️\\n\\n\"\n\n printf \"\\n📋 Listing tokens... 📋\\n\\n\"\n response=\"$(list_tokens)\"\n echo $response | jq\n printf \"\\n📋 Listing tokens successful 📋\\n\\n\"\n\n printf \"\\n🗑️ Deleting token... 🗑️\\n\\n\"\n response=\"$(delete_token $tokenId)\"\n echo $response | jq\n printf \"\\n🗑️ Deleting token successful 🗑️\\n\\n\"\n ```\n", + "source": "static/openapi/influxdb-cloud-dedicated/tags/tags/influxdb-cloud-dedicated-quickstart.yaml", + "staticFilePath": "/openapi/influxdb-cloud-dedicated/tags/tags/influxdb-cloud-dedicated-quickstart.yaml" + } + }, + { + "path": "api/tables", + "fields": { + "name": "Tables", + "describes": [ + "/accounts/{accountId}/clusters/{clusterId}/databases/{databaseName}/tables" + ], + "title": "Tables", + "description": "Manage tables in a database", + "tag": "Tables", + "isConceptual": false, + "menuGroup": "Other", + "operations": [ + { + "operationId": "CreateClusterDatabaseTable", + "method": "POST", + "path": "/accounts/{accountId}/clusters/{clusterId}/databases/{databaseName}/tables", + "summary": "Create a database table", + "tags": [ + "Tables" + ] + } + ], + "tagDescription": "Manage tables in a database", + "source": "static/openapi/influxdb-cloud-dedicated/tags/tags/influxdb-cloud-dedicated-tables.yaml", + "staticFilePath": "/openapi/influxdb-cloud-dedicated/tags/tags/influxdb-cloud-dedicated-tables.yaml" } } ] diff --git a/data/article_data/influxdb/cloud-dedicated/articles.yml b/data/article_data/influxdb/cloud-dedicated/articles.yml index 1be528fd5..a2bfa53bd 100644 --- a/data/article_data/influxdb/cloud-dedicated/articles.yml +++ b/data/article_data/influxdb/cloud-dedicated/articles.yml @@ -1,24 +1,682 @@ articles: - - path: api/accounts/{accountId}/clusters + - path: api/authentication fields: - name: /accounts/{accountId}/clusters + name: Authentication + describes: [] + title: Authentication + description: > + With InfluxDB 3 Cloud Dedicated, the InfluxDB Management API endpoints + require the following credentials: + + + - `ACCOUNT_ID`: The ID of the + [account](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) + that the cluster belongs to. To view account ID and cluster ID, [list + cluster + details](/influxdb3/cloud-dedicated/admin/clusters/list/#detailed-output-in-json). + + - `CLUSTER_ID`: The ID of the + [cluster](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) + that you want to manage. To view account ID and cluster ID, [list + cluster + details](/influxdb3/cloud-dedicated/admin/clusters/list/#detailed-output-in-json). + + - `Authorization MANAGEMENT_TOKEN`: the `Authorization` HTTP header with + a [management + token](/influxdb3/cloud-dedicated/admin/tokens/management/). + + See how to [create a management token](/influxdb3/cloud-dedicated/admin/tokens/management/). + + By default, management tokens in InfluxDB 3 are short-lived tokens issued by an OAuth2 identity provider that grant a specific user administrative access to your InfluxDB cluster. However, for automation purposes, you can manually create management tokens that authenticate directly with your InfluxDB cluster and do not require human interaction with your identity provider. + + tag: Authentication + isConceptual: true + menuGroup: Concepts + operations: [] + tagDescription: > + With InfluxDB 3 Cloud Dedicated, the InfluxDB Management API endpoints + require the following credentials: + + + - `ACCOUNT_ID`: The ID of the + [account](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) + that the cluster belongs to. To view account ID and cluster ID, [list + cluster + details](/influxdb3/cloud-dedicated/admin/clusters/list/#detailed-output-in-json). + + - `CLUSTER_ID`: The ID of the + [cluster](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) + that you want to manage. To view account ID and cluster ID, [list + cluster + details](/influxdb3/cloud-dedicated/admin/clusters/list/#detailed-output-in-json). + + - `Authorization MANAGEMENT_TOKEN`: the `Authorization` HTTP header with + a [management + token](/influxdb3/cloud-dedicated/admin/tokens/management/). + + See how to [create a management token](/influxdb3/cloud-dedicated/admin/tokens/management/). + + By default, management tokens in InfluxDB 3 are short-lived tokens issued by an OAuth2 identity provider that grant a specific user administrative access to your InfluxDB cluster. However, for automation purposes, you can manually create management tokens that authenticate directly with your InfluxDB cluster and do not require human interaction with your identity provider. + + showSecuritySchemes: true + source: >- + static/openapi/influxdb-cloud-dedicated/tags/tags/influxdb-cloud-dedicated-authentication.yaml + staticFilePath: >- + /openapi/influxdb-cloud-dedicated/tags/tags/influxdb-cloud-dedicated-authentication.yaml + - path: api/database-tokens + fields: + name: Database tokens + describes: + - /accounts/{accountId}/clusters/{clusterId}/tokens + - /accounts/{accountId}/clusters/{clusterId}/tokens/{tokenId} + title: Database tokens + description: Manage database read/write tokens for a cluster + tag: Database tokens + isConceptual: false + menuGroup: Other + operations: + - operationId: GetDatabaseTokens + method: GET + path: /accounts/{accountId}/clusters/{clusterId}/tokens + summary: Get all database tokens for a cluster + tags: + - Database tokens + - operationId: CreateDatabaseToken + method: POST + path: /accounts/{accountId}/clusters/{clusterId}/tokens + summary: Create a database token + tags: + - Database tokens + - operationId: GetDatabaseToken + method: GET + path: /accounts/{accountId}/clusters/{clusterId}/tokens/{tokenId} + summary: Get a database token + tags: + - Database tokens + - operationId: UpdateDatabaseToken + method: PATCH + path: /accounts/{accountId}/clusters/{clusterId}/tokens/{tokenId} + summary: Update a database token + tags: + - Database tokens + - operationId: DeleteDatabaseToken + method: DELETE + path: /accounts/{accountId}/clusters/{clusterId}/tokens/{tokenId} + summary: Delete a database token + tags: + - Database tokens + tagDescription: Manage database read/write tokens for a cluster + source: >- + static/openapi/influxdb-cloud-dedicated/tags/tags/influxdb-cloud-dedicated-database-tokens.yaml + staticFilePath: >- + /openapi/influxdb-cloud-dedicated/tags/tags/influxdb-cloud-dedicated-database-tokens.yaml + - path: api/databases + fields: + name: Databases describes: - /accounts/{accountId}/clusters/{clusterId}/databases - /accounts/{accountId}/clusters/{clusterId}/databases/{databaseName} + title: Databases + description: Manage databases for a cluster + tag: Databases + isConceptual: false + menuGroup: Other + operations: + - operationId: GetClusterDatabases + method: GET + path: /accounts/{accountId}/clusters/{clusterId}/databases + summary: Get all databases for a cluster + tags: + - Databases + - operationId: CreateClusterDatabase + method: POST + path: /accounts/{accountId}/clusters/{clusterId}/databases + summary: Create a database + tags: + - Databases + - operationId: UpdateClusterDatabase + method: PATCH + path: /accounts/{accountId}/clusters/{clusterId}/databases/{databaseName} + summary: Update a database + tags: + - Databases + - operationId: DeleteClusterDatabase + method: DELETE + path: /accounts/{accountId}/clusters/{clusterId}/databases/{databaseName} + summary: Delete a database + tags: + - Databases + tagDescription: Manage databases for a cluster + source: >- + static/openapi/influxdb-cloud-dedicated/tags/tags/influxdb-cloud-dedicated-databases.yaml + staticFilePath: >- + /openapi/influxdb-cloud-dedicated/tags/tags/influxdb-cloud-dedicated-databases.yaml + - path: api/quickstart + fields: + name: Quickstart + describes: [] + title: Quickstart + description: > + The following example script shows how to use `curl` to make database + and token management requests: + + + ```shell + #!/bin/bash + + # Usage: + # Note the leading space in the command below to keep secrets out of the shell history + # + # ``` + # MANAGEMENT_TOKEN= ACCOUNT_ID= CLUSTER_ID= ./scripts/test_http_api_v0_endpoints.sh + # ``` + + # Env var validation + if [ -z "${MANAGEMENT_TOKEN}" ]; then + echo " + [Error]: ❌ + \$MANAGEMENT_TOKEN env var is required. + " + exit 1 + fi + + if [ -z "${ACCOUNT_ID}" ]; then + echo " + [Error]: ❌ + \$ACCOUNT_ID env var is required. + " + exit 1 + fi + + if [ -z "${CLUSTER_ID}" ]; then + echo " + [Error]: ❌ + \$CLUSTER_ID env var is required. + " + exit 1 + fi + + HOST="https://console.influxdata.com" + + # Database request functions + list_databases () { + local response=$( \ + curl \ + --location "$HOST/api/v0/accounts/$ACCOUNT_ID/clusters/$CLUSTER_ID/databases" \ + --header "Accept: application/json" \ + --header "Authorization: Bearer $MANAGEMENT_TOKEN" \ + ) + echo "$response" + } + + create_database () { + local databaseName=$1 + local response=$( \ + curl \ + --location "$HOST/api/v0/accounts/$ACCOUNT_ID/clusters/$CLUSTER_ID/databases" \ + --header "Accept: application/json" \ + --header 'Content-Type: application/json' \ + --header "Authorization: Bearer $MANAGEMENT_TOKEN" \ + --data '{ + "name": "'$databaseName'", + "maxTables": 75, + "maxColumnsPerTable": 90, + "retentionPeriod": 600000000000, + "partitionTemplate": [ + { + "type": "tag", + "value": "abc" + }, + { + "type": "bucket", + "value": { + "tagName": "def", + "numberOfBuckets": 5 + } + } + ] + }' \ + ) + echo "$response" + } + + update_database () { + local databaseName=$1 + local response=$( \ + curl \ + --location "$HOST/api/v0/accounts/$ACCOUNT_ID/clusters/$CLUSTER_ID/databases/$databaseName" \ + --request PATCH \ + --header "Accept: application/json" \ + --header 'Content-Type: application/json' \ + --header "Authorization: Bearer $MANAGEMENT_TOKEN" \ + --data '{ + "maxTables": 150, + "maxColumnsPerTable": 180, + "retentionPeriod": 1200000000000 + }' \ + ) + echo "$response" + } + + delete_database () { + local databaseName=$1 + local response=$( \ + curl \ + --location "$HOST/api/v0/accounts/$ACCOUNT_ID/clusters/$CLUSTER_ID/databases/$databaseName" \ + --request DELETE \ + --header "Accept: application/json" \ + --header "Authorization: Bearer $MANAGEMENT_TOKEN" \ + ) + echo "$response" + } + + # Token request functions + list_tokens () { + local response=$( \ + curl \ + --location "$HOST/api/v0/accounts/$ACCOUNT_ID/clusters/$CLUSTER_ID/tokens" \ + --header "Accept: application/json" \ + --header "Authorization: Bearer $MANAGEMENT_TOKEN" \ + ) + echo "$response" + } + + create_token () { + local response=$( \ + curl \ + --location "$HOST/api/v0/accounts/$ACCOUNT_ID/clusters/$CLUSTER_ID/tokens" \ + --header "Accept: application/json" \ + --header 'Content-Type: application/json' \ + --header "Authorization: Bearer $MANAGEMENT_TOKEN" \ + --data '{ + "description": "my test token", + "permissions": [ + { + "action": "write", + "resource": "database_one" + }, + { + "action": "read", + "resource": "database_two" + } + ] + }' \ + ) + echo "$response" + } + + get_token () { + local token_id=$1 + local response=$( \ + curl \ + --location "$HOST/api/v0/accounts/$ACCOUNT_ID/clusters/$CLUSTER_ID/tokens/$tokenId" \ + --header "Accept: application/json" \ + --header "Authorization: Bearer $MANAGEMENT_TOKEN" \ + ) + echo "$response" + } + + update_token () { + local token_id=$1 + local response=$( \ + curl \ + --location "$HOST/api/v0/accounts/$ACCOUNT_ID/clusters/$CLUSTER_ID/tokens/$tokenId" \ + --request PATCH \ + --header "Accept: application/json" \ + --header 'Content-Type: application/json' \ + --header "Authorization: Bearer $MANAGEMENT_TOKEN" \ + --data '{ + "description": "my updated test token", + "permissions": [ + { + "action": "database_one", + "resource": "read" + } + ] + }' \ + ) + echo "$response" + } + + delete_token () { + local token_id=$1 + local response=$( \ + curl \ + --location "$HOST/api/v0/accounts/$ACCOUNT_ID/clusters/$CLUSTER_ID/tokens/$tokenId" \ + --request DELETE \ + --header "Accept: application/json" \ + --header "Authorization: Bearer $MANAGEMENT_TOKEN" \ + ) + echo "$response" + } + + + # Test database endpoints + databaseName="test_database_$RANDOM" + + printf "\n🏗️ Creating database... 🏗️\n\n" + response="$(create_database $databaseName)" + echo $response | jq + printf "\n🏗️ Creating database successful 🏗️\n\n" + + printf "\n⬆️ Updating database... ⬆️\n\n" + response="$(update_database $databaseName)" + echo $response | jq + printf "\n⬆️ Updating database successful ⬆️\n\n" + + printf "\n⬇️ Listing databases... ⬇️\n\n" + response="$(list_databases)" + echo $response | jq + printf "\n⬇️ Listing databases successful ⬇️\n\n" + + printf "\n🗑️ Deleting database... 🗑️\n\n" + response="$(delete_database $databaseName)" + echo $response | jq + printf "\n🗑️ Deleting database successful 🗑️\n\n" + + + # Test token endpoints + printf "\n🏗️ Creating token... 🏗️\n\n" + response="$(create_token)" + echo $response | jq + tokenId=$(echo $response | jq '.id') + printf "\n🏗️ Creating token successful 🏗️\n\n" + + printf "\n⬇️ Getting token... ⬇️\n\n" + response="$(get_token $tokenId)" + echo $response | jq + printf "\n⬇️ Getting token successful ⬇️\n\n" + + printf "\n⬆️ Updating token... ⬆️\n\n" + response="$(update_token $tokenId)" + echo $response | jq + printf "\n⬆️ Updating token successful ⬆️\n\n" + + printf "\n📋 Listing tokens... 📋\n\n" + response="$(list_tokens)" + echo $response | jq + printf "\n📋 Listing tokens successful 📋\n\n" + + printf "\n🗑️ Deleting token... 🗑️\n\n" + response="$(delete_token $tokenId)" + echo $response | jq + printf "\n🗑️ Deleting token successful 🗑️\n\n" + ``` + tag: Quickstart + isConceptual: true + menuGroup: Other + operations: [] + tagDescription: > + The following example script shows how to use `curl` to make database + and token management requests: + + + ```shell + #!/bin/bash + + # Usage: + # Note the leading space in the command below to keep secrets out of the shell history + # + # ``` + # MANAGEMENT_TOKEN= ACCOUNT_ID= CLUSTER_ID= ./scripts/test_http_api_v0_endpoints.sh + # ``` + + # Env var validation + if [ -z "${MANAGEMENT_TOKEN}" ]; then + echo " + [Error]: ❌ + \$MANAGEMENT_TOKEN env var is required. + " + exit 1 + fi + + if [ -z "${ACCOUNT_ID}" ]; then + echo " + [Error]: ❌ + \$ACCOUNT_ID env var is required. + " + exit 1 + fi + + if [ -z "${CLUSTER_ID}" ]; then + echo " + [Error]: ❌ + \$CLUSTER_ID env var is required. + " + exit 1 + fi + + HOST="https://console.influxdata.com" + + # Database request functions + list_databases () { + local response=$( \ + curl \ + --location "$HOST/api/v0/accounts/$ACCOUNT_ID/clusters/$CLUSTER_ID/databases" \ + --header "Accept: application/json" \ + --header "Authorization: Bearer $MANAGEMENT_TOKEN" \ + ) + echo "$response" + } + + create_database () { + local databaseName=$1 + local response=$( \ + curl \ + --location "$HOST/api/v0/accounts/$ACCOUNT_ID/clusters/$CLUSTER_ID/databases" \ + --header "Accept: application/json" \ + --header 'Content-Type: application/json' \ + --header "Authorization: Bearer $MANAGEMENT_TOKEN" \ + --data '{ + "name": "'$databaseName'", + "maxTables": 75, + "maxColumnsPerTable": 90, + "retentionPeriod": 600000000000, + "partitionTemplate": [ + { + "type": "tag", + "value": "abc" + }, + { + "type": "bucket", + "value": { + "tagName": "def", + "numberOfBuckets": 5 + } + } + ] + }' \ + ) + echo "$response" + } + + update_database () { + local databaseName=$1 + local response=$( \ + curl \ + --location "$HOST/api/v0/accounts/$ACCOUNT_ID/clusters/$CLUSTER_ID/databases/$databaseName" \ + --request PATCH \ + --header "Accept: application/json" \ + --header 'Content-Type: application/json' \ + --header "Authorization: Bearer $MANAGEMENT_TOKEN" \ + --data '{ + "maxTables": 150, + "maxColumnsPerTable": 180, + "retentionPeriod": 1200000000000 + }' \ + ) + echo "$response" + } + + delete_database () { + local databaseName=$1 + local response=$( \ + curl \ + --location "$HOST/api/v0/accounts/$ACCOUNT_ID/clusters/$CLUSTER_ID/databases/$databaseName" \ + --request DELETE \ + --header "Accept: application/json" \ + --header "Authorization: Bearer $MANAGEMENT_TOKEN" \ + ) + echo "$response" + } + + # Token request functions + list_tokens () { + local response=$( \ + curl \ + --location "$HOST/api/v0/accounts/$ACCOUNT_ID/clusters/$CLUSTER_ID/tokens" \ + --header "Accept: application/json" \ + --header "Authorization: Bearer $MANAGEMENT_TOKEN" \ + ) + echo "$response" + } + + create_token () { + local response=$( \ + curl \ + --location "$HOST/api/v0/accounts/$ACCOUNT_ID/clusters/$CLUSTER_ID/tokens" \ + --header "Accept: application/json" \ + --header 'Content-Type: application/json' \ + --header "Authorization: Bearer $MANAGEMENT_TOKEN" \ + --data '{ + "description": "my test token", + "permissions": [ + { + "action": "write", + "resource": "database_one" + }, + { + "action": "read", + "resource": "database_two" + } + ] + }' \ + ) + echo "$response" + } + + get_token () { + local token_id=$1 + local response=$( \ + curl \ + --location "$HOST/api/v0/accounts/$ACCOUNT_ID/clusters/$CLUSTER_ID/tokens/$tokenId" \ + --header "Accept: application/json" \ + --header "Authorization: Bearer $MANAGEMENT_TOKEN" \ + ) + echo "$response" + } + + update_token () { + local token_id=$1 + local response=$( \ + curl \ + --location "$HOST/api/v0/accounts/$ACCOUNT_ID/clusters/$CLUSTER_ID/tokens/$tokenId" \ + --request PATCH \ + --header "Accept: application/json" \ + --header 'Content-Type: application/json' \ + --header "Authorization: Bearer $MANAGEMENT_TOKEN" \ + --data '{ + "description": "my updated test token", + "permissions": [ + { + "action": "database_one", + "resource": "read" + } + ] + }' \ + ) + echo "$response" + } + + delete_token () { + local token_id=$1 + local response=$( \ + curl \ + --location "$HOST/api/v0/accounts/$ACCOUNT_ID/clusters/$CLUSTER_ID/tokens/$tokenId" \ + --request DELETE \ + --header "Accept: application/json" \ + --header "Authorization: Bearer $MANAGEMENT_TOKEN" \ + ) + echo "$response" + } + + + # Test database endpoints + databaseName="test_database_$RANDOM" + + printf "\n🏗️ Creating database... 🏗️\n\n" + response="$(create_database $databaseName)" + echo $response | jq + printf "\n🏗️ Creating database successful 🏗️\n\n" + + printf "\n⬆️ Updating database... ⬆️\n\n" + response="$(update_database $databaseName)" + echo $response | jq + printf "\n⬆️ Updating database successful ⬆️\n\n" + + printf "\n⬇️ Listing databases... ⬇️\n\n" + response="$(list_databases)" + echo $response | jq + printf "\n⬇️ Listing databases successful ⬇️\n\n" + + printf "\n🗑️ Deleting database... 🗑️\n\n" + response="$(delete_database $databaseName)" + echo $response | jq + printf "\n🗑️ Deleting database successful 🗑️\n\n" + + + # Test token endpoints + printf "\n🏗️ Creating token... 🏗️\n\n" + response="$(create_token)" + echo $response | jq + tokenId=$(echo $response | jq '.id') + printf "\n🏗️ Creating token successful 🏗️\n\n" + + printf "\n⬇️ Getting token... ⬇️\n\n" + response="$(get_token $tokenId)" + echo $response | jq + printf "\n⬇️ Getting token successful ⬇️\n\n" + + printf "\n⬆️ Updating token... ⬆️\n\n" + response="$(update_token $tokenId)" + echo $response | jq + printf "\n⬆️ Updating token successful ⬆️\n\n" + + printf "\n📋 Listing tokens... 📋\n\n" + response="$(list_tokens)" + echo $response | jq + printf "\n📋 Listing tokens successful 📋\n\n" + + printf "\n🗑️ Deleting token... 🗑️\n\n" + response="$(delete_token $tokenId)" + echo $response | jq + printf "\n🗑️ Deleting token successful 🗑️\n\n" + ``` + source: >- + static/openapi/influxdb-cloud-dedicated/tags/tags/influxdb-cloud-dedicated-quickstart.yaml + staticFilePath: >- + /openapi/influxdb-cloud-dedicated/tags/tags/influxdb-cloud-dedicated-quickstart.yaml + - path: api/tables + fields: + name: Tables + describes: - >- /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 + title: Tables + description: Manage tables in a database + tag: Tables + isConceptual: false + menuGroup: Other + operations: + - operationId: CreateClusterDatabaseTable + method: POST + path: >- + /accounts/{accountId}/clusters/{clusterId}/databases/{databaseName}/tables + summary: Create a database table + tags: + - Tables + tagDescription: Manage tables in a database source: >- - static/openapi/influxdb-cloud-dedicated/paths/influxdb-cloud-dedicated-accounts-{accountId}-clusters.yaml + static/openapi/influxdb-cloud-dedicated/tags/tags/influxdb-cloud-dedicated-tables.yaml staticFilePath: >- - /openapi/influxdb-cloud-dedicated/paths/influxdb-cloud-dedicated-accounts-{accountId}-clusters.yaml + /openapi/influxdb-cloud-dedicated/tags/tags/influxdb-cloud-dedicated-tables.yaml diff --git a/data/article_data/influxdb/clustered/articles.json b/data/article_data/influxdb/clustered/articles.json index 43dccbcd9..0730112f9 100644 --- a/data/article_data/influxdb/clustered/articles.json +++ b/data/article_data/influxdb/clustered/articles.json @@ -1,65 +1,185 @@ { "articles": [ { - "path": "api/databases/{databaseName}/tables", + "path": "api/authentication", "fields": { - "name": "/databases/{databaseName}/tables", + "name": "Authentication", + "describes": [], + "title": "Authentication", + "description": "With InfluxDB 3 Clustered, InfluxDB Management API endpoints require the following credential:\n\n- `Authorization MANAGEMENT_TOKEN`: the `Authorization` HTTP header with a [management token](/influxdb3/clustered/admin/tokens/management/).\n\n See how to [create a management token](/influxdb3/clustered/admin/tokens/management/).\n\n By default, management tokens in InfluxDB 3 are short-lived tokens issued by an OAuth2 identity provider that grant a specific user administrative access to your InfluxDB cluster. However, for automation purposes, you can manually create management tokens that authenticate directly with your InfluxDB cluster and do not require human interaction with your identity provider.\n", + "tag": "Authentication", + "isConceptual": true, + "menuGroup": "Concepts", + "operations": [], + "tagDescription": "With InfluxDB 3 Clustered, InfluxDB Management API endpoints require the following credential:\n\n- `Authorization MANAGEMENT_TOKEN`: the `Authorization` HTTP header with a [management token](/influxdb3/clustered/admin/tokens/management/).\n\n See how to [create a management token](/influxdb3/clustered/admin/tokens/management/).\n\n By default, management tokens in InfluxDB 3 are short-lived tokens issued by an OAuth2 identity provider that grant a specific user administrative access to your InfluxDB cluster. However, for automation purposes, you can manually create management tokens that authenticate directly with your InfluxDB cluster and do not require human interaction with your identity provider.\n", + "showSecuritySchemes": true, + "source": "static/openapi/influxdb-clustered/tags/tags/influxdb-clustered-authentication.yaml", + "staticFilePath": "/openapi/influxdb-clustered/tags/tags/influxdb-clustered-authentication.yaml" + } + }, + { + "path": "api/database-tokens", + "fields": { + "name": "Database tokens", "describes": [ - "/databases/{databaseName}/tables" + "/tokens", + "/tokens/{tokenId}" ], - "menuName": "/databases/{databaseName}/tables", - "title": "/databases/{databaseName}/tables", - "tags": [ - "databases-{databaseName}", - "tables" + "title": "Database tokens", + "description": "Manage database read/write tokens for a cluster", + "tag": "Database tokens", + "isConceptual": false, + "menuGroup": "Other", + "operations": [ + { + "operationId": "GetDatabaseTokens", + "method": "GET", + "path": "/tokens", + "summary": "Get all database tokens for a cluster", + "tags": [ + "Database tokens" + ] + }, + { + "operationId": "CreateDatabaseToken", + "method": "POST", + "path": "/tokens", + "summary": "Create a database token", + "tags": [ + "Database tokens" + ] + }, + { + "operationId": "GetDatabaseToken", + "method": "GET", + "path": "/tokens/{tokenId}", + "summary": "Get a database token", + "tags": [ + "Database tokens" + ] + }, + { + "operationId": "UpdateDatabaseToken", + "method": "PATCH", + "path": "/tokens/{tokenId}", + "summary": "Update a database token", + "tags": [ + "Database tokens" + ] + }, + { + "operationId": "DeleteDatabaseToken", + "method": "DELETE", + "path": "/tokens/{tokenId}", + "summary": "Delete a database token", + "tags": [ + "Database tokens" + ] + } ], - "apiTags": [ - "Tables" - ], - "source": "static/openapi/influxdb-clustered/paths/influxdb-clustered-databases-{databaseName}-tables.yaml", - "staticFilePath": "/openapi/influxdb-clustered/paths/influxdb-clustered-databases-{databaseName}-tables.yaml" + "tagDescription": "Manage database read/write tokens for a cluster", + "source": "static/openapi/influxdb-clustered/tags/tags/influxdb-clustered-database-tokens.yaml", + "staticFilePath": "/openapi/influxdb-clustered/tags/tags/influxdb-clustered-database-tokens.yaml" } }, { "path": "api/databases", "fields": { - "name": "/databases", + "name": "Databases", "describes": [ "/databases", "/databases/{databaseName}" ], - "menuName": "/databases", - "title": "/databases", - "tags": [ - "", - "databases" + "title": "Databases", + "description": "Manage databases for a cluster", + "tag": "Databases", + "isConceptual": false, + "menuGroup": "Other", + "operations": [ + { + "operationId": "GetClusterDatabases", + "method": "GET", + "path": "/databases", + "summary": "Get all databases for a cluster", + "tags": [ + "Databases" + ] + }, + { + "operationId": "CreateClusterDatabase", + "method": "POST", + "path": "/databases", + "summary": "Create a database", + "tags": [ + "Databases" + ] + }, + { + "operationId": "UpdateClusterDatabase", + "method": "PATCH", + "path": "/databases/{databaseName}", + "summary": "Update a database", + "tags": [ + "Databases" + ] + }, + { + "operationId": "DeleteClusterDatabase", + "method": "DELETE", + "path": "/databases/{databaseName}", + "summary": "Delete a database", + "tags": [ + "Databases" + ] + } ], - "apiTags": [ - "Databases" - ], - "source": "static/openapi/influxdb-clustered/paths/influxdb-clustered-databases.yaml", - "staticFilePath": "/openapi/influxdb-clustered/paths/influxdb-clustered-databases.yaml" + "tagDescription": "Manage databases for a cluster", + "source": "static/openapi/influxdb-clustered/tags/tags/influxdb-clustered-databases.yaml", + "staticFilePath": "/openapi/influxdb-clustered/tags/tags/influxdb-clustered-databases.yaml" } }, { - "path": "api/tokens", + "path": "api/quickstart", "fields": { - "name": "/tokens", + "name": "Quickstart", + "describes": [], + "title": "Quickstart", + "description": "The following example script shows how to use `curl` to make database and token management requests:\n\n```shell\n #!/bin/bash\n\n # Usage:\n # Note the leading space in the command below to keep secrets out of the shell history\n #\n # ```\n # MANAGEMENT_TOKEN= ./scripts/test_http_api_v0_endpoints.sh\n # ```\n\n # Env var validation\n if [ -z \"${MANAGEMENT_TOKEN}\" ]; then\n echo \"\n [Error]: ❌\n \\$MANAGEMENT_TOKEN env var is required.\n \"\n exit 1\n fi\n\nHOST=\"https://cluster-host.com\"\n\n # Database request functions\n list_databases () {\n local response=$( \\\n curl \\\n --location \"$HOST/api/v0/databases\" \\\n --header \"Accept: application/json\" \\\n --header \"Authorization: Bearer $MANAGEMENT_TOKEN\" \\\n )\n echo \"$response\"\n }\n\n create_database () {\n local databaseName=$1\n local response=$( \\\n curl \\\n --location \"$HOST/api/v0/databases\" \\\n --header \"Accept: application/json\" \\\n --header 'Content-Type: application/json' \\\n --header \"Authorization: Bearer $MANAGEMENT_TOKEN\" \\\n --data '{\n \"name\": \"'$databaseName'\",\n \"maxTables\": 75,\n \"maxColumnsPerTable\": 90,\n \"retentionPeriod\": 600000000000,\n \"partitionTemplate\": [\n {\n \"type\": \"tag\",\n \"value\": \"abc\"\n },\n {\n \"type\": \"bucket\",\n \"value\": {\n \"tagName\": \"def\",\n \"numberOfBuckets\": 5\n }\n }\n ]\n }' \\\n )\n echo \"$response\"\n }\n\n update_database () {\n local databaseName=$1\n local response=$( \\\n curl \\\n --location \"$HOST/api/v0/databases/$databaseName\" \\\n --request PATCH \\\n --header \"Accept: application/json\" \\\n --header 'Content-Type: application/json' \\\n --header \"Authorization: Bearer $MANAGEMENT_TOKEN\" \\\n --data '{\n \"maxTables\": 150,\n \"maxColumnsPerTable\": 180,\n \"retentionPeriod\": 1200000000000\n }' \\\n )\n echo \"$response\"\n }\n\n delete_database () {\n local databaseName=$1\n local response=$( \\\n curl \\\n --location \"$HOST/api/v0/databases/$databaseName\" \\\n --request DELETE \\\n --header \"Accept: application/json\" \\\n --header \"Authorization: Bearer $MANAGEMENT_TOKEN\" \\\n )\n echo \"$response\"\n }\n\n # Token request functions\n list_tokens () {\n local response=$( \\\n curl \\\n --location \"$HOST/api/v0/tokens\" \\\n --header \"Accept: application/json\" \\\n --header \"Authorization: Bearer $MANAGEMENT_TOKEN\" \\\n )\n echo \"$response\"\n }\n\n create_token () {\n local response=$( \\\n curl \\\n --location \"$HOST/api/v0/tokens\" \\\n --header \"Accept: application/json\" \\\n --header 'Content-Type: application/json' \\\n --header \"Authorization: Bearer $MANAGEMENT_TOKEN\" \\\n --data '{\n \"description\": \"my test token\",\n \"permissions\": [\n {\n \"action\": \"write\",\n \"resource\": \"database_one\"\n },\n {\n \"action\": \"read\",\n \"resource\": \"database_two\"\n }\n ]\n }' \\\n )\n echo \"$response\"\n }\n\n get_token () {\n local token_id=$1\n local response=$( \\\n curl \\\n --location \"$HOST/api/v0/tokens/$tokenId\" \\\n --header \"Accept: application/json\" \\\n --header \"Authorization: Bearer $MANAGEMENT_TOKEN\" \\\n )\n echo \"$response\"\n }\n\n update_token () {\n local token_id=$1\n local response=$( \\\n curl \\\n --location \"$HOST/api/v0/tokens/$tokenId\" \\\n --request PATCH \\\n --header \"Accept: application/json\" \\\n --header 'Content-Type: application/json' \\\n --header \"Authorization: Bearer $MANAGEMENT_TOKEN\" \\\n --data '{\n \"description\": \"my updated test token\",\n \"permissions\": [\n {\n \"action\": \"database_one\",\n \"resource\": \"read\"\n }\n ]\n }' \\\n )\n echo \"$response\"\n }\n\n delete_token () {\n local token_id=$1\n local response=$( \\\n curl \\\n --location \"$HOST/api/v0/tokens/$tokenId\" \\\n --request DELETE \\\n --header \"Accept: application/json\" \\\n --header \"Authorization: Bearer $MANAGEMENT_TOKEN\" \\\n )\n echo \"$response\"\n }\n\n\n # Test database endpoints\n databaseName=\"test_database_$RANDOM\"\n\n printf \"\\n🏗️ Creating database... 🏗️\\n\\n\"\n response=\"$(create_database $databaseName)\"\n echo $response | jq\n printf \"\\n🏗️ Creating database successful 🏗️\\n\\n\"\n\n printf \"\\n⬆️ Updating database... ⬆️\\n\\n\"\n response=\"$(update_database $databaseName)\"\n echo $response | jq\n printf \"\\n⬆️ Updating database successful ⬆️\\n\\n\"\n\n printf \"\\n⬇️ Listing databases... ⬇️\\n\\n\"\n response=\"$(list_databases)\"\n echo $response | jq\n printf \"\\n⬇️ Listing databases successful ⬇️\\n\\n\"\n\n printf \"\\n🗑️ Deleting database... 🗑️\\n\\n\"\n response=\"$(delete_database $databaseName)\"\n echo $response | jq\n printf \"\\n🗑️ Deleting database successful 🗑️\\n\\n\"\n\n\n # Test token endpoints\n printf \"\\n🏗️ Creating token... 🏗️\\n\\n\"\n response=\"$(create_token)\"\n echo $response | jq\n tokenId=$(echo $response | jq '.id')\n printf \"\\n🏗️ Creating token successful 🏗️\\n\\n\"\n\n printf \"\\n⬇️ Getting token... ⬇️\\n\\n\"\n response=\"$(get_token $tokenId)\"\n echo $response | jq\n printf \"\\n⬇️ Getting token successful ⬇️\\n\\n\"\n\n printf \"\\n⬆️ Updating token... ⬆️\\n\\n\"\n response=\"$(update_token $tokenId)\"\n echo $response | jq\n printf \"\\n⬆️ Updating token successful ⬆️\\n\\n\"\n\n printf \"\\n📋 Listing tokens... 📋\\n\\n\"\n response=\"$(list_tokens)\"\n echo $response | jq\n printf \"\\n📋 Listing tokens successful 📋\\n\\n\"\n\n printf \"\\n🗑️ Deleting token... 🗑️\\n\\n\"\n response=\"$(delete_token $tokenId)\"\n echo $response | jq\n printf \"\\n🗑️ Deleting token successful 🗑️\\n\\n\"\n ```\n", + "tag": "Quickstart", + "isConceptual": true, + "menuGroup": "Other", + "operations": [], + "tagDescription": "The following example script shows how to use `curl` to make database and token management requests:\n\n```shell\n #!/bin/bash\n\n # Usage:\n # Note the leading space in the command below to keep secrets out of the shell history\n #\n # ```\n # MANAGEMENT_TOKEN= ./scripts/test_http_api_v0_endpoints.sh\n # ```\n\n # Env var validation\n if [ -z \"${MANAGEMENT_TOKEN}\" ]; then\n echo \"\n [Error]: ❌\n \\$MANAGEMENT_TOKEN env var is required.\n \"\n exit 1\n fi\n\nHOST=\"https://cluster-host.com\"\n\n # Database request functions\n list_databases () {\n local response=$( \\\n curl \\\n --location \"$HOST/api/v0/databases\" \\\n --header \"Accept: application/json\" \\\n --header \"Authorization: Bearer $MANAGEMENT_TOKEN\" \\\n )\n echo \"$response\"\n }\n\n create_database () {\n local databaseName=$1\n local response=$( \\\n curl \\\n --location \"$HOST/api/v0/databases\" \\\n --header \"Accept: application/json\" \\\n --header 'Content-Type: application/json' \\\n --header \"Authorization: Bearer $MANAGEMENT_TOKEN\" \\\n --data '{\n \"name\": \"'$databaseName'\",\n \"maxTables\": 75,\n \"maxColumnsPerTable\": 90,\n \"retentionPeriod\": 600000000000,\n \"partitionTemplate\": [\n {\n \"type\": \"tag\",\n \"value\": \"abc\"\n },\n {\n \"type\": \"bucket\",\n \"value\": {\n \"tagName\": \"def\",\n \"numberOfBuckets\": 5\n }\n }\n ]\n }' \\\n )\n echo \"$response\"\n }\n\n update_database () {\n local databaseName=$1\n local response=$( \\\n curl \\\n --location \"$HOST/api/v0/databases/$databaseName\" \\\n --request PATCH \\\n --header \"Accept: application/json\" \\\n --header 'Content-Type: application/json' \\\n --header \"Authorization: Bearer $MANAGEMENT_TOKEN\" \\\n --data '{\n \"maxTables\": 150,\n \"maxColumnsPerTable\": 180,\n \"retentionPeriod\": 1200000000000\n }' \\\n )\n echo \"$response\"\n }\n\n delete_database () {\n local databaseName=$1\n local response=$( \\\n curl \\\n --location \"$HOST/api/v0/databases/$databaseName\" \\\n --request DELETE \\\n --header \"Accept: application/json\" \\\n --header \"Authorization: Bearer $MANAGEMENT_TOKEN\" \\\n )\n echo \"$response\"\n }\n\n # Token request functions\n list_tokens () {\n local response=$( \\\n curl \\\n --location \"$HOST/api/v0/tokens\" \\\n --header \"Accept: application/json\" \\\n --header \"Authorization: Bearer $MANAGEMENT_TOKEN\" \\\n )\n echo \"$response\"\n }\n\n create_token () {\n local response=$( \\\n curl \\\n --location \"$HOST/api/v0/tokens\" \\\n --header \"Accept: application/json\" \\\n --header 'Content-Type: application/json' \\\n --header \"Authorization: Bearer $MANAGEMENT_TOKEN\" \\\n --data '{\n \"description\": \"my test token\",\n \"permissions\": [\n {\n \"action\": \"write\",\n \"resource\": \"database_one\"\n },\n {\n \"action\": \"read\",\n \"resource\": \"database_two\"\n }\n ]\n }' \\\n )\n echo \"$response\"\n }\n\n get_token () {\n local token_id=$1\n local response=$( \\\n curl \\\n --location \"$HOST/api/v0/tokens/$tokenId\" \\\n --header \"Accept: application/json\" \\\n --header \"Authorization: Bearer $MANAGEMENT_TOKEN\" \\\n )\n echo \"$response\"\n }\n\n update_token () {\n local token_id=$1\n local response=$( \\\n curl \\\n --location \"$HOST/api/v0/tokens/$tokenId\" \\\n --request PATCH \\\n --header \"Accept: application/json\" \\\n --header 'Content-Type: application/json' \\\n --header \"Authorization: Bearer $MANAGEMENT_TOKEN\" \\\n --data '{\n \"description\": \"my updated test token\",\n \"permissions\": [\n {\n \"action\": \"database_one\",\n \"resource\": \"read\"\n }\n ]\n }' \\\n )\n echo \"$response\"\n }\n\n delete_token () {\n local token_id=$1\n local response=$( \\\n curl \\\n --location \"$HOST/api/v0/tokens/$tokenId\" \\\n --request DELETE \\\n --header \"Accept: application/json\" \\\n --header \"Authorization: Bearer $MANAGEMENT_TOKEN\" \\\n )\n echo \"$response\"\n }\n\n\n # Test database endpoints\n databaseName=\"test_database_$RANDOM\"\n\n printf \"\\n🏗️ Creating database... 🏗️\\n\\n\"\n response=\"$(create_database $databaseName)\"\n echo $response | jq\n printf \"\\n🏗️ Creating database successful 🏗️\\n\\n\"\n\n printf \"\\n⬆️ Updating database... ⬆️\\n\\n\"\n response=\"$(update_database $databaseName)\"\n echo $response | jq\n printf \"\\n⬆️ Updating database successful ⬆️\\n\\n\"\n\n printf \"\\n⬇️ Listing databases... ⬇️\\n\\n\"\n response=\"$(list_databases)\"\n echo $response | jq\n printf \"\\n⬇️ Listing databases successful ⬇️\\n\\n\"\n\n printf \"\\n🗑️ Deleting database... 🗑️\\n\\n\"\n response=\"$(delete_database $databaseName)\"\n echo $response | jq\n printf \"\\n🗑️ Deleting database successful 🗑️\\n\\n\"\n\n\n # Test token endpoints\n printf \"\\n🏗️ Creating token... 🏗️\\n\\n\"\n response=\"$(create_token)\"\n echo $response | jq\n tokenId=$(echo $response | jq '.id')\n printf \"\\n🏗️ Creating token successful 🏗️\\n\\n\"\n\n printf \"\\n⬇️ Getting token... ⬇️\\n\\n\"\n response=\"$(get_token $tokenId)\"\n echo $response | jq\n printf \"\\n⬇️ Getting token successful ⬇️\\n\\n\"\n\n printf \"\\n⬆️ Updating token... ⬆️\\n\\n\"\n response=\"$(update_token $tokenId)\"\n echo $response | jq\n printf \"\\n⬆️ Updating token successful ⬆️\\n\\n\"\n\n printf \"\\n📋 Listing tokens... 📋\\n\\n\"\n response=\"$(list_tokens)\"\n echo $response | jq\n printf \"\\n📋 Listing tokens successful 📋\\n\\n\"\n\n printf \"\\n🗑️ Deleting token... 🗑️\\n\\n\"\n response=\"$(delete_token $tokenId)\"\n echo $response | jq\n printf \"\\n🗑️ Deleting token successful 🗑️\\n\\n\"\n ```\n", + "source": "static/openapi/influxdb-clustered/tags/tags/influxdb-clustered-quickstart.yaml", + "staticFilePath": "/openapi/influxdb-clustered/tags/tags/influxdb-clustered-quickstart.yaml" + } + }, + { + "path": "api/tables", + "fields": { + "name": "Tables", "describes": [ - "/tokens", - "/tokens/{tokenId}" + "/databases/{databaseName}/tables" ], - "menuName": "/tokens", - "title": "/tokens", - "tags": [ - "", - "tokens" + "title": "Tables", + "description": "Manage tables in a database", + "tag": "Tables", + "isConceptual": false, + "menuGroup": "Other", + "operations": [ + { + "operationId": "CreateClusterDatabaseTable", + "method": "POST", + "path": "/databases/{databaseName}/tables", + "summary": "Create a database table", + "tags": [ + "Tables" + ] + } ], - "apiTags": [ - "Database tokens" - ], - "source": "static/openapi/influxdb-clustered/paths/influxdb-clustered-tokens.yaml", - "staticFilePath": "/openapi/influxdb-clustered/paths/influxdb-clustered-tokens.yaml" + "tagDescription": "Manage tables in a database", + "source": "static/openapi/influxdb-clustered/tags/tags/influxdb-clustered-tables.yaml", + "staticFilePath": "/openapi/influxdb-clustered/tags/tags/influxdb-clustered-tables.yaml" } } ] diff --git a/data/article_data/influxdb/clustered/articles.yml b/data/article_data/influxdb/clustered/articles.yml index 0c0dddc89..4ba3c7299 100644 --- a/data/article_data/influxdb/clustered/articles.yml +++ b/data/article_data/influxdb/clustered/articles.yml @@ -1,48 +1,617 @@ articles: - - path: api/databases/{databaseName}/tables + - path: api/authentication fields: - name: /databases/{databaseName}/tables - describes: - - /databases/{databaseName}/tables - menuName: /databases/{databaseName}/tables - title: /databases/{databaseName}/tables - tags: - - databases-{databaseName} - - tables - apiTags: - - Tables + name: Authentication + describes: [] + title: Authentication + description: > + With InfluxDB 3 Clustered, InfluxDB Management API endpoints require the + following credential: + + + - `Authorization MANAGEMENT_TOKEN`: the `Authorization` HTTP header with + a [management token](/influxdb3/clustered/admin/tokens/management/). + + See how to [create a management token](/influxdb3/clustered/admin/tokens/management/). + + By default, management tokens in InfluxDB 3 are short-lived tokens issued by an OAuth2 identity provider that grant a specific user administrative access to your InfluxDB cluster. However, for automation purposes, you can manually create management tokens that authenticate directly with your InfluxDB cluster and do not require human interaction with your identity provider. + tag: Authentication + isConceptual: true + menuGroup: Concepts + operations: [] + tagDescription: > + With InfluxDB 3 Clustered, InfluxDB Management API endpoints require the + following credential: + + + - `Authorization MANAGEMENT_TOKEN`: the `Authorization` HTTP header with + a [management token](/influxdb3/clustered/admin/tokens/management/). + + See how to [create a management token](/influxdb3/clustered/admin/tokens/management/). + + By default, management tokens in InfluxDB 3 are short-lived tokens issued by an OAuth2 identity provider that grant a specific user administrative access to your InfluxDB cluster. However, for automation purposes, you can manually create management tokens that authenticate directly with your InfluxDB cluster and do not require human interaction with your identity provider. + showSecuritySchemes: true source: >- - static/openapi/influxdb-clustered/paths/influxdb-clustered-databases-{databaseName}-tables.yaml + static/openapi/influxdb-clustered/tags/tags/influxdb-clustered-authentication.yaml staticFilePath: >- - /openapi/influxdb-clustered/paths/influxdb-clustered-databases-{databaseName}-tables.yaml - - path: api/databases + /openapi/influxdb-clustered/tags/tags/influxdb-clustered-authentication.yaml + - path: api/database-tokens fields: - name: /databases - describes: - - /databases - - /databases/{databaseName} - menuName: /databases - title: /databases - tags: - - '' - - databases - apiTags: - - Databases - source: >- - static/openapi/influxdb-clustered/paths/influxdb-clustered-databases.yaml - staticFilePath: /openapi/influxdb-clustered/paths/influxdb-clustered-databases.yaml - - path: api/tokens - fields: - name: /tokens + name: Database tokens describes: - /tokens - /tokens/{tokenId} - menuName: /tokens - title: /tokens - tags: - - '' - - tokens - apiTags: - - Database tokens - source: static/openapi/influxdb-clustered/paths/influxdb-clustered-tokens.yaml - staticFilePath: /openapi/influxdb-clustered/paths/influxdb-clustered-tokens.yaml + title: Database tokens + description: Manage database read/write tokens for a cluster + tag: Database tokens + isConceptual: false + menuGroup: Other + operations: + - operationId: GetDatabaseTokens + method: GET + path: /tokens + summary: Get all database tokens for a cluster + tags: + - Database tokens + - operationId: CreateDatabaseToken + method: POST + path: /tokens + summary: Create a database token + tags: + - Database tokens + - operationId: GetDatabaseToken + method: GET + path: /tokens/{tokenId} + summary: Get a database token + tags: + - Database tokens + - operationId: UpdateDatabaseToken + method: PATCH + path: /tokens/{tokenId} + summary: Update a database token + tags: + - Database tokens + - operationId: DeleteDatabaseToken + method: DELETE + path: /tokens/{tokenId} + summary: Delete a database token + tags: + - Database tokens + tagDescription: Manage database read/write tokens for a cluster + source: >- + static/openapi/influxdb-clustered/tags/tags/influxdb-clustered-database-tokens.yaml + staticFilePath: >- + /openapi/influxdb-clustered/tags/tags/influxdb-clustered-database-tokens.yaml + - path: api/databases + fields: + name: Databases + describes: + - /databases + - /databases/{databaseName} + title: Databases + description: Manage databases for a cluster + tag: Databases + isConceptual: false + menuGroup: Other + operations: + - operationId: GetClusterDatabases + method: GET + path: /databases + summary: Get all databases for a cluster + tags: + - Databases + - operationId: CreateClusterDatabase + method: POST + path: /databases + summary: Create a database + tags: + - Databases + - operationId: UpdateClusterDatabase + method: PATCH + path: /databases/{databaseName} + summary: Update a database + tags: + - Databases + - operationId: DeleteClusterDatabase + method: DELETE + path: /databases/{databaseName} + summary: Delete a database + tags: + - Databases + tagDescription: Manage databases for a cluster + source: >- + static/openapi/influxdb-clustered/tags/tags/influxdb-clustered-databases.yaml + staticFilePath: /openapi/influxdb-clustered/tags/tags/influxdb-clustered-databases.yaml + - path: api/quickstart + fields: + name: Quickstart + describes: [] + title: Quickstart + description: > + The following example script shows how to use `curl` to make database + and token management requests: + + + ```shell + #!/bin/bash + + # Usage: + # Note the leading space in the command below to keep secrets out of the shell history + # + # ``` + # MANAGEMENT_TOKEN= ./scripts/test_http_api_v0_endpoints.sh + # ``` + + # Env var validation + if [ -z "${MANAGEMENT_TOKEN}" ]; then + echo " + [Error]: ❌ + \$MANAGEMENT_TOKEN env var is required. + " + exit 1 + fi + + HOST="https://cluster-host.com" + + # Database request functions + list_databases () { + local response=$( \ + curl \ + --location "$HOST/api/v0/databases" \ + --header "Accept: application/json" \ + --header "Authorization: Bearer $MANAGEMENT_TOKEN" \ + ) + echo "$response" + } + + create_database () { + local databaseName=$1 + local response=$( \ + curl \ + --location "$HOST/api/v0/databases" \ + --header "Accept: application/json" \ + --header 'Content-Type: application/json' \ + --header "Authorization: Bearer $MANAGEMENT_TOKEN" \ + --data '{ + "name": "'$databaseName'", + "maxTables": 75, + "maxColumnsPerTable": 90, + "retentionPeriod": 600000000000, + "partitionTemplate": [ + { + "type": "tag", + "value": "abc" + }, + { + "type": "bucket", + "value": { + "tagName": "def", + "numberOfBuckets": 5 + } + } + ] + }' \ + ) + echo "$response" + } + + update_database () { + local databaseName=$1 + local response=$( \ + curl \ + --location "$HOST/api/v0/databases/$databaseName" \ + --request PATCH \ + --header "Accept: application/json" \ + --header 'Content-Type: application/json' \ + --header "Authorization: Bearer $MANAGEMENT_TOKEN" \ + --data '{ + "maxTables": 150, + "maxColumnsPerTable": 180, + "retentionPeriod": 1200000000000 + }' \ + ) + echo "$response" + } + + delete_database () { + local databaseName=$1 + local response=$( \ + curl \ + --location "$HOST/api/v0/databases/$databaseName" \ + --request DELETE \ + --header "Accept: application/json" \ + --header "Authorization: Bearer $MANAGEMENT_TOKEN" \ + ) + echo "$response" + } + + # Token request functions + list_tokens () { + local response=$( \ + curl \ + --location "$HOST/api/v0/tokens" \ + --header "Accept: application/json" \ + --header "Authorization: Bearer $MANAGEMENT_TOKEN" \ + ) + echo "$response" + } + + create_token () { + local response=$( \ + curl \ + --location "$HOST/api/v0/tokens" \ + --header "Accept: application/json" \ + --header 'Content-Type: application/json' \ + --header "Authorization: Bearer $MANAGEMENT_TOKEN" \ + --data '{ + "description": "my test token", + "permissions": [ + { + "action": "write", + "resource": "database_one" + }, + { + "action": "read", + "resource": "database_two" + } + ] + }' \ + ) + echo "$response" + } + + get_token () { + local token_id=$1 + local response=$( \ + curl \ + --location "$HOST/api/v0/tokens/$tokenId" \ + --header "Accept: application/json" \ + --header "Authorization: Bearer $MANAGEMENT_TOKEN" \ + ) + echo "$response" + } + + update_token () { + local token_id=$1 + local response=$( \ + curl \ + --location "$HOST/api/v0/tokens/$tokenId" \ + --request PATCH \ + --header "Accept: application/json" \ + --header 'Content-Type: application/json' \ + --header "Authorization: Bearer $MANAGEMENT_TOKEN" \ + --data '{ + "description": "my updated test token", + "permissions": [ + { + "action": "database_one", + "resource": "read" + } + ] + }' \ + ) + echo "$response" + } + + delete_token () { + local token_id=$1 + local response=$( \ + curl \ + --location "$HOST/api/v0/tokens/$tokenId" \ + --request DELETE \ + --header "Accept: application/json" \ + --header "Authorization: Bearer $MANAGEMENT_TOKEN" \ + ) + echo "$response" + } + + + # Test database endpoints + databaseName="test_database_$RANDOM" + + printf "\n🏗️ Creating database... 🏗️\n\n" + response="$(create_database $databaseName)" + echo $response | jq + printf "\n🏗️ Creating database successful 🏗️\n\n" + + printf "\n⬆️ Updating database... ⬆️\n\n" + response="$(update_database $databaseName)" + echo $response | jq + printf "\n⬆️ Updating database successful ⬆️\n\n" + + printf "\n⬇️ Listing databases... ⬇️\n\n" + response="$(list_databases)" + echo $response | jq + printf "\n⬇️ Listing databases successful ⬇️\n\n" + + printf "\n🗑️ Deleting database... 🗑️\n\n" + response="$(delete_database $databaseName)" + echo $response | jq + printf "\n🗑️ Deleting database successful 🗑️\n\n" + + + # Test token endpoints + printf "\n🏗️ Creating token... 🏗️\n\n" + response="$(create_token)" + echo $response | jq + tokenId=$(echo $response | jq '.id') + printf "\n🏗️ Creating token successful 🏗️\n\n" + + printf "\n⬇️ Getting token... ⬇️\n\n" + response="$(get_token $tokenId)" + echo $response | jq + printf "\n⬇️ Getting token successful ⬇️\n\n" + + printf "\n⬆️ Updating token... ⬆️\n\n" + response="$(update_token $tokenId)" + echo $response | jq + printf "\n⬆️ Updating token successful ⬆️\n\n" + + printf "\n📋 Listing tokens... 📋\n\n" + response="$(list_tokens)" + echo $response | jq + printf "\n📋 Listing tokens successful 📋\n\n" + + printf "\n🗑️ Deleting token... 🗑️\n\n" + response="$(delete_token $tokenId)" + echo $response | jq + printf "\n🗑️ Deleting token successful 🗑️\n\n" + ``` + tag: Quickstart + isConceptual: true + menuGroup: Other + operations: [] + tagDescription: > + The following example script shows how to use `curl` to make database + and token management requests: + + + ```shell + #!/bin/bash + + # Usage: + # Note the leading space in the command below to keep secrets out of the shell history + # + # ``` + # MANAGEMENT_TOKEN= ./scripts/test_http_api_v0_endpoints.sh + # ``` + + # Env var validation + if [ -z "${MANAGEMENT_TOKEN}" ]; then + echo " + [Error]: ❌ + \$MANAGEMENT_TOKEN env var is required. + " + exit 1 + fi + + HOST="https://cluster-host.com" + + # Database request functions + list_databases () { + local response=$( \ + curl \ + --location "$HOST/api/v0/databases" \ + --header "Accept: application/json" \ + --header "Authorization: Bearer $MANAGEMENT_TOKEN" \ + ) + echo "$response" + } + + create_database () { + local databaseName=$1 + local response=$( \ + curl \ + --location "$HOST/api/v0/databases" \ + --header "Accept: application/json" \ + --header 'Content-Type: application/json' \ + --header "Authorization: Bearer $MANAGEMENT_TOKEN" \ + --data '{ + "name": "'$databaseName'", + "maxTables": 75, + "maxColumnsPerTable": 90, + "retentionPeriod": 600000000000, + "partitionTemplate": [ + { + "type": "tag", + "value": "abc" + }, + { + "type": "bucket", + "value": { + "tagName": "def", + "numberOfBuckets": 5 + } + } + ] + }' \ + ) + echo "$response" + } + + update_database () { + local databaseName=$1 + local response=$( \ + curl \ + --location "$HOST/api/v0/databases/$databaseName" \ + --request PATCH \ + --header "Accept: application/json" \ + --header 'Content-Type: application/json' \ + --header "Authorization: Bearer $MANAGEMENT_TOKEN" \ + --data '{ + "maxTables": 150, + "maxColumnsPerTable": 180, + "retentionPeriod": 1200000000000 + }' \ + ) + echo "$response" + } + + delete_database () { + local databaseName=$1 + local response=$( \ + curl \ + --location "$HOST/api/v0/databases/$databaseName" \ + --request DELETE \ + --header "Accept: application/json" \ + --header "Authorization: Bearer $MANAGEMENT_TOKEN" \ + ) + echo "$response" + } + + # Token request functions + list_tokens () { + local response=$( \ + curl \ + --location "$HOST/api/v0/tokens" \ + --header "Accept: application/json" \ + --header "Authorization: Bearer $MANAGEMENT_TOKEN" \ + ) + echo "$response" + } + + create_token () { + local response=$( \ + curl \ + --location "$HOST/api/v0/tokens" \ + --header "Accept: application/json" \ + --header 'Content-Type: application/json' \ + --header "Authorization: Bearer $MANAGEMENT_TOKEN" \ + --data '{ + "description": "my test token", + "permissions": [ + { + "action": "write", + "resource": "database_one" + }, + { + "action": "read", + "resource": "database_two" + } + ] + }' \ + ) + echo "$response" + } + + get_token () { + local token_id=$1 + local response=$( \ + curl \ + --location "$HOST/api/v0/tokens/$tokenId" \ + --header "Accept: application/json" \ + --header "Authorization: Bearer $MANAGEMENT_TOKEN" \ + ) + echo "$response" + } + + update_token () { + local token_id=$1 + local response=$( \ + curl \ + --location "$HOST/api/v0/tokens/$tokenId" \ + --request PATCH \ + --header "Accept: application/json" \ + --header 'Content-Type: application/json' \ + --header "Authorization: Bearer $MANAGEMENT_TOKEN" \ + --data '{ + "description": "my updated test token", + "permissions": [ + { + "action": "database_one", + "resource": "read" + } + ] + }' \ + ) + echo "$response" + } + + delete_token () { + local token_id=$1 + local response=$( \ + curl \ + --location "$HOST/api/v0/tokens/$tokenId" \ + --request DELETE \ + --header "Accept: application/json" \ + --header "Authorization: Bearer $MANAGEMENT_TOKEN" \ + ) + echo "$response" + } + + + # Test database endpoints + databaseName="test_database_$RANDOM" + + printf "\n🏗️ Creating database... 🏗️\n\n" + response="$(create_database $databaseName)" + echo $response | jq + printf "\n🏗️ Creating database successful 🏗️\n\n" + + printf "\n⬆️ Updating database... ⬆️\n\n" + response="$(update_database $databaseName)" + echo $response | jq + printf "\n⬆️ Updating database successful ⬆️\n\n" + + printf "\n⬇️ Listing databases... ⬇️\n\n" + response="$(list_databases)" + echo $response | jq + printf "\n⬇️ Listing databases successful ⬇️\n\n" + + printf "\n🗑️ Deleting database... 🗑️\n\n" + response="$(delete_database $databaseName)" + echo $response | jq + printf "\n🗑️ Deleting database successful 🗑️\n\n" + + + # Test token endpoints + printf "\n🏗️ Creating token... 🏗️\n\n" + response="$(create_token)" + echo $response | jq + tokenId=$(echo $response | jq '.id') + printf "\n🏗️ Creating token successful 🏗️\n\n" + + printf "\n⬇️ Getting token... ⬇️\n\n" + response="$(get_token $tokenId)" + echo $response | jq + printf "\n⬇️ Getting token successful ⬇️\n\n" + + printf "\n⬆️ Updating token... ⬆️\n\n" + response="$(update_token $tokenId)" + echo $response | jq + printf "\n⬆️ Updating token successful ⬆️\n\n" + + printf "\n📋 Listing tokens... 📋\n\n" + response="$(list_tokens)" + echo $response | jq + printf "\n📋 Listing tokens successful 📋\n\n" + + printf "\n🗑️ Deleting token... 🗑️\n\n" + response="$(delete_token $tokenId)" + echo $response | jq + printf "\n🗑️ Deleting token successful 🗑️\n\n" + ``` + source: >- + static/openapi/influxdb-clustered/tags/tags/influxdb-clustered-quickstart.yaml + staticFilePath: /openapi/influxdb-clustered/tags/tags/influxdb-clustered-quickstart.yaml + - path: api/tables + fields: + name: Tables + describes: + - /databases/{databaseName}/tables + title: Tables + description: Manage tables in a database + tag: Tables + isConceptual: false + menuGroup: Other + operations: + - operationId: CreateClusterDatabaseTable + method: POST + path: /databases/{databaseName}/tables + summary: Create a database table + tags: + - Tables + tagDescription: Manage tables in a database + source: >- + static/openapi/influxdb-clustered/tags/tags/influxdb-clustered-tables.yaml + staticFilePath: /openapi/influxdb-clustered/tags/tags/influxdb-clustered-tables.yaml diff --git a/data/article_data/influxdb/influxdb3_core/articles.json b/data/article_data/influxdb/influxdb3_core/articles.json index 4f9decca7..dfe25dd75 100644 --- a/data/article_data/influxdb/influxdb3_core/articles.json +++ b/data/article_data/influxdb/influxdb3_core/articles.json @@ -481,12 +481,12 @@ "name": "Quick start", "describes": [], "title": "Quick start", - "description": "1. [Create an admin token](#section/Authentication) to authorize API requests.\n\n ```bash\n curl -X POST \"http://localhost:8181/api/v3/configure/token/admin\"\n ```\n2. [Check the status](#section/Server-information) of the InfluxDB server.\n\n ```bash\n curl \"http://localhost:8181/health\" \\\n --header \"Authorization: Bearer ADMIN_TOKEN\"\n ```\n\n3. [Write data](#operation/PostWriteLP) to InfluxDB.\n\n ```bash\n curl \"http://localhost:8181/api/v3/write_lp?db=sensors&precision=auto\"\n --header \"Authorization: Bearer ADMIN_TOKEN\" \\\n --data-raw \"home,room=Kitchen temp=72.0\n home,room=Living\\ room temp=71.5\"\n ```\n\n If all data is written, the response is `204 No Content`.\n\n4. [Query data](#operation/GetExecuteQuerySQL) from InfluxDB.\n\n ```bash\n curl -G \"http://localhost:8181/api/v3/query_sql\" \\\n --header \"Authorization: Bearer ADMIN_TOKEN\" \\\n --data-urlencode \"db=sensors\" \\\n --data-urlencode \"q=SELECT * FROM home WHERE room='Living room'\" \\\n --data-urlencode \"format=jsonl\"\n ```\n \n Output:\n\n ```jsonl\n {\"room\":\"Living room\",\"temp\":71.5,\"time\":\"2025-02-25T20:19:34.984098\"}\n ```\n \nFor more information about using InfluxDB 3 Core, see the [Get started](/influxdb3/core/get-started/) guide.\n", + "description": "Authenticate, write, and query with the API:\n\n1. [Create an admin token](#section/Authentication) to authorize API requests.\n\n ```bash\n curl -X POST \"http://localhost:8181/api/v3/configure/token/admin\"\n ```\n2. [Check the status](#section/Server-information) of the InfluxDB server.\n\n ```bash\n curl \"http://localhost:8181/health\" \\\n --header \"Authorization: Bearer ADMIN_TOKEN\"\n ```\n\n3. [Write data](#operation/PostWriteLP) to InfluxDB.\n\n ```bash\n curl \"http://localhost:8181/api/v3/write_lp?db=sensors&precision=auto\"\n --header \"Authorization: Bearer ADMIN_TOKEN\" \\\n --data-raw \"home,room=Kitchen temp=72.0\n home,room=Living\\ room temp=71.5\"\n ```\n\n If all data is written, the response is `204 No Content`.\n\n4. [Query data](#operation/GetExecuteQuerySQL) from InfluxDB.\n\n ```bash\n curl -G \"http://localhost:8181/api/v3/query_sql\" \\\n --header \"Authorization: Bearer ADMIN_TOKEN\" \\\n --data-urlencode \"db=sensors\" \\\n --data-urlencode \"q=SELECT * FROM home WHERE room='Living room'\" \\\n --data-urlencode \"format=jsonl\"\n ```\n \n Output:\n\n ```jsonl\n {\"room\":\"Living room\",\"temp\":71.5,\"time\":\"2025-02-25T20:19:34.984098\"}\n ```\n \nFor more information about using InfluxDB 3 Core, see the [Get started](/influxdb3/core/get-started/) guide.\n", "tag": "Quick start", "isConceptual": true, "menuGroup": "Concepts", "operations": [], - "tagDescription": "1. [Create an admin token](#section/Authentication) to authorize API requests.\n\n ```bash\n curl -X POST \"http://localhost:8181/api/v3/configure/token/admin\"\n ```\n2. [Check the status](#section/Server-information) of the InfluxDB server.\n\n ```bash\n curl \"http://localhost:8181/health\" \\\n --header \"Authorization: Bearer ADMIN_TOKEN\"\n ```\n\n3. [Write data](#operation/PostWriteLP) to InfluxDB.\n\n ```bash\n curl \"http://localhost:8181/api/v3/write_lp?db=sensors&precision=auto\"\n --header \"Authorization: Bearer ADMIN_TOKEN\" \\\n --data-raw \"home,room=Kitchen temp=72.0\n home,room=Living\\ room temp=71.5\"\n ```\n\n If all data is written, the response is `204 No Content`.\n\n4. [Query data](#operation/GetExecuteQuerySQL) from InfluxDB.\n\n ```bash\n curl -G \"http://localhost:8181/api/v3/query_sql\" \\\n --header \"Authorization: Bearer ADMIN_TOKEN\" \\\n --data-urlencode \"db=sensors\" \\\n --data-urlencode \"q=SELECT * FROM home WHERE room='Living room'\" \\\n --data-urlencode \"format=jsonl\"\n ```\n \n Output:\n\n ```jsonl\n {\"room\":\"Living room\",\"temp\":71.5,\"time\":\"2025-02-25T20:19:34.984098\"}\n ```\n \nFor more information about using InfluxDB 3 Core, see the [Get started](/influxdb3/core/get-started/) guide.\n", + "tagDescription": "Authenticate, write, and query with the API:\n\n1. [Create an admin token](#section/Authentication) to authorize API requests.\n\n ```bash\n curl -X POST \"http://localhost:8181/api/v3/configure/token/admin\"\n ```\n2. [Check the status](#section/Server-information) of the InfluxDB server.\n\n ```bash\n curl \"http://localhost:8181/health\" \\\n --header \"Authorization: Bearer ADMIN_TOKEN\"\n ```\n\n3. [Write data](#operation/PostWriteLP) to InfluxDB.\n\n ```bash\n curl \"http://localhost:8181/api/v3/write_lp?db=sensors&precision=auto\"\n --header \"Authorization: Bearer ADMIN_TOKEN\" \\\n --data-raw \"home,room=Kitchen temp=72.0\n home,room=Living\\ room temp=71.5\"\n ```\n\n If all data is written, the response is `204 No Content`.\n\n4. [Query data](#operation/GetExecuteQuerySQL) from InfluxDB.\n\n ```bash\n curl -G \"http://localhost:8181/api/v3/query_sql\" \\\n --header \"Authorization: Bearer ADMIN_TOKEN\" \\\n --data-urlencode \"db=sensors\" \\\n --data-urlencode \"q=SELECT * FROM home WHERE room='Living room'\" \\\n --data-urlencode \"format=jsonl\"\n ```\n \n Output:\n\n ```jsonl\n {\"room\":\"Living room\",\"temp\":71.5,\"time\":\"2025-02-25T20:19:34.984098\"}\n ```\n \nFor more information about using InfluxDB 3 Core, see the [Get started](/influxdb3/core/get-started/) guide.\n", "source": "static/openapi/influxdb3-core/tags/tags/influxdb3-core-quick-start.yaml", "staticFilePath": "/openapi/influxdb3-core/tags/tags/influxdb3-core-quick-start.yaml" } diff --git a/data/article_data/influxdb/influxdb3_core/articles.yml b/data/article_data/influxdb/influxdb3_core/articles.yml index a1ac5b1a7..ed6a1260f 100644 --- a/data/article_data/influxdb/influxdb3_core/articles.yml +++ b/data/article_data/influxdb/influxdb3_core/articles.yml @@ -714,6 +714,9 @@ articles: describes: [] title: Quick start description: > + Authenticate, write, and query with the API: + + 1. [Create an admin token](#section/Authentication) to authorize API requests. @@ -762,6 +765,9 @@ articles: menuGroup: Concepts operations: [] tagDescription: > + Authenticate, write, and query with the API: + + 1. [Create an admin token](#section/Authentication) to authorize API requests. diff --git a/data/article_data/influxdb/influxdb3_enterprise/articles.json b/data/article_data/influxdb/influxdb3_enterprise/articles.json index 7ecdd9e12..0200cadc0 100644 --- a/data/article_data/influxdb/influxdb3_enterprise/articles.json +++ b/data/article_data/influxdb/influxdb3_enterprise/articles.json @@ -511,12 +511,12 @@ "name": "Quick start", "describes": [], "title": "Quick start", - "description": "1. [Create an admin token](#section/Authentication) to authorize API requests.\n ```bash\n curl -X POST \"http://localhost:8181/api/v3/configure/token/admin\"\n ```\n2. [Check the status](#section/Server-information) of the InfluxDB server.\n ```bash\n curl \"http://localhost:8181/health\" \\\n --header \"Authorization: Bearer ADMIN_TOKEN\"\n ```\n3. [Write data](#operation/PostWriteLP) to InfluxDB.\n ```bash\n curl \"http://localhost:8181/api/v3/write_lp?db=sensors&precision=auto\"\n --header \"Authorization: Bearer ADMIN_TOKEN\" \\\n --data-raw \"home,room=Kitchen temp=72.0\n home,room=Living\\ room temp=71.5\"\n ```\n If all data is written, the response is `204 No Content`.\n4. [Query data](#operation/GetExecuteQuerySQL) from InfluxDB.\n ```bash\n curl -G \"http://localhost:8181/api/v3/query_sql\" \\\n --header \"Authorization: Bearer ADMIN_TOKEN\" \\\n --data-urlencode \"db=sensors\" \\\n --data-urlencode \"q=SELECT * FROM home WHERE room='Living room'\" \\\n --data-urlencode \"format=jsonl\"\n ```\n \n Output:\n ```jsonl\n {\"room\":\"Living room\",\"temp\":71.5,\"time\":\"2025-02-25T20:19:34.984098\"}\n ```\n \nFor more information about using InfluxDB 3 Enterprise, see the [Get started](/influxdb3/enterprise/get-started/) guide.\n", + "description": "Authenticate, write, and query with the API:\n\n1. [Create an admin token](#section/Authentication) to authorize API requests.\n ```bash\n curl -X POST \"http://localhost:8181/api/v3/configure/token/admin\"\n ```\n2. [Check the status](#section/Server-information) of the InfluxDB server.\n ```bash\n curl \"http://localhost:8181/health\" \\\n --header \"Authorization: Bearer ADMIN_TOKEN\"\n ```\n3. [Write data](#operation/PostWriteLP) to InfluxDB.\n ```bash\n curl \"http://localhost:8181/api/v3/write_lp?db=sensors&precision=auto\"\n --header \"Authorization: Bearer ADMIN_TOKEN\" \\\n --data-raw \"home,room=Kitchen temp=72.0\n home,room=Living\\ room temp=71.5\"\n ```\n If all data is written, the response is `204 No Content`.\n4. [Query data](#operation/GetExecuteQuerySQL) from InfluxDB.\n ```bash\n curl -G \"http://localhost:8181/api/v3/query_sql\" \\\n --header \"Authorization: Bearer ADMIN_TOKEN\" \\\n --data-urlencode \"db=sensors\" \\\n --data-urlencode \"q=SELECT * FROM home WHERE room='Living room'\" \\\n --data-urlencode \"format=jsonl\"\n ```\n \n Output:\n ```jsonl\n {\"room\":\"Living room\",\"temp\":71.5,\"time\":\"2025-02-25T20:19:34.984098\"}\n ```\n \nFor more information about using InfluxDB 3 Enterprise, see the [Get started](/influxdb3/enterprise/get-started/) guide.\n", "tag": "Quick start", "isConceptual": true, "menuGroup": "Concepts", "operations": [], - "tagDescription": "1. [Create an admin token](#section/Authentication) to authorize API requests.\n ```bash\n curl -X POST \"http://localhost:8181/api/v3/configure/token/admin\"\n ```\n2. [Check the status](#section/Server-information) of the InfluxDB server.\n ```bash\n curl \"http://localhost:8181/health\" \\\n --header \"Authorization: Bearer ADMIN_TOKEN\"\n ```\n3. [Write data](#operation/PostWriteLP) to InfluxDB.\n ```bash\n curl \"http://localhost:8181/api/v3/write_lp?db=sensors&precision=auto\"\n --header \"Authorization: Bearer ADMIN_TOKEN\" \\\n --data-raw \"home,room=Kitchen temp=72.0\n home,room=Living\\ room temp=71.5\"\n ```\n If all data is written, the response is `204 No Content`.\n4. [Query data](#operation/GetExecuteQuerySQL) from InfluxDB.\n ```bash\n curl -G \"http://localhost:8181/api/v3/query_sql\" \\\n --header \"Authorization: Bearer ADMIN_TOKEN\" \\\n --data-urlencode \"db=sensors\" \\\n --data-urlencode \"q=SELECT * FROM home WHERE room='Living room'\" \\\n --data-urlencode \"format=jsonl\"\n ```\n \n Output:\n ```jsonl\n {\"room\":\"Living room\",\"temp\":71.5,\"time\":\"2025-02-25T20:19:34.984098\"}\n ```\n \nFor more information about using InfluxDB 3 Enterprise, see the [Get started](/influxdb3/enterprise/get-started/) guide.\n", + "tagDescription": "Authenticate, write, and query with the API:\n\n1. [Create an admin token](#section/Authentication) to authorize API requests.\n ```bash\n curl -X POST \"http://localhost:8181/api/v3/configure/token/admin\"\n ```\n2. [Check the status](#section/Server-information) of the InfluxDB server.\n ```bash\n curl \"http://localhost:8181/health\" \\\n --header \"Authorization: Bearer ADMIN_TOKEN\"\n ```\n3. [Write data](#operation/PostWriteLP) to InfluxDB.\n ```bash\n curl \"http://localhost:8181/api/v3/write_lp?db=sensors&precision=auto\"\n --header \"Authorization: Bearer ADMIN_TOKEN\" \\\n --data-raw \"home,room=Kitchen temp=72.0\n home,room=Living\\ room temp=71.5\"\n ```\n If all data is written, the response is `204 No Content`.\n4. [Query data](#operation/GetExecuteQuerySQL) from InfluxDB.\n ```bash\n curl -G \"http://localhost:8181/api/v3/query_sql\" \\\n --header \"Authorization: Bearer ADMIN_TOKEN\" \\\n --data-urlencode \"db=sensors\" \\\n --data-urlencode \"q=SELECT * FROM home WHERE room='Living room'\" \\\n --data-urlencode \"format=jsonl\"\n ```\n \n Output:\n ```jsonl\n {\"room\":\"Living room\",\"temp\":71.5,\"time\":\"2025-02-25T20:19:34.984098\"}\n ```\n \nFor more information about using InfluxDB 3 Enterprise, see the [Get started](/influxdb3/enterprise/get-started/) guide.\n", "source": "static/openapi/influxdb3-enterprise/tags/tags/influxdb3-enterprise-quick-start.yaml", "staticFilePath": "/openapi/influxdb3-enterprise/tags/tags/influxdb3-enterprise-quick-start.yaml" } diff --git a/data/article_data/influxdb/influxdb3_enterprise/articles.yml b/data/article_data/influxdb/influxdb3_enterprise/articles.yml index c1f4f3d8e..b8b3eb8b2 100644 --- a/data/article_data/influxdb/influxdb3_enterprise/articles.yml +++ b/data/article_data/influxdb/influxdb3_enterprise/articles.yml @@ -707,6 +707,9 @@ articles: describes: [] title: Quick start description: > + Authenticate, write, and query with the API: + + 1. [Create an admin token](#section/Authentication) to authorize API requests. ```bash @@ -747,6 +750,9 @@ articles: menuGroup: Concepts operations: [] tagDescription: > + Authenticate, write, and query with the API: + + 1. [Create an admin token](#section/Authentication) to authorize API requests. ```bash