diff --git a/contracts/common.yml b/contracts/common.yml index dcf366600..d81190c99 100644 --- a/contracts/common.yml +++ b/contracts/common.yml @@ -14,7 +14,7 @@ paths: summary: Create a user session. description: | Authenticates [Basic authentication credentials](#section/Authentication/BasicAuthentication) - for a [user](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#user), + for a [user](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user), and then, if successful, generates a user session. To authenticate a user, pass the HTTP `Authorization` header with the @@ -120,7 +120,7 @@ paths: #### Related guides - - [Influx ping](https://docs.influxdata.com/influxdb/v2.3/reference/cli/influx/ping/) + - [Influx ping](https://docs.influxdata.com/influxdb/latest/reference/cli/influx/ping/) servers: - url: '' tags: @@ -165,7 +165,7 @@ paths: #### Related guides - - [Influx ping](https://docs.influxdata.com/influxdb/v2.3/reference/cli/influx/ping/) + - [Influx ping](https://docs.influxdata.com/influxdb/latest/reference/cli/influx/ping/) servers: - url: '' tags: @@ -1012,7 +1012,7 @@ paths: description: | Writes data to a bucket. - Use this endpoint to send data in [line protocol](https://docs.influxdata.com/influxdb/v2.3/reference/syntax/line-protocol/) format to InfluxDB. + Use this endpoint to send data in [line protocol](https://docs.influxdata.com/influxdb/latest/reference/syntax/line-protocol/) format to InfluxDB. #### InfluxDB Cloud @@ -1047,12 +1047,12 @@ paths: #### Related guides - - [Write data with the InfluxDB API](https://docs.influxdata.com/influxdb/v2.3/write-data/developer-tools/api) - - [Optimize writes to InfluxDB](https://docs.influxdata.com/influxdb/v2.3/write-data/best-practices/optimize-writes/) - - [Troubleshoot issues writing data](https://docs.influxdata.com/influxdb/v2.3/write-data/troubleshoot/) + - [Write data with the InfluxDB API](https://docs.influxdata.com/influxdb/latest/write-data/developer-tools/api) + - [Optimize writes to InfluxDB](https://docs.influxdata.com/influxdb/latest/write-data/best-practices/optimize-writes/) + - [Troubleshoot issues writing data](https://docs.influxdata.com/influxdb/latest/write-data/troubleshoot/) requestBody: description: | - In the request body, provide data in [line protocol format](https://docs.influxdata.com/influxdb/v2.3/reference/syntax/line-protocol/). + In the request body, provide data in [line protocol format](https://docs.influxdata.com/influxdb/latest/reference/syntax/line-protocol/). To send compressed data, do the following: @@ -1062,7 +1062,7 @@ paths: #### Related guides - - [Best practices for optimizing writes](https://docs.influxdata.com/influxdb/v2.3/write-data/best-practices/optimize-writes/) + - [Best practices for optimizing writes](https://docs.influxdata.com/influxdb/latest/write-data/best-practices/optimize-writes/) required: true content: text/plain: @@ -1130,7 +1130,7 @@ paths: #### Related guides - - [Troubleshoot issues writing data](https://docs.influxdata.com/influxdb/v2.3/write-data/troubleshoot/) + - [Troubleshoot issues writing data](https://docs.influxdata.com/influxdb/latest/write-data/troubleshoot/) schema: type: string description: Error content type. @@ -1205,7 +1205,7 @@ paths: #### Related guides - - [How to check for write errors](https://docs.influxdata.com/influxdb/v2.3/write-data/troubleshoot/) + - [How to check for write errors](https://docs.influxdata.com/influxdb/latest/write-data/troubleshoot/) '400': description: | Bad request. The response body contains detail about the error. @@ -1363,8 +1363,8 @@ paths: #### Related guides - - [Delete data](https://docs.influxdata.com/influxdb/v2.3/write-data/delete-data/) - - Learn how to use [delete predicate syntax](https://docs.influxdata.com/influxdb/v2.3/reference/syntax/delete-predicate/). + - [Delete data](https://docs.influxdata.com/influxdb/latest/write-data/delete-data/) + - Learn how to use [delete predicate syntax](https://docs.influxdata.com/influxdb/latest/reference/syntax/delete-predicate/). - Learn how InfluxDB handles [deleted tags](https://docs.influxdata.com/flux/v0.x/stdlib/influxdata/influxdb/schema/measurementtagkeys/) and [deleted fields](https://docs.influxdata.com/flux/v0.x/stdlib/influxdata/influxdb/schema/measurementfieldkeys/). x-codeSamples: @@ -1390,8 +1390,8 @@ paths: #### Related guides - - [Delete data](https://docs.influxdata.com/influxdb/v2.3/write-data/delete-data/) - - Learn how to use [delete predicate syntax](https://docs.influxdata.com/influxdb/v2.3/reference/syntax/delete-predicate/). + - [Delete data](https://docs.influxdata.com/influxdb/latest/write-data/delete-data/) + - Learn how to use [delete predicate syntax](https://docs.influxdata.com/influxdb/latest/reference/syntax/delete-predicate/). required: true content: application/json: @@ -2284,7 +2284,7 @@ paths: summary: Generate a query Abstract Syntax Tree (AST) description: | Analyzes a Flux query and returns a complete package source [Abstract Syntax - Tree (AST)](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#abstract-syntax-tree-ast) + Tree (AST)](https://docs.influxdata.com/influxdb/latest/reference/glossary/#abstract-syntax-tree-ast) for the query. Use this endpoint for deep query analysis such as debugging unexpected query @@ -3617,7 +3617,7 @@ paths: #### Related guides - - [Query with the InfluxDB API](https://docs.influxdata.com/influxdb/v2.3/query-data/execute-queries/influx-api/) + - [Query with the InfluxDB API](https://docs.influxdata.com/influxdb/latest/query-data/execute-queries/influx-api/) - [Get started with Flux](https://docs.influxdata.com/flux/v0.x/get-started/) parameters: - $ref: '#/components/parameters/TraceSpan' @@ -3748,9 +3748,9 @@ paths: description: | #### InfluxDB Cloud: - returns this error if a **read** or **write** request exceeds your - plan's [adjustable service quotas](https://docs.influxdata.com/influxdb/v2.3/account-management/limits/#adjustable-service-quotas) + plan's [adjustable service quotas](https://docs.influxdata.com/influxdb/latest/account-management/limits/#adjustable-service-quotas) or if a **delete** request exceeds the maximum - [global limit](https://docs.influxdata.com/influxdb/v2.3/account-management/limits/#global-limits) + [global limit](https://docs.influxdata.com/influxdb/latest/account-management/limits/#global-limits) - returns `Retry-After` header that describes when to try the write again. #### InfluxDB OSS: @@ -3772,19 +3772,19 @@ paths: - Buckets summary: List buckets description: | - Lists [buckets](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#bucket). + Lists [buckets](https://docs.influxdata.com/influxdb/latest/reference/glossary/#bucket). InfluxDB retrieves buckets owned by the - [organization](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#organization) + [organization](https://docs.influxdata.com/influxdb/latest/reference/glossary/#organization) associated with the authorization - ([API token](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#token)). + ([API token](https://docs.influxdata.com/influxdb/latest/reference/glossary/#token)). To limit which buckets are returned, pass query parameters in your request. If no query parameters are passed, InfluxDB returns all buckets up to the default `limit`. #### InfluxDB OSS - - If you use an _[operator token](https://docs.influxdata.com/influxdb/v2.3/security/tokens/#operator-token)_ + - If you use an _[operator token](https://docs.influxdata.com/influxdb/latest/security/tokens/#operator-token)_ to authenticate your request, InfluxDB retrieves resources for _all organizations_ in the instance. To retrieve resources for only a specific organization, use the @@ -3795,11 +3795,11 @@ paths: | Action | Permission required | |:--------------------------|:--------------------| | Retrieve _user buckets_ | `read-buckets` | - | Retrieve [_system buckets_](https://docs.influxdata.com/influxdb/v2.3/reference/internals/system-buckets/) | `read-orgs` | + | Retrieve [_system buckets_](https://docs.influxdata.com/influxdb/latest/reference/internals/system-buckets/) | `read-orgs` | #### Related Guides - - [Manage buckets](https://docs.influxdata.com/influxdb/v2.3/organizations/buckets/) + - [Manage buckets](https://docs.influxdata.com/influxdb/latest/organizations/buckets/) parameters: - $ref: '#/components/parameters/TraceSpan' - $ref: '#/components/parameters/Offset' @@ -3908,10 +3908,10 @@ paths: - Buckets summary: Create a bucket description: | - Creates a [bucket](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#bucket) + Creates a [bucket](https://docs.influxdata.com/influxdb/latest/reference/glossary/#bucket) and returns the bucket resource. The default data - [retention period](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#retention-period) + [retention period](https://docs.influxdata.com/influxdb/latest/reference/glossary/#retention-period) is 30 days. #### InfluxDB OSS @@ -3930,8 +3930,8 @@ paths: #### Related Guides - - [Create a bucket](https://docs.influxdata.com/influxdb/v2.3/organizations/buckets/create-bucket/) - - [Create bucket CLI reference](https://docs.influxdata.com/influxdb/v2.3/reference/cli/influx/bucket/create) + - [Create a bucket](https://docs.influxdata.com/influxdb/latest/organizations/buckets/create-bucket/) + - [Create bucket CLI reference](https://docs.influxdata.com/influxdb/latest/reference/cli/influx/bucket/create) parameters: - $ref: '#/components/parameters/TraceSpan' requestBody: @@ -4137,7 +4137,7 @@ paths: #### Related Guides - - [Update a bucket](https://docs.influxdata.com/influxdb/v2.3/organizations/buckets/update-bucket/) + - [Update a bucket](https://docs.influxdata.com/influxdb/latest/organizations/buckets/update-bucket/) requestBody: description: The bucket update to apply. required: true @@ -4283,7 +4283,7 @@ paths: #### Related Guides - - [Delete a bucket](https://docs.influxdata.com/influxdb/v2.3/organizations/buckets/delete-bucket/#delete-a-bucket-in-the-influxdb-ui) + - [Delete a bucket](https://docs.influxdata.com/influxdb/latest/organizations/buckets/delete-bucket/#delete-a-bucket-in-the-influxdb-ui) parameters: - $ref: '#/components/parameters/TraceSpan' - in: path @@ -4369,7 +4369,7 @@ paths: #### Related guides - Use the [`/api/v2/labels` InfluxDB API endpoint](#tag/Labels) to retrieve and manage labels. - - [Manage labels in the InfluxDB UI](https://docs.influxdata.com/influxdb/v2.3/visualize-data/labels/) + - [Manage labels in the InfluxDB UI](https://docs.influxdata.com/influxdb/latest/visualize-data/labels/) parameters: - $ref: '#/components/parameters/TraceSpan' - in: path @@ -4433,7 +4433,7 @@ paths: #### Related guides - Use the [`/api/v2/labels` InfluxDB API endpoint](#tag/Labels) to retrieve and manage labels. - - [Manage labels in the InfluxDB UI](https://docs.influxdata.com/influxdb/v2.3/visualize-data/labels/) + - [Manage labels in the InfluxDB UI](https://docs.influxdata.com/influxdb/latest/visualize-data/labels/) parameters: - $ref: '#/components/parameters/TraceSpan' - in: path @@ -4559,18 +4559,18 @@ paths: description: | Lists all users for a bucket. - InfluxDB [users](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#user) have + InfluxDB [users](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user) have permission to access InfluxDB. - [Members](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#member) are users in + [Members](https://docs.influxdata.com/influxdb/latest/reference/glossary/#member) are users in an organization with access to the specified resource. Use this endpoint to retrieve all users with access to a bucket. #### Related guides - - [Manage users](https://docs.influxdata.com/influxdb/v2.3/users/) - - [Manage members](https://docs.influxdata.com/influxdb/v2.3/organizations/members/) + - [Manage users](https://docs.influxdata.com/influxdb/latest/users/) + - [Manage members](https://docs.influxdata.com/influxdb/latest/organizations/members/) parameters: - $ref: '#/components/parameters/TraceSpan' - in: path @@ -4629,18 +4629,18 @@ paths: description: | Add a user to a bucket and return the new user information. - InfluxDB [users](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#user) have + InfluxDB [users](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user) have permission to access InfluxDB. - [Members](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#member) are users in + [Members](https://docs.influxdata.com/influxdb/latest/reference/glossary/#member) are users in an organization. Use this endpoint to give a user member privileges to a bucket. #### Related guides - - [Manage users](https://docs.influxdata.com/influxdb/v2.3/users/) - - [Manage members](https://docs.influxdata.com/influxdb/v2.3/organizations/members/) + - [Manage users](https://docs.influxdata.com/influxdb/latest/users/) + - [Manage members](https://docs.influxdata.com/influxdb/latest/organizations/members/) parameters: - $ref: '#/components/parameters/TraceSpan' - in: path @@ -4720,8 +4720,8 @@ paths: #### Related guides - - [Manage users](https://docs.influxdata.com/influxdb/v2.3/users/) - - [Manage members](https://docs.influxdata.com/influxdb/v2.3/organizations/members/) + - [Manage users](https://docs.influxdata.com/influxdb/latest/users/) + - [Manage members](https://docs.influxdata.com/influxdb/latest/organizations/members/) parameters: - $ref: '#/components/parameters/TraceSpan' - in: path @@ -4762,7 +4762,7 @@ paths: - Buckets summary: List all owners of a bucket description: | - Lists all [owners](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#owner) + Lists all [owners](https://docs.influxdata.com/influxdb/latest/reference/glossary/#owner) of a bucket. Bucket owners have permission to delete buckets and remove user and member @@ -4791,7 +4791,7 @@ paths: #### Related guides - - [Manage users](https://docs.influxdata.com/influxdb/v2.3/users/) + - [Manage users](https://docs.influxdata.com/influxdb/latest/users/) parameters: - $ref: '#/components/parameters/TraceSpan' - in: path @@ -4842,7 +4842,7 @@ paths: - Buckets summary: Add an owner to a bucket description: | - Adds an owner to a bucket and returns the [owners](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#owner) + Adds an owner to a bucket and returns the [owners](https://docs.influxdata.com/influxdb/latest/reference/glossary/#owner) with role and user detail. Use this endpoint to create a _resource owner_ for the bucket. @@ -4871,7 +4871,7 @@ paths: #### Related guides - - [Manage users](https://docs.influxdata.com/influxdb/v2.3/users/) + - [Manage users](https://docs.influxdata.com/influxdb/latest/users/) parameters: - $ref: '#/components/parameters/TraceSpan' - in: path @@ -4973,7 +4973,7 @@ paths: #### Related guides - - [Manage users](https://docs.influxdata.com/influxdb/v2.3/users/) + - [Manage users](https://docs.influxdata.com/influxdb/latest/users/) parameters: - $ref: '#/components/parameters/TraceSpan' - in: path @@ -5015,7 +5015,7 @@ paths: - Security and access endpoints summary: List organizations description: | - Lists [organizations](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#organization/). + Lists [organizations](https://docs.influxdata.com/influxdb/latest/reference/glossary/#organization/). To limit which organizations are returned, pass query parameters in your request. If no query parameters are passed, InfluxDB returns all organizations up to the default `limit`. @@ -5026,7 +5026,7 @@ paths: #### Related guides - - [View organizations](https://docs.influxdata.com/influxdb/v2.3/organizations/view-orgs/) + - [View organizations](https://docs.influxdata.com/influxdb/latest/organizations/view-orgs/) parameters: - $ref: '#/components/parameters/TraceSpan' - $ref: '#/components/parameters/Offset' @@ -5097,7 +5097,7 @@ paths: - Organizations summary: Create an organization description: | - Creates an [organization](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#organization) + Creates an [organization](https://docs.influxdata.com/influxdb/latest/reference/glossary/#organization) and returns the newly created organization. #### InfluxDB Cloud @@ -5106,7 +5106,7 @@ paths: #### Related guides - - [Manage organizations](https://docs.influxdata.com/influxdb/v2.3/organizations) + - [Manage organizations](https://docs.influxdata.com/influxdb/latest/organizations) parameters: - $ref: '#/components/parameters/TraceSpan' requestBody: @@ -5187,7 +5187,7 @@ paths: #### Related guides - - [View organizations](https://docs.influxdata.com/influxdb/v2.3/organizations/view-orgs/) + - [View organizations](https://docs.influxdata.com/influxdb/latest/organizations/view-orgs/) parameters: - $ref: '#/components/parameters/TraceSpan' - in: path @@ -5256,7 +5256,7 @@ paths: #### Related Guides - - [Update an organization](https://docs.influxdata.com/influxdb/v2.3/organizations/update-org/) + - [Update an organization](https://docs.influxdata.com/influxdb/latest/organizations/update-org/) requestBody: description: The organization update to apply. required: true @@ -5324,7 +5324,7 @@ paths: #### Related guides - - [Delete organizations](https://docs.influxdata.com/influxdb/v2.3/organizations/delete-orgs/) + - [Delete organizations](https://docs.influxdata.com/influxdb/latest/organizations/delete-orgs/) parameters: - $ref: '#/components/parameters/TraceSpan' - in: path @@ -5438,10 +5438,10 @@ paths: description: | Lists all users that belong to an organization. - InfluxDB [users](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#user) have + InfluxDB [users](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user) have permission to access InfluxDB. - [Members](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#member) are users + [Members](https://docs.influxdata.com/influxdb/latest/reference/glossary/#member) are users within the organization. #### InfluxDB Cloud @@ -5463,8 +5463,8 @@ paths: #### Related guides - - [Manage users](https://docs.influxdata.com/influxdb/v2.3/users/) - - [Manage members](https://docs.influxdata.com/influxdb/v2.3/organizations/members/) + - [Manage users](https://docs.influxdata.com/influxdb/latest/users/) + - [Manage members](https://docs.influxdata.com/influxdb/latest/organizations/members/) parameters: - $ref: '#/components/parameters/TraceSpan' - in: path @@ -5536,10 +5536,10 @@ paths: description: | Add a user to an organization. - InfluxDB [users](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#user) have + InfluxDB [users](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user) have permission to access InfluxDB. - [Members](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#member) are users + [Members](https://docs.influxdata.com/influxdb/latest/reference/glossary/#member) are users within the organization. #### InfluxDB Cloud @@ -5559,8 +5559,8 @@ paths: #### Related guides - - [Manage users](https://docs.influxdata.com/influxdb/v2.3/users/) - - [Manage members](https://docs.influxdata.com/influxdb/v2.3/organizations/members/) + - [Manage users](https://docs.influxdata.com/influxdb/latest/users/) + - [Manage members](https://docs.influxdata.com/influxdb/latest/organizations/members/) parameters: - $ref: '#/components/parameters/TraceSpan' - in: path @@ -5660,7 +5660,7 @@ paths: #### Related guides - - [Manage members](https://docs.influxdata.com/influxdb/v2.3/organizations/members/) + - [Manage members](https://docs.influxdata.com/influxdb/latest/organizations/members/) parameters: - $ref: '#/components/parameters/TraceSpan' - in: path @@ -5843,7 +5843,7 @@ paths: - Security and access endpoints summary: Remove an owner from an organization description: | - Removes an [owner](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#owner) from + Removes an [owner](https://docs.influxdata.com/influxdb/latest/reference/glossary/#owner) from the organization. Organization owners have permission to delete organizations and remove user and member @@ -5997,7 +5997,7 @@ paths: #### Related guides - - [View InfluxDB stacks](https://docs.influxdata.com/influxdb/v2.3/influxdb-templates/stacks/). + - [View InfluxDB stacks](https://docs.influxdata.com/influxdb/latest/influxdb-templates/stacks/). parameters: - in: query name: orgID @@ -6006,7 +6006,7 @@ paths: type: string description: | An organization ID. - Only returns stacks owned by the specified [organization](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#organization). + Only returns stacks owned by the specified [organization](https://docs.influxdata.com/influxdb/latest/reference/glossary/#organization). #### InfluxDB Cloud @@ -6115,8 +6115,8 @@ paths: #### Related guides - - [Initialize an InfluxDB stack](https://docs.influxdata.com/influxdb/v2.3/influxdb-templates/stacks/init/). - - [Use InfluxDB templates](https://docs.influxdata.com/influxdb/v2.3/influxdb-templates/use/#apply-templates-to-an-influxdb-instance). + - [Initialize an InfluxDB stack](https://docs.influxdata.com/influxdb/latest/influxdb-templates/stacks/init/). + - [Use InfluxDB templates](https://docs.influxdata.com/influxdb/latest/influxdb-templates/use/#apply-templates-to-an-influxdb-instance). requestBody: description: The stack to create. required: true @@ -6311,8 +6311,8 @@ paths: summary: Apply or dry-run a template description: | Applies a template to - create or update a [stack](https://docs.influxdata.com/influxdb/v2.3/influxdb-templates/stacks/) of InfluxDB - [resources](https://docs.influxdata.com/influxdb/v2.3/reference/cli/influx/export/all/#resources). + create or update a [stack](https://docs.influxdata.com/influxdb/latest/influxdb-templates/stacks/) of InfluxDB + [resources](https://docs.influxdata.com/influxdb/latest/reference/cli/influx/export/all/#resources). The response contains the diff of changes and the stack ID. Use this endpoint to install an InfluxDB template to an organization. @@ -6328,18 +6328,18 @@ paths: #### Custom values for templates - - Some templates may contain [environment references](https://docs.influxdata.com/influxdb/v2.3/influxdb-templates/create/#include-user-definable-resource-names) for custom metadata. + - Some templates may contain [environment references](https://docs.influxdata.com/influxdb/latest/influxdb-templates/create/#include-user-definable-resource-names) for custom metadata. To provide custom values for environment references, pass the _`envRefs`_ property in the request body. For more information and examples, see how to - [define environment references](https://docs.influxdata.com/influxdb/v2.3/influxdb-templates/use/#define-environment-references). + [define environment references](https://docs.influxdata.com/influxdb/latest/influxdb-templates/use/#define-environment-references). - Some templates may contain queries that use - [secrets](https://docs.influxdata.com/influxdb/v2.3/security/secrets/). + [secrets](https://docs.influxdata.com/influxdb/latest/security/secrets/). To provide custom secret values, pass the _`secrets`_ property in the request body. Don't expose secret values in templates. - For more information, see [how to pass secrets when installing a template](https://docs.influxdata.com/influxdb/v2.3/influxdb-templates/use/#pass-secrets-when-installing-a-template). + For more information, see [how to pass secrets when installing a template](https://docs.influxdata.com/influxdb/latest/influxdb-templates/use/#pass-secrets-when-installing-a-template). #### Required permissions @@ -6352,8 +6352,8 @@ paths: #### Related guides - - [Use templates](https://docs.influxdata.com/influxdb/v2.3/influxdb-templates/use/) - - [Stacks](https://docs.influxdata.com/influxdb/v2.3/influxdb-templates/stacks/) + - [Use templates](https://docs.influxdata.com/influxdb/latest/influxdb-templates/use/) + - [Stacks](https://docs.influxdata.com/influxdb/latest/influxdb-templates/stacks/) requestBody: required: true description: | @@ -6639,7 +6639,7 @@ paths: - Tasks summary: List runs for a task description: | - Lists runs for the specified [task](https://docs.influxdata.com/influxdb/v2.3/process-data/). + Lists runs for the specified [task](https://docs.influxdata.com/influxdb/latest/process-data/). To limit which task runs are returned, pass query parameters in your request. If you don't pass query parameters, InfluxDB returns all runs for the task @@ -6653,7 +6653,7 @@ paths: required: true description: | A task ID. - Specifies the [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task) to + Specifies the [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task) to to list runs for. - in: query name: after @@ -6675,7 +6675,7 @@ paths: type: string format: date-time description: | - A timestamp ([RFC3339 date/time format](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#rfc3339-timestamp)). + A timestamp ([RFC3339 date/time format](https://docs.influxdata.com/influxdb/latest/reference/glossary/#rfc3339-timestamp)). Only returns runs scheduled after the specified time. - in: query name: beforeTime @@ -6683,7 +6683,7 @@ paths: type: string format: date-time description: | - A timestamp ([RFC3339 date/time format](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#rfc3339-timestamp)). + A timestamp ([RFC3339 date/time format](https://docs.influxdata.com/influxdb/latest/reference/glossary/#rfc3339-timestamp)). Only returns runs scheduled before the specified time. responses: '200': @@ -6726,7 +6726,7 @@ paths: required: true description: | A task ID. - Specifies the [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task) to + Specifies the [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task) to to run. requestBody: content: @@ -6765,7 +6765,7 @@ paths: - Tasks summary: Retrieve a run for a task. description: | - Retrieves the specified run for the specified [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task). + Retrieves the specified run for the specified [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task). Use this endpoint to retrieve detail and logs for a specific task run. parameters: @@ -6777,7 +6777,7 @@ paths: required: true description: | A task ID. - Specifies the [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task) + Specifies the [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task) that the task run belongs to. - in: path name: runID @@ -6831,7 +6831,7 @@ paths: - Tasks summary: Cancel a running task description: | - Cancels a running [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task). + Cancels a running [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task). Use this endpoint to cancel a running task. @@ -6847,7 +6847,7 @@ paths: required: true description: | A task ID. - Specifies the [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task) to + Specifies the [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task) to to cancel. - in: path name: runID @@ -6898,7 +6898,7 @@ paths: - Tasks summary: Retry a task run description: | - Queues a [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task) run to + Queues a [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task) run to retry and then returns the scheduled run. To manually start a _new_ task run, use the @@ -6921,7 +6921,7 @@ paths: required: true description: | A task ID. - Specifies the [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task) that the task run belongs to. + Specifies the [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task) that the task run belongs to. - in: path name: runID schema: @@ -6988,7 +6988,7 @@ paths: - Tasks summary: List logs for a task description: | - Lists all log events for a [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task). + Lists all log events for a [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task). When a task runs, InfluxDB creates a `run` record in the task’s history. Logs associated with each run provide relevant log messages, timestamps, and the exit status of the `run` attempt. @@ -7002,7 +7002,7 @@ paths: schema: type: string required: true - description: 'A task ID. Specifies the [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task) to retrieve logs for.' + description: 'A task ID. Specifies the [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task) to retrieve logs for.' responses: '200': description: | @@ -7058,7 +7058,7 @@ paths: Lists all logs for a task run. A log is a list of run events with `runID`, `time`, and `message` properties. - Use this endpoint to help analyze [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task) performance and troubleshoot failed task runs. + Use this endpoint to help analyze [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task) performance and troubleshoot failed task runs. parameters: - $ref: '#/components/parameters/TraceSpan' - in: path @@ -7066,7 +7066,7 @@ paths: schema: type: string required: true - description: 'A task ID. Specifies the [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task) that the run belongs to.' + description: 'A task ID. Specifies the [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task) that the run belongs to.' - in: path name: runID schema: @@ -7163,7 +7163,7 @@ paths: - Tasks summary: Add a label to a task description: | - Adds a label to a [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task). + Adds a label to a [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task). Use this endpoint to add a label to a task. Labels are a way to add metadata to InfluxDB resources. @@ -7178,7 +7178,7 @@ paths: required: true description: | A task ID. - Specifies the [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task) to label. + Specifies the [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task) to label. requestBody: description: | In the request body, provide an object that specifies the label. @@ -7211,7 +7211,7 @@ paths: - Tasks summary: Delete a label from a task description: | - Deletes a label from a [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task). + Deletes a label from a [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task). parameters: - $ref: '#/components/parameters/TraceSpan' - in: path @@ -7221,7 +7221,7 @@ paths: required: true description: | A task ID. - Specifies the [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task) to delete the label from. + Specifies the [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task) to delete the label from. - in: path name: labelID schema: @@ -7260,7 +7260,7 @@ paths: 1. Use [token authentication](#section/Authentication/TokenAuthentication) or a [user session](#tag/Signin) with this endpoint to retrieve feature flags and their values. - 2. Follow the instructions to [enable, disable, or override values for feature flags](https://docs.influxdata.com/influxdb/v2.3/influxdb/v2.4/reference/config-options/#feature-flags). + 2. Follow the instructions to [enable, disable, or override values for feature flags](https://docs.influxdata.com/influxdb/latest/influxdb/v2.4/reference/config-options/#feature-flags). 3. **Optional**: To confirm that your change is applied, do one of the following: - Send a request to this endpoint to retrieve the current feature flag values. @@ -7269,7 +7269,7 @@ paths: #### Related guides - - [InfluxDB configuration options](https://docs.influxdata.com/influxdb/v2.3/influxdb/v2.4/reference/config-options/) + - [InfluxDB configuration options](https://docs.influxdata.com/influxdb/latest/influxdb/v2.4/reference/config-options/) parameters: - $ref: '#/components/parameters/TraceSpan' responses: @@ -7317,7 +7317,7 @@ paths: - Users summary: Update a password description: | - Updates the password for the signed-in [user](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#user). + Updates the password for the signed-in [user](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user). This endpoint represents the third step in the following three-step process to let a user with a user session update their password: @@ -7355,7 +7355,7 @@ paths: required: true description: | The user session cookie for the - [user](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#user) + [user](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user) signed in with [Basic authentication credentials](#section/Authentication/BasicAuthentication). #### Related guides @@ -7402,7 +7402,7 @@ paths: **Deprecated**: Tasks don't use `owner` and `member` roles. Use [`/api/v2/authorizations`](#tag/Authorizations) to assign user permissions. - Lists all users that have the `member` role for the specified [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task). + Lists all users that have the `member` role for the specified [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task). parameters: - $ref: '#/components/parameters/TraceSpan' - in: path @@ -7412,7 +7412,7 @@ paths: required: true description: | A task ID. - Specifies the [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task) to retrieve members for. + Specifies the [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task) to retrieve members for. responses: '200': description: | @@ -7440,7 +7440,7 @@ paths: **Deprecated**: Tasks don't use `owner` and `member` roles. Use [`/api/v2/authorizations`](#tag/Authorizations) to assign user permissions. - Adds a specified user to members of the specified [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task) and then returns + Adds a specified user to members of the specified [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task) and then returns the member. parameters: - $ref: '#/components/parameters/TraceSpan' @@ -7450,7 +7450,7 @@ paths: type: string required: true description: | - A [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task) ID. + A [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task) ID. Specifies the task for the member. requestBody: description: | @@ -7487,7 +7487,7 @@ paths: **Deprecated**: Tasks don't use `owner` and `member` roles. Use [`/api/v2/authorizations`](#tag/Authorizations) to assign user permissions. - Removes a member from a [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task). + Removes a member from a [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task). parameters: - $ref: '#/components/parameters/TraceSpan' - in: path @@ -7501,7 +7501,7 @@ paths: schema: type: string required: true - description: 'A task ID. Specifies the [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task) to remove the member from.' + description: 'A task ID. Specifies the [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task) to remove the member from.' responses: '204': description: Success. The member is removed. @@ -7588,7 +7588,7 @@ paths: required: true description: | A task ID. - Specifies the [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task) for the owner. + Specifies the [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task) for the owner. requestBody: description: | In the request body, provide an object that specifies the user. @@ -7651,7 +7651,7 @@ paths: **Deprecated**: Tasks don't use `owner` and `member` roles. Use [`/api/v2/authorizations`](#tag/Authorizations) to assign user permissions. - Removes an owner from a [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task). + Removes an owner from a [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task). parameters: - $ref: '#/components/parameters/TraceSpan' - in: path @@ -7659,7 +7659,7 @@ paths: schema: type: string required: true - description: 'A user ID. Specifies the owner to remove from the [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task).' + description: 'A user ID. Specifies the owner to remove from the [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task).' - in: path name: taskID schema: @@ -7667,7 +7667,7 @@ paths: required: true description: | A task ID. - Specifies the [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task) to remove the owner from. + Specifies the [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task) to remove the owner from. responses: '204': description: Success. The owner is removed. @@ -8787,7 +8787,7 @@ components: The offset for pagination. The number of records to skip. - For more information about pagination parameters, see [Pagination](https://docs.influxdata.com/influxdb/v2.3/api/#tag/Pagination). + For more information about pagination parameters, see [Pagination](https://docs.influxdata.com/influxdb/latest/api/#tag/Pagination). schema: type: integer minimum: 0 @@ -8827,7 +8827,7 @@ components: results don't include the specified record. Use `after` instead of the `offset` parameter. - For more information about pagination parameters, see [Pagination](https://docs.influxdata.com/influxdb/v2.3/api/#tag/Pagination). + For more information about pagination parameters, see [Pagination](https://docs.influxdata.com/influxdb/latest/api/#tag/Pagination). schemas: LanguageRequest: description: Flux query to be analyzed. @@ -8955,19 +8955,19 @@ components: properties: start: description: | - A timestamp ([RFC3339 date/time format](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#rfc3339-timestamp)). + A timestamp ([RFC3339 date/time format](https://docs.influxdata.com/influxdb/latest/reference/glossary/#rfc3339-timestamp)). The earliest time to delete from. type: string format: date-time stop: description: | - A timestamp ([RFC3339 date/time format](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#rfc3339-timestamp)). + A timestamp ([RFC3339 date/time format](https://docs.influxdata.com/influxdb/latest/reference/glossary/#rfc3339-timestamp)). The latest time to delete from. type: string format: date-time predicate: description: | - An expression in [delete predicate syntax](https://docs.influxdata.com/influxdb/v2.3/reference/syntax/delete-predicate/). + An expression in [delete predicate syntax](https://docs.influxdata.com/influxdb/latest/reference/syntax/delete-predicate/). example: tag1="value1" and (tag2="value2" and tag3!="value3") type: string Node: @@ -9256,7 +9256,7 @@ components: value: type: boolean DateTimeLiteral: - description: 'Represents an instant in time with nanosecond precision in [RFC3339Nano date/time format](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#rfc3339nano-timestamp).' + description: 'Represents an instant in time with nanosecond precision in [RFC3339Nano date/time format](https://docs.influxdata.com/influxdb/latest/reference/glossary/#rfc3339nano-timestamp).' type: object properties: type: @@ -9356,7 +9356,7 @@ components: Dialect: description: | Options for tabular data output. - Default output is [annotated CSV](https://docs.influxdata.com/influxdb/v2.3/reference/syntax/annotated-csv/#csv-response-format) with headers. + Default output is [annotated CSV](https://docs.influxdata.com/influxdb/latest/reference/syntax/annotated-csv/#csv-response-format) with headers. For more information about tabular data **dialect**, see [W3 metadata vocabulary for tabular data](https://www.w3.org/TR/2015/REC-tabular-metadata-20151217/#dialect-descriptions). @@ -9379,7 +9379,7 @@ components: #### Related guides - - See [Annotated CSV annotations](https://docs.influxdata.com/influxdb/v2.3/reference/syntax/annotated-csv/#annotations) for examples and more information. + - See [Annotated CSV annotations](https://docs.influxdata.com/influxdb/latest/reference/syntax/annotated-csv/#annotations) for examples and more information. For more information about **annotations** in tabular data, see [W3 metadata vocabulary for tabular data](https://www.w3.org/TR/2015/REC-tabular-data-model-20151217/#columns). @@ -9400,7 +9400,7 @@ components: dateTimeFormat: description: | The format for timestamps in results. - Default is [`RFC3339` date/time format](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#rfc3339-timestamp). + Default is [`RFC3339` date/time format](https://docs.influxdata.com/influxdb/latest/reference/glossary/#rfc3339-timestamp). To include nanoseconds in timestamps, use `RFC3339Nano`. #### Example formatted date/time values @@ -9434,7 +9434,7 @@ components: type: string description: | The organization ID. - Specifies the [organization](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#organization) that the authorization is scoped to. + Specifies the [organization](https://docs.influxdata.com/influxdb/latest/reference/glossary/#organization) that the authorization is scoped to. permissions: type: array minItems: 1 @@ -9453,20 +9453,20 @@ components: description: | The API token. The token value is unique to the authorization. - [API tokens](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#token) are + [API tokens](https://docs.influxdata.com/influxdb/latest/reference/glossary/#token) are used to authenticate and authorize InfluxDB API requests and `influx` CLI commands--after receiving the request, InfluxDB checks that the token is valid and that the `permissions` allow the requested action(s). userID: readOnly: true type: string - description: 'The user ID. Specifies the [user](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#user) that owns the authorization. If _scoped_, the user that the authorization is scoped to; otherwise, the creator of the authorization.' + description: 'The user ID. Specifies the [user](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user) that owns the authorization. If _scoped_, the user that the authorization is scoped to; otherwise, the creator of the authorization.' user: readOnly: true type: string description: | The user name. - Specifies the [user](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#user) that owns the authorization. + Specifies the [user](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user) that owns the authorization. If the authorization is _scoped_ to a user, the user; otherwise, the creator of the authorization. org: @@ -9474,7 +9474,7 @@ components: type: string description: | The organization name. - Specifies the [organization](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#organization) + Specifies the [organization](https://docs.influxdata.com/influxdb/latest/reference/glossary/#organization) that the token is scoped to. links: type: object @@ -9573,7 +9573,7 @@ components: [Retention policy](https://docs.influxdata.com/influxdb/v1.8/concepts/glossary/#retention-policy-rp) is an InfluxDB 1.x concept. The InfluxDB 2.x and Cloud equivalent is - [retention period](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#retention-period). + [retention period](https://docs.influxdata.com/influxdb/latest/reference/glossary/#retention-period). The InfluxDB `/api/v2` API uses `RetentionRules` to configure the retention period. type: string default: '0' @@ -9677,7 +9677,7 @@ components: type: array description: | Retention rules to expire or retain data. - The InfluxDB `/api/v2` API uses `RetentionRules` to configure the [retention period](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#retention-period). + The InfluxDB `/api/v2` API uses `RetentionRules` to configure the [retention period](https://docs.influxdata.com/influxdb/latest/reference/glossary/#retention-period). #### InfluxDB Cloud @@ -9730,7 +9730,7 @@ components: type: integer format: int64 description: | - The [shard group duration](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#shard). + The [shard group duration](https://docs.influxdata.com/influxdb/latest/reference/glossary/#shard). The number of seconds that each shard group covers. #### InfluxDB Cloud @@ -9739,11 +9739,11 @@ components: #### InfluxDB OSS - - Default value depends on the [bucket retention period](https://docs.influxdata.com/influxdb/v2.3/reference/internals/shards/#shard-group-duration). + - Default value depends on the [bucket retention period](https://docs.influxdata.com/influxdb/latest/reference/internals/shards/#shard-group-duration). #### Related guides - - InfluxDB [shards and shard groups](https://docs.influxdata.com/influxdb/v2.3/reference/internals/shards/) + - InfluxDB [shards and shard groups](https://docs.influxdata.com/influxdb/latest/reference/internals/shards/) required: - everySeconds RetentionRule: @@ -9778,7 +9778,7 @@ components: #### InfluxDB OSS - Default value depends on the - [bucket retention period](https://docs.influxdata.com/influxdb/v2.3/v2.3/reference/internals/shards/#shard-group-duration). + [bucket retention period](https://docs.influxdata.com/influxdb/latest/v2.3/reference/internals/shards/#shard-group-duration). required: - everySeconds Link: @@ -9812,7 +9812,7 @@ components: properties: time: readOnly: true - description: 'The time ([RFC3339Nano date/time format](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#rfc3339nano-timestamp)) that the event occurred.' + description: 'The time ([RFC3339Nano date/time format](https://docs.influxdata.com/influxdb/latest/reference/glossary/#rfc3339nano-timestamp)) that the event occurred.' type: string format: date-time example: '2006-01-02T15:04:05.999999999Z07:00' @@ -9933,7 +9933,7 @@ components: The organization owns all resources created by the template. To find your organization, see how to - [view organizations](https://docs.influxdata.com/influxdb/v2.3/organizations/view-orgs/). + [view organizations](https://docs.influxdata.com/influxdb/latest/organizations/view-orgs/). stackID: type: string description: | @@ -9947,8 +9947,8 @@ components: #### Related guides - - [Stacks](https://docs.influxdata.com/influxdb/v2.3/influxdb-templates/stacks/) - - [View stacks](https://docs.influxdata.com/influxdb/v2.3/influxdb-templates/stacks/view/) + - [Stacks](https://docs.influxdata.com/influxdb/latest/influxdb-templates/stacks/) + - [View stacks](https://docs.influxdata.com/influxdb/latest/influxdb-templates/stacks/view/) template: type: object description: | @@ -10000,7 +10000,7 @@ components: When you apply a template, InfluxDB replaces `envRef` objects in the template with the values that you provide in the `envRefs` parameter. - For more examples, see how to [define environment references](https://docs.influxdata.com/influxdb/v2.3/influxdb-templates/use/#define-environment-references). + For more examples, see how to [define environment references](https://docs.influxdata.com/influxdb/latest/influxdb-templates/use/#define-environment-references). The following template fields may use environment references: @@ -10009,7 +10009,7 @@ components: - `spec.associations.name` For more information about including environment references in template fields, see how to - [include user-definable resource names](https://docs.influxdata.com/influxdb/v2.3/influxdb-templates/create/#include-user-definable-resource-names). + [include user-definable resource names](https://docs.influxdata.com/influxdb/latest/influxdb-templates/create/#include-user-definable-resource-names). additionalProperties: oneOf: - type: string @@ -10058,7 +10058,7 @@ components: #### Related guides - - [How to pass secrets when installing a template](https://docs.influxdata.com/influxdb/v2.3/influxdb-templates/use/#pass-secrets-when-installing-a-template) + - [How to pass secrets when installing a template](https://docs.influxdata.com/influxdb/latest/influxdb-templates/use/#pass-secrets-when-installing-a-template) additionalProperties: type: string remotes: @@ -11030,7 +11030,7 @@ components: - success - canceled scheduledFor: - description: 'The time [RFC3339 date/time format](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#rfc3339-timestamp) used for the run''s `now` option.' + description: 'The time [RFC3339 date/time format](https://docs.influxdata.com/influxdb/latest/reference/glossary/#rfc3339-timestamp) used for the run''s `now` option.' type: string format: date-time log: @@ -11057,7 +11057,7 @@ components: example: '2006-01-02T15:04:05.999999999Z07:00' requestedAt: readOnly: true - description: 'The time ([RFC3339Nano date/time format](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#rfc3339nano-timestamp)) the run was manually requested.' + description: 'The time ([RFC3339Nano date/time format](https://docs.influxdata.com/influxdb/latest/reference/glossary/#rfc3339nano-timestamp)) the run was manually requested.' type: string format: date-time example: '2006-01-02T15:04:05.999999999Z07:00' @@ -11083,7 +11083,7 @@ components: scheduledFor: nullable: true description: | - The time [RFC3339 date/time format](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#rfc3339-timestamp) + The time [RFC3339 date/time format](https://docs.influxdata.com/influxdb/latest/reference/glossary/#rfc3339-timestamp) used for the run's `now` option. Default is the server _now_ time. type: string @@ -11096,17 +11096,17 @@ components: description: A description of the task. type: string TaskEvery: - description: 'The interval ([duration literal](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#rfc3339-timestamp)) at which the task runs. `every` also determines when the task first runs, depending on the specified time.' + description: 'The interval ([duration literal](https://docs.influxdata.com/influxdb/latest/reference/glossary/#rfc3339-timestamp)) at which the task runs. `every` also determines when the task first runs, depending on the specified time.' type: string format: duration TaskFlux: description: | - Flux with [task configuration options](https://docs.influxdata.com/influxdb/v2.3/process-data/task-options/) + Flux with [task configuration options](https://docs.influxdata.com/influxdb/latest/process-data/task-options/) and the script for the task to run. #### Related guides - - [Task configuration options](https://docs.influxdata.com/influxdb/v2.3/process-data/task-options/) + - [Task configuration options](https://docs.influxdata.com/influxdb/latest/process-data/task-options/) type: string format: Flux TaskName: @@ -11119,12 +11119,12 @@ components: TaskOrg: description: | An organization name. - Identifies the [organization](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#organization) that owns the task. + Identifies the [organization](https://docs.influxdata.com/influxdb/latest/reference/glossary/#organization) that owns the task. type: string TaskOrgID: description: | An organization ID. - Identifies the [organization](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#organization) that owns the task. + Identifies the [organization](https://docs.influxdata.com/influxdb/latest/reference/glossary/#organization) that owns the task. type: string TaskStatusType: type: string @@ -13511,7 +13511,7 @@ components: type: string latestCompleted: type: string - description: 'A timestamp ([RFC3339 date/time format](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#rfc3339-timestamp)) of the latest scheduled and completed run.' + description: 'A timestamp ([RFC3339 date/time format](https://docs.influxdata.com/influxdb/latest/reference/glossary/#rfc3339-timestamp)) of the latest scheduled and completed run.' format: date-time readOnly: true lastRunStatus: @@ -13781,7 +13781,7 @@ components: - endpointID properties: latestCompleted: - description: 'A timestamp ([RFC3339 date/time format](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#rfc3339-timestamp)) of the latest scheduled and completed run.' + description: 'A timestamp ([RFC3339 date/time format](https://docs.influxdata.com/influxdb/latest/reference/glossary/#rfc3339-timestamp)) of the latest scheduled and completed run.' type: string format: date-time readOnly: true diff --git a/contracts/oss.yml b/contracts/oss.yml index 42ac95b71..52f678c27 100644 --- a/contracts/oss.yml +++ b/contracts/oss.yml @@ -28,7 +28,7 @@ tags: - Tokens stop working when the user who created the token is deleted. API tokens are visible to the user who created the authorization and to any - user with an _[operator token](https://docs.influxdata.com/influxdb/v2.3/security/tokens/#operator-token)_. + user with an _[operator token](https://docs.influxdata.com/influxdb/latest/security/tokens/#operator-token)_. In InfluxDB OSS, even if an API token has `read-authorizations` permission, the token can't be used to view its authorization details. @@ -39,7 +39,7 @@ tags: Optionally, when creating an authorization, you can scope it to a specific user. If a user signs in with username and password, creating a _user session_, the session carries the permissions granted by all the user's authorizations. - For more information, see [how to assign a token to a specific user](https://docs.influxdata.com/influxdb/v2.3/security/tokens/create-token/). + For more information, see [how to assign a token to a specific user](https://docs.influxdata.com/influxdb/latest/security/tokens/create-token/). To create a user session, use the [`POST /api/v2/signin` endpoint](#operation/PostSignin). ### Related endpoints @@ -49,21 +49,21 @@ tags: ### Related guides - - [Authorize API requests](https://docs.influxdata.com/influxdb/v2.3/api-guide/api_intro/#authentication) - - [Manage API tokens](https://docs.influxdata.com/influxdb/v2.3/security/tokens/) - - [Assign a token to a specific user](https://docs.influxdata.com/influxdb/v2.3/security/tokens/create-token/) + - [Authorize API requests](https://docs.influxdata.com/influxdb/latest/api-guide/api_intro/#authentication) + - [Manage API tokens](https://docs.influxdata.com/influxdb/latest/security/tokens/) + - [Assign a token to a specific user](https://docs.influxdata.com/influxdb/latest/security/tokens/create-token/) - name: Buckets description: | - Store your data in InfluxDB [buckets](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#bucket). + Store your data in InfluxDB [buckets](https://docs.influxdata.com/influxdb/latest/reference/glossary/#bucket). A bucket is a named location where time series data is stored. All buckets - have a [retention period](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#retention-period), + have a [retention period](https://docs.influxdata.com/influxdb/latest/reference/glossary/#retention-period), a duration of time that each data point persists. InfluxDB drops all points with timestamps older than the bucket’s retention period. A bucket belongs to an organization. ### Related guides - - [Manage buckets](https://docs.influxdata.com/influxdb/v2.3/organizations/buckets/) + - [Manage buckets](https://docs.influxdata.com/influxdb/latest/organizations/buckets/) - name: Debug description: | Generate profiling and trace reports. @@ -84,7 +84,7 @@ tags: Delete data from an InfluxDB bucket. - name: Organizations description: | - Create and manage your [organizations](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#organization). + Create and manage your [organizations](https://docs.influxdata.com/influxdb/latest/reference/glossary/#organization). An organization is a workspace for a group of users. Organizations can be used to separate different environments, projects, teams or users within InfluxDB. @@ -95,7 +95,7 @@ tags: Retrieve data, analyze queries, and get query suggestions. - name: Tasks description: | - Process and analyze your data with [tasks](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task) + Process and analyze your data with [tasks](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task) in the InfluxDB task engine. Use the `/api/v2/tasks` endpoints to schedule and manage tasks, retry task runs, and retrieve run logs. @@ -114,8 +114,8 @@ tags: #### Related guides - - [Get started with tasks](https://docs.influxdata.com/influxdb/v2.3/process-data/get-started/) - - [Common data processing tasks](https://docs.influxdata.com/influxdb/v2.3/process-data/common-tasks/) + - [Get started with tasks](https://docs.influxdata.com/influxdb/latest/process-data/get-started/) + - [Common data processing tasks](https://docs.influxdata.com/influxdb/latest/process-data/common-tasks/) - name: Templates description: | Export and apply InfluxDB **templates**. @@ -138,8 +138,8 @@ tags: #### Related guides - - [InfluxDB stacks](https://docs.influxdata.com/influxdb/v2.3/influxdb-templates/stacks/) - - [InfluxDB templates](https://docs.influxdata.com/influxdb/v2.3/influxdb-templates/) + - [InfluxDB stacks](https://docs.influxdata.com/influxdb/latest/influxdb-templates/stacks/) + - [InfluxDB templates](https://docs.influxdata.com/influxdb/latest/influxdb-templates/) - name: Users description: | Manage users for your organization. @@ -156,11 +156,11 @@ tags: #### Related guides - - [Manage users](https://docs.influxdata.com/influxdb/v2.3/influxdb/latest/users/) - - [Create a token scoped to a user](https://docs.influxdata.com/influxdb/v2.3/latest/security/tokens/create-token/#create-a-token-scoped-to-a-user) + - [Manage users](https://docs.influxdata.com/influxdb/latest/influxdb/latest/users/) + - [Create a token scoped to a user](https://docs.influxdata.com/influxdb/latest/latest/security/tokens/create-token/#create-a-token-scoped-to-a-user) - name: Write description: | - Write time series data to [buckets](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#bucket). + Write time series data to [buckets](https://docs.influxdata.com/influxdb/latest/reference/glossary/#bucket). - name: Authentication description: | Use one of the following schemes to authenticate to the InfluxDB API: @@ -173,10 +173,10 @@ tags: - name: Quick start x-traitTag: true description: | - See the [**API Quick Start**](https://docs.influxdata.com/influxdb/v2.3/api-guide/api_intro/) + See the [**API Quick Start**](https://docs.influxdata.com/influxdb/latest/api-guide/api_intro/) to get up and running authenticating with tokens, writing to buckets, and querying data. - [**InfluxDB API client libraries**](https://docs.influxdata.com/influxdb/v2.3/api-guide/client-libraries/) + [**InfluxDB API client libraries**](https://docs.influxdata.com/influxdb/latest/api-guide/client-libraries/) are available for popular languages and ready to import into your application. - name: Supported operations x-traitTag: true @@ -206,10 +206,10 @@ tags: | Query parameter | Value type | Description | |:------------------------ |:--------------------- |:-------------------------------------------| - | `bucket` | string | The bucket name or ID ([find your bucket](https://docs.influxdata.com/influxdb/v2.3/organizations/buckets/view-buckets/). | - | `bucketID` | string | The bucket ID ([find your bucket](https://docs.influxdata.com/influxdb/v2.3/organizations/buckets/view-buckets/). | - | `org` | string | The organization name or ID ([find your organization](https://docs.influxdata.com/influxdb/v2.3/organizations/view-orgs/). | - | `orgID` | 16-byte string | The organization ID ([find your organization](https://docs.influxdata.com/influxdb/v2.3/organizations/view-orgs/). | + | `bucket` | string | The bucket name or ID ([find your bucket](https://docs.influxdata.com/influxdb/latest/organizations/buckets/view-buckets/). | + | `bucketID` | string | The bucket ID ([find your bucket](https://docs.influxdata.com/influxdb/latest/organizations/buckets/view-buckets/). | + | `org` | string | The organization name or ID ([find your organization](https://docs.influxdata.com/influxdb/latest/organizations/view-orgs/). | + | `orgID` | 16-byte string | The organization ID ([find your organization](https://docs.influxdata.com/influxdb/latest/organizations/view-orgs/). | - name: Pagination x-traitTag: true description: | @@ -293,7 +293,7 @@ paths: summary: Create a user session. description: | Authenticates [Basic authentication credentials](#section/Authentication/BasicAuthentication) - for a [user](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#user), + for a [user](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user), and then, if successful, generates a user session. To authenticate a user, pass the HTTP `Authorization` header with the @@ -399,7 +399,7 @@ paths: #### Related guides - - [Influx ping](https://docs.influxdata.com/influxdb/v2.3/reference/cli/influx/ping/) + - [Influx ping](https://docs.influxdata.com/influxdb/latest/reference/cli/influx/ping/) servers: - url: '' tags: @@ -444,7 +444,7 @@ paths: #### Related guides - - [Influx ping](https://docs.influxdata.com/influxdb/v2.3/reference/cli/influx/ping/) + - [Influx ping](https://docs.influxdata.com/influxdb/latest/reference/cli/influx/ping/) servers: - url: '' tags: @@ -1291,7 +1291,7 @@ paths: description: | Writes data to a bucket. - Use this endpoint to send data in [line protocol](https://docs.influxdata.com/influxdb/v2.3/reference/syntax/line-protocol/) format to InfluxDB. + Use this endpoint to send data in [line protocol](https://docs.influxdata.com/influxdb/latest/reference/syntax/line-protocol/) format to InfluxDB. #### InfluxDB Cloud @@ -1326,12 +1326,12 @@ paths: #### Related guides - - [Write data with the InfluxDB API](https://docs.influxdata.com/influxdb/v2.3/write-data/developer-tools/api) - - [Optimize writes to InfluxDB](https://docs.influxdata.com/influxdb/v2.3/write-data/best-practices/optimize-writes/) - - [Troubleshoot issues writing data](https://docs.influxdata.com/influxdb/v2.3/write-data/troubleshoot/) + - [Write data with the InfluxDB API](https://docs.influxdata.com/influxdb/latest/write-data/developer-tools/api) + - [Optimize writes to InfluxDB](https://docs.influxdata.com/influxdb/latest/write-data/best-practices/optimize-writes/) + - [Troubleshoot issues writing data](https://docs.influxdata.com/influxdb/latest/write-data/troubleshoot/) requestBody: description: | - In the request body, provide data in [line protocol format](https://docs.influxdata.com/influxdb/v2.3/reference/syntax/line-protocol/). + In the request body, provide data in [line protocol format](https://docs.influxdata.com/influxdb/latest/reference/syntax/line-protocol/). To send compressed data, do the following: @@ -1341,7 +1341,7 @@ paths: #### Related guides - - [Best practices for optimizing writes](https://docs.influxdata.com/influxdb/v2.3/write-data/best-practices/optimize-writes/) + - [Best practices for optimizing writes](https://docs.influxdata.com/influxdb/latest/write-data/best-practices/optimize-writes/) required: true content: text/plain: @@ -1409,7 +1409,7 @@ paths: #### Related guides - - [Troubleshoot issues writing data](https://docs.influxdata.com/influxdb/v2.3/write-data/troubleshoot/) + - [Troubleshoot issues writing data](https://docs.influxdata.com/influxdb/latest/write-data/troubleshoot/) schema: type: string description: Error content type. @@ -1484,7 +1484,7 @@ paths: #### Related guides - - [How to check for write errors](https://docs.influxdata.com/influxdb/v2.3/write-data/troubleshoot/) + - [How to check for write errors](https://docs.influxdata.com/influxdb/latest/write-data/troubleshoot/) '400': description: | Bad request. The response body contains detail about the error. @@ -1642,8 +1642,8 @@ paths: #### Related guides - - [Delete data](https://docs.influxdata.com/influxdb/v2.3/write-data/delete-data/) - - Learn how to use [delete predicate syntax](https://docs.influxdata.com/influxdb/v2.3/reference/syntax/delete-predicate/). + - [Delete data](https://docs.influxdata.com/influxdb/latest/write-data/delete-data/) + - Learn how to use [delete predicate syntax](https://docs.influxdata.com/influxdb/latest/reference/syntax/delete-predicate/). - Learn how InfluxDB handles [deleted tags](https://docs.influxdata.com/flux/v0.x/stdlib/influxdata/influxdb/schema/measurementtagkeys/) and [deleted fields](https://docs.influxdata.com/flux/v0.x/stdlib/influxdata/influxdb/schema/measurementfieldkeys/). x-codeSamples: @@ -1669,8 +1669,8 @@ paths: #### Related guides - - [Delete data](https://docs.influxdata.com/influxdb/v2.3/write-data/delete-data/) - - Learn how to use [delete predicate syntax](https://docs.influxdata.com/influxdb/v2.3/reference/syntax/delete-predicate/). + - [Delete data](https://docs.influxdata.com/influxdb/latest/write-data/delete-data/) + - Learn how to use [delete predicate syntax](https://docs.influxdata.com/influxdb/latest/reference/syntax/delete-predicate/). required: true content: application/json: @@ -2563,7 +2563,7 @@ paths: summary: Generate a query Abstract Syntax Tree (AST) description: | Analyzes a Flux query and returns a complete package source [Abstract Syntax - Tree (AST)](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#abstract-syntax-tree-ast) + Tree (AST)](https://docs.influxdata.com/influxdb/latest/reference/glossary/#abstract-syntax-tree-ast) for the query. Use this endpoint for deep query analysis such as debugging unexpected query @@ -3896,7 +3896,7 @@ paths: #### Related guides - - [Query with the InfluxDB API](https://docs.influxdata.com/influxdb/v2.3/query-data/execute-queries/influx-api/) + - [Query with the InfluxDB API](https://docs.influxdata.com/influxdb/latest/query-data/execute-queries/influx-api/) - [Get started with Flux](https://docs.influxdata.com/flux/v0.x/get-started/) parameters: - $ref: '#/components/parameters/TraceSpan' @@ -4027,9 +4027,9 @@ paths: description: | #### InfluxDB Cloud: - returns this error if a **read** or **write** request exceeds your - plan's [adjustable service quotas](https://docs.influxdata.com/influxdb/v2.3/account-management/limits/#adjustable-service-quotas) + plan's [adjustable service quotas](https://docs.influxdata.com/influxdb/latest/account-management/limits/#adjustable-service-quotas) or if a **delete** request exceeds the maximum - [global limit](https://docs.influxdata.com/influxdb/v2.3/account-management/limits/#global-limits) + [global limit](https://docs.influxdata.com/influxdb/latest/account-management/limits/#global-limits) - returns `Retry-After` header that describes when to try the write again. #### InfluxDB OSS: @@ -4051,19 +4051,19 @@ paths: - Buckets summary: List buckets description: | - Lists [buckets](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#bucket). + Lists [buckets](https://docs.influxdata.com/influxdb/latest/reference/glossary/#bucket). InfluxDB retrieves buckets owned by the - [organization](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#organization) + [organization](https://docs.influxdata.com/influxdb/latest/reference/glossary/#organization) associated with the authorization - ([API token](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#token)). + ([API token](https://docs.influxdata.com/influxdb/latest/reference/glossary/#token)). To limit which buckets are returned, pass query parameters in your request. If no query parameters are passed, InfluxDB returns all buckets up to the default `limit`. #### InfluxDB OSS - - If you use an _[operator token](https://docs.influxdata.com/influxdb/v2.3/security/tokens/#operator-token)_ + - If you use an _[operator token](https://docs.influxdata.com/influxdb/latest/security/tokens/#operator-token)_ to authenticate your request, InfluxDB retrieves resources for _all organizations_ in the instance. To retrieve resources for only a specific organization, use the @@ -4074,11 +4074,11 @@ paths: | Action | Permission required | |:--------------------------|:--------------------| | Retrieve _user buckets_ | `read-buckets` | - | Retrieve [_system buckets_](https://docs.influxdata.com/influxdb/v2.3/reference/internals/system-buckets/) | `read-orgs` | + | Retrieve [_system buckets_](https://docs.influxdata.com/influxdb/latest/reference/internals/system-buckets/) | `read-orgs` | #### Related Guides - - [Manage buckets](https://docs.influxdata.com/influxdb/v2.3/organizations/buckets/) + - [Manage buckets](https://docs.influxdata.com/influxdb/latest/organizations/buckets/) parameters: - $ref: '#/components/parameters/TraceSpan' - $ref: '#/components/parameters/Offset' @@ -4187,10 +4187,10 @@ paths: - Buckets summary: Create a bucket description: | - Creates a [bucket](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#bucket) + Creates a [bucket](https://docs.influxdata.com/influxdb/latest/reference/glossary/#bucket) and returns the bucket resource. The default data - [retention period](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#retention-period) + [retention period](https://docs.influxdata.com/influxdb/latest/reference/glossary/#retention-period) is 30 days. #### InfluxDB OSS @@ -4209,8 +4209,8 @@ paths: #### Related Guides - - [Create a bucket](https://docs.influxdata.com/influxdb/v2.3/organizations/buckets/create-bucket/) - - [Create bucket CLI reference](https://docs.influxdata.com/influxdb/v2.3/reference/cli/influx/bucket/create) + - [Create a bucket](https://docs.influxdata.com/influxdb/latest/organizations/buckets/create-bucket/) + - [Create bucket CLI reference](https://docs.influxdata.com/influxdb/latest/reference/cli/influx/bucket/create) parameters: - $ref: '#/components/parameters/TraceSpan' requestBody: @@ -4416,7 +4416,7 @@ paths: #### Related Guides - - [Update a bucket](https://docs.influxdata.com/influxdb/v2.3/organizations/buckets/update-bucket/) + - [Update a bucket](https://docs.influxdata.com/influxdb/latest/organizations/buckets/update-bucket/) requestBody: description: The bucket update to apply. required: true @@ -4562,7 +4562,7 @@ paths: #### Related Guides - - [Delete a bucket](https://docs.influxdata.com/influxdb/v2.3/organizations/buckets/delete-bucket/#delete-a-bucket-in-the-influxdb-ui) + - [Delete a bucket](https://docs.influxdata.com/influxdb/latest/organizations/buckets/delete-bucket/#delete-a-bucket-in-the-influxdb-ui) parameters: - $ref: '#/components/parameters/TraceSpan' - in: path @@ -4648,7 +4648,7 @@ paths: #### Related guides - Use the [`/api/v2/labels` InfluxDB API endpoint](#tag/Labels) to retrieve and manage labels. - - [Manage labels in the InfluxDB UI](https://docs.influxdata.com/influxdb/v2.3/visualize-data/labels/) + - [Manage labels in the InfluxDB UI](https://docs.influxdata.com/influxdb/latest/visualize-data/labels/) parameters: - $ref: '#/components/parameters/TraceSpan' - in: path @@ -4712,7 +4712,7 @@ paths: #### Related guides - Use the [`/api/v2/labels` InfluxDB API endpoint](#tag/Labels) to retrieve and manage labels. - - [Manage labels in the InfluxDB UI](https://docs.influxdata.com/influxdb/v2.3/visualize-data/labels/) + - [Manage labels in the InfluxDB UI](https://docs.influxdata.com/influxdb/latest/visualize-data/labels/) parameters: - $ref: '#/components/parameters/TraceSpan' - in: path @@ -4838,18 +4838,18 @@ paths: description: | Lists all users for a bucket. - InfluxDB [users](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#user) have + InfluxDB [users](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user) have permission to access InfluxDB. - [Members](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#member) are users in + [Members](https://docs.influxdata.com/influxdb/latest/reference/glossary/#member) are users in an organization with access to the specified resource. Use this endpoint to retrieve all users with access to a bucket. #### Related guides - - [Manage users](https://docs.influxdata.com/influxdb/v2.3/users/) - - [Manage members](https://docs.influxdata.com/influxdb/v2.3/organizations/members/) + - [Manage users](https://docs.influxdata.com/influxdb/latest/users/) + - [Manage members](https://docs.influxdata.com/influxdb/latest/organizations/members/) parameters: - $ref: '#/components/parameters/TraceSpan' - in: path @@ -4908,18 +4908,18 @@ paths: description: | Add a user to a bucket and return the new user information. - InfluxDB [users](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#user) have + InfluxDB [users](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user) have permission to access InfluxDB. - [Members](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#member) are users in + [Members](https://docs.influxdata.com/influxdb/latest/reference/glossary/#member) are users in an organization. Use this endpoint to give a user member privileges to a bucket. #### Related guides - - [Manage users](https://docs.influxdata.com/influxdb/v2.3/users/) - - [Manage members](https://docs.influxdata.com/influxdb/v2.3/organizations/members/) + - [Manage users](https://docs.influxdata.com/influxdb/latest/users/) + - [Manage members](https://docs.influxdata.com/influxdb/latest/organizations/members/) parameters: - $ref: '#/components/parameters/TraceSpan' - in: path @@ -4999,8 +4999,8 @@ paths: #### Related guides - - [Manage users](https://docs.influxdata.com/influxdb/v2.3/users/) - - [Manage members](https://docs.influxdata.com/influxdb/v2.3/organizations/members/) + - [Manage users](https://docs.influxdata.com/influxdb/latest/users/) + - [Manage members](https://docs.influxdata.com/influxdb/latest/organizations/members/) parameters: - $ref: '#/components/parameters/TraceSpan' - in: path @@ -5041,7 +5041,7 @@ paths: - Buckets summary: List all owners of a bucket description: | - Lists all [owners](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#owner) + Lists all [owners](https://docs.influxdata.com/influxdb/latest/reference/glossary/#owner) of a bucket. Bucket owners have permission to delete buckets and remove user and member @@ -5070,7 +5070,7 @@ paths: #### Related guides - - [Manage users](https://docs.influxdata.com/influxdb/v2.3/users/) + - [Manage users](https://docs.influxdata.com/influxdb/latest/users/) parameters: - $ref: '#/components/parameters/TraceSpan' - in: path @@ -5121,7 +5121,7 @@ paths: - Buckets summary: Add an owner to a bucket description: | - Adds an owner to a bucket and returns the [owners](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#owner) + Adds an owner to a bucket and returns the [owners](https://docs.influxdata.com/influxdb/latest/reference/glossary/#owner) with role and user detail. Use this endpoint to create a _resource owner_ for the bucket. @@ -5150,7 +5150,7 @@ paths: #### Related guides - - [Manage users](https://docs.influxdata.com/influxdb/v2.3/users/) + - [Manage users](https://docs.influxdata.com/influxdb/latest/users/) parameters: - $ref: '#/components/parameters/TraceSpan' - in: path @@ -5252,7 +5252,7 @@ paths: #### Related guides - - [Manage users](https://docs.influxdata.com/influxdb/v2.3/users/) + - [Manage users](https://docs.influxdata.com/influxdb/latest/users/) parameters: - $ref: '#/components/parameters/TraceSpan' - in: path @@ -5294,7 +5294,7 @@ paths: - Security and access endpoints summary: List organizations description: | - Lists [organizations](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#organization/). + Lists [organizations](https://docs.influxdata.com/influxdb/latest/reference/glossary/#organization/). To limit which organizations are returned, pass query parameters in your request. If no query parameters are passed, InfluxDB returns all organizations up to the default `limit`. @@ -5305,7 +5305,7 @@ paths: #### Related guides - - [View organizations](https://docs.influxdata.com/influxdb/v2.3/organizations/view-orgs/) + - [View organizations](https://docs.influxdata.com/influxdb/latest/organizations/view-orgs/) parameters: - $ref: '#/components/parameters/TraceSpan' - $ref: '#/components/parameters/Offset' @@ -5376,7 +5376,7 @@ paths: - Organizations summary: Create an organization description: | - Creates an [organization](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#organization) + Creates an [organization](https://docs.influxdata.com/influxdb/latest/reference/glossary/#organization) and returns the newly created organization. #### InfluxDB Cloud @@ -5385,7 +5385,7 @@ paths: #### Related guides - - [Manage organizations](https://docs.influxdata.com/influxdb/v2.3/organizations) + - [Manage organizations](https://docs.influxdata.com/influxdb/latest/organizations) parameters: - $ref: '#/components/parameters/TraceSpan' requestBody: @@ -5466,7 +5466,7 @@ paths: #### Related guides - - [View organizations](https://docs.influxdata.com/influxdb/v2.3/organizations/view-orgs/) + - [View organizations](https://docs.influxdata.com/influxdb/latest/organizations/view-orgs/) parameters: - $ref: '#/components/parameters/TraceSpan' - in: path @@ -5535,7 +5535,7 @@ paths: #### Related Guides - - [Update an organization](https://docs.influxdata.com/influxdb/v2.3/organizations/update-org/) + - [Update an organization](https://docs.influxdata.com/influxdb/latest/organizations/update-org/) requestBody: description: The organization update to apply. required: true @@ -5603,7 +5603,7 @@ paths: #### Related guides - - [Delete organizations](https://docs.influxdata.com/influxdb/v2.3/organizations/delete-orgs/) + - [Delete organizations](https://docs.influxdata.com/influxdb/latest/organizations/delete-orgs/) parameters: - $ref: '#/components/parameters/TraceSpan' - in: path @@ -5717,10 +5717,10 @@ paths: description: | Lists all users that belong to an organization. - InfluxDB [users](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#user) have + InfluxDB [users](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user) have permission to access InfluxDB. - [Members](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#member) are users + [Members](https://docs.influxdata.com/influxdb/latest/reference/glossary/#member) are users within the organization. #### InfluxDB Cloud @@ -5742,8 +5742,8 @@ paths: #### Related guides - - [Manage users](https://docs.influxdata.com/influxdb/v2.3/users/) - - [Manage members](https://docs.influxdata.com/influxdb/v2.3/organizations/members/) + - [Manage users](https://docs.influxdata.com/influxdb/latest/users/) + - [Manage members](https://docs.influxdata.com/influxdb/latest/organizations/members/) parameters: - $ref: '#/components/parameters/TraceSpan' - in: path @@ -5815,10 +5815,10 @@ paths: description: | Add a user to an organization. - InfluxDB [users](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#user) have + InfluxDB [users](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user) have permission to access InfluxDB. - [Members](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#member) are users + [Members](https://docs.influxdata.com/influxdb/latest/reference/glossary/#member) are users within the organization. #### InfluxDB Cloud @@ -5838,8 +5838,8 @@ paths: #### Related guides - - [Manage users](https://docs.influxdata.com/influxdb/v2.3/users/) - - [Manage members](https://docs.influxdata.com/influxdb/v2.3/organizations/members/) + - [Manage users](https://docs.influxdata.com/influxdb/latest/users/) + - [Manage members](https://docs.influxdata.com/influxdb/latest/organizations/members/) parameters: - $ref: '#/components/parameters/TraceSpan' - in: path @@ -5939,7 +5939,7 @@ paths: #### Related guides - - [Manage members](https://docs.influxdata.com/influxdb/v2.3/organizations/members/) + - [Manage members](https://docs.influxdata.com/influxdb/latest/organizations/members/) parameters: - $ref: '#/components/parameters/TraceSpan' - in: path @@ -6122,7 +6122,7 @@ paths: - Security and access endpoints summary: Remove an owner from an organization description: | - Removes an [owner](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#owner) from + Removes an [owner](https://docs.influxdata.com/influxdb/latest/reference/glossary/#owner) from the organization. Organization owners have permission to delete organizations and remove user and member @@ -6276,7 +6276,7 @@ paths: #### Related guides - - [View InfluxDB stacks](https://docs.influxdata.com/influxdb/v2.3/influxdb-templates/stacks/). + - [View InfluxDB stacks](https://docs.influxdata.com/influxdb/latest/influxdb-templates/stacks/). parameters: - in: query name: orgID @@ -6285,7 +6285,7 @@ paths: type: string description: | An organization ID. - Only returns stacks owned by the specified [organization](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#organization). + Only returns stacks owned by the specified [organization](https://docs.influxdata.com/influxdb/latest/reference/glossary/#organization). #### InfluxDB Cloud @@ -6394,8 +6394,8 @@ paths: #### Related guides - - [Initialize an InfluxDB stack](https://docs.influxdata.com/influxdb/v2.3/influxdb-templates/stacks/init/). - - [Use InfluxDB templates](https://docs.influxdata.com/influxdb/v2.3/influxdb-templates/use/#apply-templates-to-an-influxdb-instance). + - [Initialize an InfluxDB stack](https://docs.influxdata.com/influxdb/latest/influxdb-templates/stacks/init/). + - [Use InfluxDB templates](https://docs.influxdata.com/influxdb/latest/influxdb-templates/use/#apply-templates-to-an-influxdb-instance). requestBody: description: The stack to create. required: true @@ -6590,8 +6590,8 @@ paths: summary: Apply or dry-run a template description: | Applies a template to - create or update a [stack](https://docs.influxdata.com/influxdb/v2.3/influxdb-templates/stacks/) of InfluxDB - [resources](https://docs.influxdata.com/influxdb/v2.3/reference/cli/influx/export/all/#resources). + create or update a [stack](https://docs.influxdata.com/influxdb/latest/influxdb-templates/stacks/) of InfluxDB + [resources](https://docs.influxdata.com/influxdb/latest/reference/cli/influx/export/all/#resources). The response contains the diff of changes and the stack ID. Use this endpoint to install an InfluxDB template to an organization. @@ -6607,18 +6607,18 @@ paths: #### Custom values for templates - - Some templates may contain [environment references](https://docs.influxdata.com/influxdb/v2.3/influxdb-templates/create/#include-user-definable-resource-names) for custom metadata. + - Some templates may contain [environment references](https://docs.influxdata.com/influxdb/latest/influxdb-templates/create/#include-user-definable-resource-names) for custom metadata. To provide custom values for environment references, pass the _`envRefs`_ property in the request body. For more information and examples, see how to - [define environment references](https://docs.influxdata.com/influxdb/v2.3/influxdb-templates/use/#define-environment-references). + [define environment references](https://docs.influxdata.com/influxdb/latest/influxdb-templates/use/#define-environment-references). - Some templates may contain queries that use - [secrets](https://docs.influxdata.com/influxdb/v2.3/security/secrets/). + [secrets](https://docs.influxdata.com/influxdb/latest/security/secrets/). To provide custom secret values, pass the _`secrets`_ property in the request body. Don't expose secret values in templates. - For more information, see [how to pass secrets when installing a template](https://docs.influxdata.com/influxdb/v2.3/influxdb-templates/use/#pass-secrets-when-installing-a-template). + For more information, see [how to pass secrets when installing a template](https://docs.influxdata.com/influxdb/latest/influxdb-templates/use/#pass-secrets-when-installing-a-template). #### Required permissions @@ -6631,8 +6631,8 @@ paths: #### Related guides - - [Use templates](https://docs.influxdata.com/influxdb/v2.3/influxdb-templates/use/) - - [Stacks](https://docs.influxdata.com/influxdb/v2.3/influxdb-templates/stacks/) + - [Use templates](https://docs.influxdata.com/influxdb/latest/influxdb-templates/use/) + - [Stacks](https://docs.influxdata.com/influxdb/latest/influxdb-templates/stacks/) requestBody: required: true description: | @@ -6918,7 +6918,7 @@ paths: - Tasks summary: List runs for a task description: | - Lists runs for the specified [task](https://docs.influxdata.com/influxdb/v2.3/process-data/). + Lists runs for the specified [task](https://docs.influxdata.com/influxdb/latest/process-data/). To limit which task runs are returned, pass query parameters in your request. If you don't pass query parameters, InfluxDB returns all runs for the task @@ -6932,7 +6932,7 @@ paths: required: true description: | A task ID. - Specifies the [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task) to + Specifies the [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task) to to list runs for. - in: query name: after @@ -6954,7 +6954,7 @@ paths: type: string format: date-time description: | - A timestamp ([RFC3339 date/time format](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#rfc3339-timestamp)). + A timestamp ([RFC3339 date/time format](https://docs.influxdata.com/influxdb/latest/reference/glossary/#rfc3339-timestamp)). Only returns runs scheduled after the specified time. - in: query name: beforeTime @@ -6962,7 +6962,7 @@ paths: type: string format: date-time description: | - A timestamp ([RFC3339 date/time format](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#rfc3339-timestamp)). + A timestamp ([RFC3339 date/time format](https://docs.influxdata.com/influxdb/latest/reference/glossary/#rfc3339-timestamp)). Only returns runs scheduled before the specified time. responses: '200': @@ -7005,7 +7005,7 @@ paths: required: true description: | A task ID. - Specifies the [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task) to + Specifies the [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task) to to run. requestBody: content: @@ -7044,7 +7044,7 @@ paths: - Tasks summary: Retrieve a run for a task. description: | - Retrieves the specified run for the specified [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task). + Retrieves the specified run for the specified [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task). Use this endpoint to retrieve detail and logs for a specific task run. parameters: @@ -7056,7 +7056,7 @@ paths: required: true description: | A task ID. - Specifies the [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task) + Specifies the [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task) that the task run belongs to. - in: path name: runID @@ -7110,7 +7110,7 @@ paths: - Tasks summary: Cancel a running task description: | - Cancels a running [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task). + Cancels a running [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task). Use this endpoint to cancel a running task. @@ -7126,7 +7126,7 @@ paths: required: true description: | A task ID. - Specifies the [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task) to + Specifies the [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task) to to cancel. - in: path name: runID @@ -7177,7 +7177,7 @@ paths: - Tasks summary: Retry a task run description: | - Queues a [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task) run to + Queues a [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task) run to retry and then returns the scheduled run. To manually start a _new_ task run, use the @@ -7200,7 +7200,7 @@ paths: required: true description: | A task ID. - Specifies the [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task) that the task run belongs to. + Specifies the [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task) that the task run belongs to. - in: path name: runID schema: @@ -7267,7 +7267,7 @@ paths: - Tasks summary: List logs for a task description: | - Lists all log events for a [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task). + Lists all log events for a [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task). When a task runs, InfluxDB creates a `run` record in the task’s history. Logs associated with each run provide relevant log messages, timestamps, and the exit status of the `run` attempt. @@ -7281,7 +7281,7 @@ paths: schema: type: string required: true - description: 'A task ID. Specifies the [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task) to retrieve logs for.' + description: 'A task ID. Specifies the [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task) to retrieve logs for.' responses: '200': description: | @@ -7337,7 +7337,7 @@ paths: Lists all logs for a task run. A log is a list of run events with `runID`, `time`, and `message` properties. - Use this endpoint to help analyze [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task) performance and troubleshoot failed task runs. + Use this endpoint to help analyze [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task) performance and troubleshoot failed task runs. parameters: - $ref: '#/components/parameters/TraceSpan' - in: path @@ -7345,7 +7345,7 @@ paths: schema: type: string required: true - description: 'A task ID. Specifies the [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task) that the run belongs to.' + description: 'A task ID. Specifies the [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task) that the run belongs to.' - in: path name: runID schema: @@ -7442,7 +7442,7 @@ paths: - Tasks summary: Add a label to a task description: | - Adds a label to a [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task). + Adds a label to a [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task). Use this endpoint to add a label to a task. Labels are a way to add metadata to InfluxDB resources. @@ -7457,7 +7457,7 @@ paths: required: true description: | A task ID. - Specifies the [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task) to label. + Specifies the [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task) to label. requestBody: description: | In the request body, provide an object that specifies the label. @@ -7490,7 +7490,7 @@ paths: - Tasks summary: Delete a label from a task description: | - Deletes a label from a [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task). + Deletes a label from a [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task). parameters: - $ref: '#/components/parameters/TraceSpan' - in: path @@ -7500,7 +7500,7 @@ paths: required: true description: | A task ID. - Specifies the [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task) to delete the label from. + Specifies the [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task) to delete the label from. - in: path name: labelID schema: @@ -7539,7 +7539,7 @@ paths: 1. Use [token authentication](#section/Authentication/TokenAuthentication) or a [user session](#tag/Signin) with this endpoint to retrieve feature flags and their values. - 2. Follow the instructions to [enable, disable, or override values for feature flags](https://docs.influxdata.com/influxdb/v2.3/influxdb/v2.4/reference/config-options/#feature-flags). + 2. Follow the instructions to [enable, disable, or override values for feature flags](https://docs.influxdata.com/influxdb/latest/influxdb/v2.4/reference/config-options/#feature-flags). 3. **Optional**: To confirm that your change is applied, do one of the following: - Send a request to this endpoint to retrieve the current feature flag values. @@ -7548,7 +7548,7 @@ paths: #### Related guides - - [InfluxDB configuration options](https://docs.influxdata.com/influxdb/v2.3/influxdb/v2.4/reference/config-options/) + - [InfluxDB configuration options](https://docs.influxdata.com/influxdb/latest/influxdb/v2.4/reference/config-options/) parameters: - $ref: '#/components/parameters/TraceSpan' responses: @@ -7596,7 +7596,7 @@ paths: - Users summary: Update a password description: | - Updates the password for the signed-in [user](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#user). + Updates the password for the signed-in [user](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user). This endpoint represents the third step in the following three-step process to let a user with a user session update their password: @@ -7634,7 +7634,7 @@ paths: required: true description: | The user session cookie for the - [user](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#user) + [user](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user) signed in with [Basic authentication credentials](#section/Authentication/BasicAuthentication). #### Related guides @@ -7681,7 +7681,7 @@ paths: **Deprecated**: Tasks don't use `owner` and `member` roles. Use [`/api/v2/authorizations`](#tag/Authorizations) to assign user permissions. - Lists all users that have the `member` role for the specified [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task). + Lists all users that have the `member` role for the specified [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task). parameters: - $ref: '#/components/parameters/TraceSpan' - in: path @@ -7691,7 +7691,7 @@ paths: required: true description: | A task ID. - Specifies the [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task) to retrieve members for. + Specifies the [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task) to retrieve members for. responses: '200': description: | @@ -7719,7 +7719,7 @@ paths: **Deprecated**: Tasks don't use `owner` and `member` roles. Use [`/api/v2/authorizations`](#tag/Authorizations) to assign user permissions. - Adds a specified user to members of the specified [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task) and then returns + Adds a specified user to members of the specified [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task) and then returns the member. parameters: - $ref: '#/components/parameters/TraceSpan' @@ -7729,7 +7729,7 @@ paths: type: string required: true description: | - A [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task) ID. + A [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task) ID. Specifies the task for the member. requestBody: description: | @@ -7766,7 +7766,7 @@ paths: **Deprecated**: Tasks don't use `owner` and `member` roles. Use [`/api/v2/authorizations`](#tag/Authorizations) to assign user permissions. - Removes a member from a [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task). + Removes a member from a [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task). parameters: - $ref: '#/components/parameters/TraceSpan' - in: path @@ -7780,7 +7780,7 @@ paths: schema: type: string required: true - description: 'A task ID. Specifies the [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task) to remove the member from.' + description: 'A task ID. Specifies the [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task) to remove the member from.' responses: '204': description: Success. The member is removed. @@ -7867,7 +7867,7 @@ paths: required: true description: | A task ID. - Specifies the [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task) for the owner. + Specifies the [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task) for the owner. requestBody: description: | In the request body, provide an object that specifies the user. @@ -7930,7 +7930,7 @@ paths: **Deprecated**: Tasks don't use `owner` and `member` roles. Use [`/api/v2/authorizations`](#tag/Authorizations) to assign user permissions. - Removes an owner from a [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task). + Removes an owner from a [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task). parameters: - $ref: '#/components/parameters/TraceSpan' - in: path @@ -7938,7 +7938,7 @@ paths: schema: type: string required: true - description: 'A user ID. Specifies the owner to remove from the [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task).' + description: 'A user ID. Specifies the owner to remove from the [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task).' - in: path name: taskID schema: @@ -7946,7 +7946,7 @@ paths: required: true description: | A task ID. - Specifies the [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task) to remove the owner from. + Specifies the [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task) to remove the owner from. responses: '204': description: Success. The owner is removed. @@ -9057,7 +9057,7 @@ paths: - **allocs**: All past memory allocations - **block**: Stack traces that led to blocking on synchronization primitives - **cpu**: (Optional) Program counters sampled from the executing stack. - Include by passing the `cpu` query parameter with a [duration](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#duration) value. + Include by passing the `cpu` query parameter with a [duration](https://docs.influxdata.com/influxdb/latest/reference/glossary/#duration) value. Equivalent to the report from [`GET /debug/pprof/profile?seconds=NUMBER_OF_SECONDS`](#operation/GetDebugPprofProfile). - **goroutine**: All current goroutines - **heap**: Memory allocations for live objects @@ -9106,7 +9106,7 @@ paths: - in: query name: cpu description: | - Collects and returns CPU profiling data for the specified [duration](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#duration). + Collects and returns CPU profiling data for the specified [duration](https://docs.influxdata.com/influxdb/latest/reference/glossary/#duration). schema: type: string format: duration @@ -9824,9 +9824,9 @@ paths: #### Related guides - - For the list of metrics categories, see [InfluxDB OSS metrics](https://docs.influxdata.com/influxdb/v2.3/reference/internals/metrics/). - - Learn how to use InfluxDB to [scrape Prometheus metrics](https://docs.influxdata.com/influxdb/v2.3/write-data/developer-tools/scrape-prometheus-metrics/). - - Learn how InfluxDB [parses the Prometheus exposition format](https://docs.influxdata.com/influxdb/v2.3/reference/prometheus-metrics/). + - For the list of metrics categories, see [InfluxDB OSS metrics](https://docs.influxdata.com/influxdb/latest/reference/internals/metrics/). + - Learn how to use InfluxDB to [scrape Prometheus metrics](https://docs.influxdata.com/influxdb/latest/write-data/developer-tools/scrape-prometheus-metrics/). + - Learn how InfluxDB [parses the Prometheus exposition format](https://docs.influxdata.com/influxdb/latest/reference/prometheus-metrics/). servers: - url: '' parameters: @@ -9894,7 +9894,7 @@ paths: - Users summary: List users description: | - Lists [users](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#user). + Lists [users](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user). Default limit is `20`. To limit which users are returned, pass query parameters in your request. @@ -9922,14 +9922,14 @@ paths: type: string description: | A user name. - Only lists the specified [user](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#user). + Only lists the specified [user](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user). - in: query name: id schema: type: string description: | A user ID. - Only lists the specified [user](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#user). + Only lists the specified [user](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user). responses: '200': description: Success. The response contains a list of `users`. @@ -9974,7 +9974,7 @@ paths: - Users summary: Create a user description: | - Creates a [user](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#user) that can access InfluxDB. + Creates a [user](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user) that can access InfluxDB. Returns the user. Use this endpoint to create a user that can sign in to start a user session @@ -10090,11 +10090,11 @@ paths: - Users summary: Retrieve a user description: | - Retrieves a [user](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#user). + Retrieves a [user](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user). #### Related guides - - [Manage users](https://docs.influxdata.com/influxdb/v2.3/organizations/users/) + - [Manage users](https://docs.influxdata.com/influxdb/latest/organizations/users/) parameters: - $ref: '#/components/parameters/TraceSpan' - in: path @@ -10104,7 +10104,7 @@ paths: required: true description: | A user ID. - Retrieves the specified [user](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#user). + Retrieves the specified [user](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user). responses: '200': description: Success. The response body contains the user. @@ -10121,7 +10121,7 @@ paths: - Users summary: Update a user description: | - Updates a [user](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#user) and returns the user. + Updates a [user](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user) and returns the user. #### Required permissions @@ -10133,7 +10133,7 @@ paths: #### Related guides - - [Manage users](https://docs.influxdata.com/influxdb/v2.3/organizations/users/) + - [Manage users](https://docs.influxdata.com/influxdb/latest/organizations/users/) requestBody: description: 'In the request body, provide the user properties to update.' required: true @@ -10150,7 +10150,7 @@ paths: required: true description: | A user ID. - Specifies the [user](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#user) to update. + Specifies the [user](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user) to update. responses: '200': description: | @@ -10176,7 +10176,7 @@ paths: - Users summary: Delete a user description: | - Deletes a [user](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#user). + Deletes a [user](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user). #### Required permissions @@ -10188,7 +10188,7 @@ paths: #### Related guides - - [Manage users](https://docs.influxdata.com/influxdb/v2.3/organizations/users/) + - [Manage users](https://docs.influxdata.com/influxdb/latest/organizations/users/) parameters: - $ref: '#/components/parameters/TraceSpan' - in: path @@ -10198,7 +10198,7 @@ paths: required: true description: | A user ID. - Specifies the [user](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#user) to delete. + Specifies the [user](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user) to delete. responses: '204': description: Success. The user is deleted. @@ -10274,7 +10274,7 @@ paths: #### InfluxDB OSS - InfluxDB OSS returns - [API token](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#token) values in authorizations. + [API token](https://docs.influxdata.com/influxdb/latest/reference/glossary/#token) values in authorizations. - If the request uses an _[operator token](https://docs.influxdata.com/influxdb/latest/security/tokens/#operator-token)_, InfluxDB OSS returns authorizations for all organizations in the instance. @@ -10284,7 +10284,7 @@ paths: #### Related guides - - [View tokens](https://docs.influxdata.com/influxdb/v2.3/security/tokens/view-tokens/) + - [View tokens](https://docs.influxdata.com/influxdb/latest/security/tokens/view-tokens/) parameters: - $ref: '#/components/parameters/TraceSpan' - in: query @@ -10293,26 +10293,26 @@ paths: type: string description: | A user ID. - Only returns authorizations scoped to the specified [user](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#user). + Only returns authorizations scoped to the specified [user](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user). - in: query name: user schema: type: string description: | A user name. - Only returns authorizations scoped to the specified [user](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#user). + Only returns authorizations scoped to the specified [user](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user). - in: query name: orgID schema: type: string - description: 'An organization ID. Only returns authorizations that belong to the specified [organization](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#organization).' + description: 'An organization ID. Only returns authorizations that belong to the specified [organization](https://docs.influxdata.com/influxdb/latest/reference/glossary/#organization).' - in: query name: org schema: type: string description: | An organization name. - Only returns authorizations that belong to the specified [organization](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#organization). + Only returns authorizations that belong to the specified [organization](https://docs.influxdata.com/influxdb/latest/reference/glossary/#organization). responses: '200': description: Success. The response body contains a list of authorizations. @@ -10337,7 +10337,7 @@ paths: summary: Create an authorization description: | Creates an authorization and returns the authorization with the - generated API [token](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#token). + generated API [token](https://docs.influxdata.com/influxdb/latest/reference/glossary/#token). Use this endpoint to create an authorization, which generates an API token with permissions to `read` or `write` to a specific resource or `type` of resource. @@ -10349,7 +10349,7 @@ paths: InfluxDB enforces access restrictions on API tokens. - In InfluxDB OSS, API tokens are visible to the user who created the authorization and to any - user with an _[operator token](https://docs.influxdata.com/influxdb/v2.3/security/tokens/#operator-token)_. + user with an _[operator token](https://docs.influxdata.com/influxdb/latest/security/tokens/#operator-token)_. - You can't update an authorization's permissions. - Even if an API token has `read-authorizations` permission, the token can't be used to view its authorization details. @@ -10359,7 +10359,7 @@ paths: #### Related guides - - [Create a token](https://docs.influxdata.com/influxdb/v2.3/security/tokens/create-token/) + - [Create a token](https://docs.influxdata.com/influxdb/latest/security/tokens/create-token/) parameters: - $ref: '#/components/parameters/TraceSpan' requestBody: @@ -11363,7 +11363,7 @@ paths: description: The shard ID. - in: query name: since - description: 'The earliest time [RFC3339 date/time format](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#rfc3339-timestamp) to include in the snapshot.' + description: 'The earliest time [RFC3339 date/time format](https://docs.influxdata.com/influxdb/latest/reference/glossary/#rfc3339-timestamp) to include in the snapshot.' schema: type: string format: date-time @@ -11619,7 +11619,7 @@ paths: #### Related guides - - [View your runtime server configuration](https://docs.influxdata.com/influxdb/v2.3/reference/config-options/#view-your-runtime-server-configuration) + - [View your runtime server configuration](https://docs.influxdata.com/influxdb/latest/reference/config-options/#view-your-runtime-server-configuration) parameters: - $ref: '#/components/parameters/TraceSpan' responses: @@ -11973,11 +11973,11 @@ paths: - Dashboards summary: List dashboards description: | - Lists [dashboards](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#dashboard). + Lists [dashboards](https://docs.influxdata.com/influxdb/latest/reference/glossary/#dashboard). #### Related guides - - [Manage dashboards](https://docs.influxdata.com/influxdb/v2.3/visualize-data/dashboards/). + - [Manage dashboards](https://docs.influxdata.com/influxdb/latest/visualize-data/dashboards/). parameters: - $ref: '#/components/parameters/TraceSpan' - $ref: '#/components/parameters/Offset' @@ -11985,7 +11985,7 @@ paths: - $ref: '#/components/parameters/Descending' - in: query name: owner - description: 'A user ID. Only returns [dashboards](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#dashboard) where the specified user has the `owner` role.' + description: 'A user ID. Only returns [dashboards](https://docs.influxdata.com/influxdb/latest/reference/glossary/#dashboard) where the specified user has the `owner` role.' schema: type: string - in: query @@ -12001,7 +12001,7 @@ paths: name: id description: | A list of dashboard IDs. - Returns only the specified [dashboards](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#dashboard). + Returns only the specified [dashboards](https://docs.influxdata.com/influxdb/latest/reference/glossary/#dashboard). If you specify `id` and `owner`, only `id` is used. schema: type: array @@ -12011,16 +12011,16 @@ paths: name: orgID description: | An organization ID. - Only returns [dashboards](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#dashboard) that belong to the specified - [organization](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#organization). + Only returns [dashboards](https://docs.influxdata.com/influxdb/latest/reference/glossary/#dashboard) that belong to the specified + [organization](https://docs.influxdata.com/influxdb/latest/reference/glossary/#organization). schema: type: string - in: query name: org description: | An organization name. - Only returns [dashboards](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#dashboard) that belong to the specified - [organization](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#organization). + Only returns [dashboards](https://docs.influxdata.com/influxdb/latest/reference/glossary/#dashboard) that belong to the specified + [organization](https://docs.influxdata.com/influxdb/latest/reference/glossary/#organization). schema: type: string responses: @@ -12044,21 +12044,21 @@ paths: - Tasks summary: List tasks description: | - Lists [tasks](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task). + Lists [tasks](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task). To limit which tasks are returned, pass query parameters in your request. If no query parameters are passed, InfluxDB returns all tasks up to the default `limit`. #### Related guide - - [Process data with InfluxDB tasks](https://docs.influxdata.com/influxdb/v2.3/process-data/) + - [Process data with InfluxDB tasks](https://docs.influxdata.com/influxdb/latest/process-data/) parameters: - $ref: '#/components/parameters/TraceSpan' - in: query name: name description: | A task name. - Only returns [tasks](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task) + Only returns [tasks](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task) that have the specified name. Different tasks may have the same name. schema: @@ -12069,29 +12069,29 @@ paths: type: string description: | A task ID. - Only returns [tasks](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task) created after the specified task. + Only returns [tasks](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task) created after the specified task. - in: query name: user schema: type: string description: | A user ID. - Only returns [tasks](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task) - owned by the specified [user](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#user). + Only returns [tasks](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task) + owned by the specified [user](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user). - in: query name: org schema: type: string description: | An organization name. - Only returns tasks owned by the specified [organization](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#organization). + Only returns tasks owned by the specified [organization](https://docs.influxdata.com/influxdb/latest/reference/glossary/#organization). - in: query name: orgID schema: type: string description: | An organization ID. - Only returns [tasks](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task) owned by the specified [organization](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#organization). + Only returns [tasks](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task) owned by the specified [organization](https://docs.influxdata.com/influxdb/latest/reference/glossary/#organization). - in: query name: status schema: @@ -12101,7 +12101,7 @@ paths: - inactive description: | A task status. - Only returns [tasks](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task) that have the specified status. + Only returns [tasks](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task) that have the specified status. - in: query name: limit schema: @@ -12110,7 +12110,7 @@ paths: maximum: 500 default: 100 description: | - The maximum number of [tasks](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task) to return. + The maximum number of [tasks](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task) to return. Default is `100`. The minimum is `1` and the maximum is `500`. @@ -12120,7 +12120,7 @@ paths: name: type description: | A task type. - Specifies the level of detail for [tasks](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task) in the response. + Specifies the level of detail for [tasks](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task) in the response. Default is `system`. The default (`system`) response contains all the metadata properties for tasks. To reduce the response size, pass `basic` to omit some task properties (`flux`, `createdAt`, `updatedAt`). @@ -12225,16 +12225,16 @@ paths: - Tasks summary: Create a task description: | - Creates a [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task) and returns the task. + Creates a [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task) and returns the task. Use this endpoint to create a scheduled task that runs a script. #### Related guides - - [Get started with tasks](https://docs.influxdata.com/influxdb/v2.3/process-data/get-started/) - - [Create a task](https://docs.influxdata.com/influxdb/v2.3/process-data/manage-tasks/create-task/) - - [Common tasks](https://docs.influxdata.com/influxdb/v2.3/process-data/common-tasks/) - - [Task configuration options](https://docs.influxdata.com/influxdb/v2.3/process-data/task-options/) + - [Get started with tasks](https://docs.influxdata.com/influxdb/latest/process-data/get-started/) + - [Create a task](https://docs.influxdata.com/influxdb/latest/process-data/manage-tasks/create-task/) + - [Common tasks](https://docs.influxdata.com/influxdb/latest/process-data/common-tasks/) + - [Task configuration options](https://docs.influxdata.com/influxdb/latest/process-data/task-options/) parameters: - $ref: '#/components/parameters/TraceSpan' requestBody: @@ -12300,7 +12300,7 @@ paths: - Tasks summary: Retrieve a task description: | - Retrieves the specified [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task). + Retrieves the specified [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task). parameters: - $ref: '#/components/parameters/TraceSpan' - in: path @@ -12310,7 +12310,7 @@ paths: required: true description: | A task ID. - Specifies the [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task) to retrieve. + Specifies the [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task) to retrieve. responses: '200': description: Success. The response body contains the task. @@ -12334,7 +12334,7 @@ paths: - Tasks summary: Update a task description: | - Updates the specified [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task), + Updates the specified [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task), and then cancels all scheduled runs of the task. Use this endpoint to set, modify, or clear task properties--for example: `cron`, `name`, `flux`, `status`. @@ -12342,8 +12342,8 @@ paths: #### Related guides - - [Update a task](https://docs.influxdata.com/influxdb/v2.3/process-data/manage-tasks/update-task/) - - [Task configuration options](https://docs.influxdata.com/influxdb/v2.3/process-data/task-options/) + - [Update a task](https://docs.influxdata.com/influxdb/latest/process-data/manage-tasks/update-task/) + - [Task configuration options](https://docs.influxdata.com/influxdb/latest/process-data/task-options/) requestBody: description: | In the request body, provide the task properties to update. @@ -12364,7 +12364,7 @@ paths: required: true description: | A task ID. - Specifies the [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task)to update. + Specifies the [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task)to update. responses: '200': description: Success. The response body contains the updated task. @@ -12388,7 +12388,7 @@ paths: - Tasks summary: Delete a task description: | - Deletes the specified [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task) + Deletes the specified [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task) and all associated records (task runs, logs, and labels). Once the task is deleted, InfluxDB cancels all scheduled runs of the task. @@ -12404,7 +12404,7 @@ paths: required: true description: | A task ID. - Specifies the [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task) to delete. + Specifies the [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task) to delete. responses: '204': description: Success. The task and runs are deleted. Scheduled runs are canceled. @@ -12440,7 +12440,7 @@ components: The offset for pagination. The number of records to skip. - For more information about pagination parameters, see [Pagination](https://docs.influxdata.com/influxdb/v2.3/api/#tag/Pagination). + For more information about pagination parameters, see [Pagination](https://docs.influxdata.com/influxdb/latest/api/#tag/Pagination). schema: type: integer minimum: 0 @@ -12480,7 +12480,7 @@ components: results don't include the specified record. Use `after` instead of the `offset` parameter. - For more information about pagination parameters, see [Pagination](https://docs.influxdata.com/influxdb/v2.3/api/#tag/Pagination). + For more information about pagination parameters, see [Pagination](https://docs.influxdata.com/influxdb/latest/api/#tag/Pagination). schemas: LanguageRequest: description: Flux query to be analyzed. @@ -12608,19 +12608,19 @@ components: properties: start: description: | - A timestamp ([RFC3339 date/time format](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#rfc3339-timestamp)). + A timestamp ([RFC3339 date/time format](https://docs.influxdata.com/influxdb/latest/reference/glossary/#rfc3339-timestamp)). The earliest time to delete from. type: string format: date-time stop: description: | - A timestamp ([RFC3339 date/time format](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#rfc3339-timestamp)). + A timestamp ([RFC3339 date/time format](https://docs.influxdata.com/influxdb/latest/reference/glossary/#rfc3339-timestamp)). The latest time to delete from. type: string format: date-time predicate: description: | - An expression in [delete predicate syntax](https://docs.influxdata.com/influxdb/v2.3/reference/syntax/delete-predicate/). + An expression in [delete predicate syntax](https://docs.influxdata.com/influxdb/latest/reference/syntax/delete-predicate/). example: tag1="value1" and (tag2="value2" and tag3!="value3") type: string Node: @@ -12909,7 +12909,7 @@ components: value: type: boolean DateTimeLiteral: - description: 'Represents an instant in time with nanosecond precision in [RFC3339Nano date/time format](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#rfc3339nano-timestamp).' + description: 'Represents an instant in time with nanosecond precision in [RFC3339Nano date/time format](https://docs.influxdata.com/influxdb/latest/reference/glossary/#rfc3339nano-timestamp).' type: object properties: type: @@ -13009,7 +13009,7 @@ components: Dialect: description: | Options for tabular data output. - Default output is [annotated CSV](https://docs.influxdata.com/influxdb/v2.3/reference/syntax/annotated-csv/#csv-response-format) with headers. + Default output is [annotated CSV](https://docs.influxdata.com/influxdb/latest/reference/syntax/annotated-csv/#csv-response-format) with headers. For more information about tabular data **dialect**, see [W3 metadata vocabulary for tabular data](https://www.w3.org/TR/2015/REC-tabular-metadata-20151217/#dialect-descriptions). @@ -13032,7 +13032,7 @@ components: #### Related guides - - See [Annotated CSV annotations](https://docs.influxdata.com/influxdb/v2.3/reference/syntax/annotated-csv/#annotations) for examples and more information. + - See [Annotated CSV annotations](https://docs.influxdata.com/influxdb/latest/reference/syntax/annotated-csv/#annotations) for examples and more information. For more information about **annotations** in tabular data, see [W3 metadata vocabulary for tabular data](https://www.w3.org/TR/2015/REC-tabular-data-model-20151217/#columns). @@ -13053,7 +13053,7 @@ components: dateTimeFormat: description: | The format for timestamps in results. - Default is [`RFC3339` date/time format](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#rfc3339-timestamp). + Default is [`RFC3339` date/time format](https://docs.influxdata.com/influxdb/latest/reference/glossary/#rfc3339-timestamp). To include nanoseconds in timestamps, use `RFC3339Nano`. #### Example formatted date/time values @@ -13087,7 +13087,7 @@ components: type: string description: | The organization ID. - Specifies the [organization](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#organization) that the authorization is scoped to. + Specifies the [organization](https://docs.influxdata.com/influxdb/latest/reference/glossary/#organization) that the authorization is scoped to. permissions: type: array minItems: 1 @@ -13106,20 +13106,20 @@ components: description: | The API token. The token value is unique to the authorization. - [API tokens](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#token) are + [API tokens](https://docs.influxdata.com/influxdb/latest/reference/glossary/#token) are used to authenticate and authorize InfluxDB API requests and `influx` CLI commands--after receiving the request, InfluxDB checks that the token is valid and that the `permissions` allow the requested action(s). userID: readOnly: true type: string - description: 'The user ID. Specifies the [user](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#user) that owns the authorization. If _scoped_, the user that the authorization is scoped to; otherwise, the creator of the authorization.' + description: 'The user ID. Specifies the [user](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user) that owns the authorization. If _scoped_, the user that the authorization is scoped to; otherwise, the creator of the authorization.' user: readOnly: true type: string description: | The user name. - Specifies the [user](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#user) that owns the authorization. + Specifies the [user](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user) that owns the authorization. If the authorization is _scoped_ to a user, the user; otherwise, the creator of the authorization. org: @@ -13127,7 +13127,7 @@ components: type: string description: | The organization name. - Specifies the [organization](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#organization) + Specifies the [organization](https://docs.influxdata.com/influxdb/latest/reference/glossary/#organization) that the token is scoped to. links: type: object @@ -13226,7 +13226,7 @@ components: [Retention policy](https://docs.influxdata.com/influxdb/v1.8/concepts/glossary/#retention-policy-rp) is an InfluxDB 1.x concept. The InfluxDB 2.x and Cloud equivalent is - [retention period](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#retention-period). + [retention period](https://docs.influxdata.com/influxdb/latest/reference/glossary/#retention-period). The InfluxDB `/api/v2` API uses `RetentionRules` to configure the retention period. type: string default: '0' @@ -13330,7 +13330,7 @@ components: type: array description: | Retention rules to expire or retain data. - The InfluxDB `/api/v2` API uses `RetentionRules` to configure the [retention period](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#retention-period). + The InfluxDB `/api/v2` API uses `RetentionRules` to configure the [retention period](https://docs.influxdata.com/influxdb/latest/reference/glossary/#retention-period). #### InfluxDB Cloud @@ -13383,7 +13383,7 @@ components: type: integer format: int64 description: | - The [shard group duration](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#shard). + The [shard group duration](https://docs.influxdata.com/influxdb/latest/reference/glossary/#shard). The number of seconds that each shard group covers. #### InfluxDB Cloud @@ -13392,11 +13392,11 @@ components: #### InfluxDB OSS - - Default value depends on the [bucket retention period](https://docs.influxdata.com/influxdb/v2.3/reference/internals/shards/#shard-group-duration). + - Default value depends on the [bucket retention period](https://docs.influxdata.com/influxdb/latest/reference/internals/shards/#shard-group-duration). #### Related guides - - InfluxDB [shards and shard groups](https://docs.influxdata.com/influxdb/v2.3/reference/internals/shards/) + - InfluxDB [shards and shard groups](https://docs.influxdata.com/influxdb/latest/reference/internals/shards/) required: - everySeconds RetentionRule: @@ -13431,7 +13431,7 @@ components: #### InfluxDB OSS - Default value depends on the - [bucket retention period](https://docs.influxdata.com/influxdb/v2.3/v2.3/reference/internals/shards/#shard-group-duration). + [bucket retention period](https://docs.influxdata.com/influxdb/latest/v2.3/reference/internals/shards/#shard-group-duration). required: - everySeconds Link: @@ -13465,7 +13465,7 @@ components: properties: time: readOnly: true - description: 'The time ([RFC3339Nano date/time format](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#rfc3339nano-timestamp)) that the event occurred.' + description: 'The time ([RFC3339Nano date/time format](https://docs.influxdata.com/influxdb/latest/reference/glossary/#rfc3339nano-timestamp)) that the event occurred.' type: string format: date-time example: '2006-01-02T15:04:05.999999999Z07:00' @@ -13586,7 +13586,7 @@ components: The organization owns all resources created by the template. To find your organization, see how to - [view organizations](https://docs.influxdata.com/influxdb/v2.3/organizations/view-orgs/). + [view organizations](https://docs.influxdata.com/influxdb/latest/organizations/view-orgs/). stackID: type: string description: | @@ -13600,8 +13600,8 @@ components: #### Related guides - - [Stacks](https://docs.influxdata.com/influxdb/v2.3/influxdb-templates/stacks/) - - [View stacks](https://docs.influxdata.com/influxdb/v2.3/influxdb-templates/stacks/view/) + - [Stacks](https://docs.influxdata.com/influxdb/latest/influxdb-templates/stacks/) + - [View stacks](https://docs.influxdata.com/influxdb/latest/influxdb-templates/stacks/view/) template: type: object description: | @@ -13653,7 +13653,7 @@ components: When you apply a template, InfluxDB replaces `envRef` objects in the template with the values that you provide in the `envRefs` parameter. - For more examples, see how to [define environment references](https://docs.influxdata.com/influxdb/v2.3/influxdb-templates/use/#define-environment-references). + For more examples, see how to [define environment references](https://docs.influxdata.com/influxdb/latest/influxdb-templates/use/#define-environment-references). The following template fields may use environment references: @@ -13662,7 +13662,7 @@ components: - `spec.associations.name` For more information about including environment references in template fields, see how to - [include user-definable resource names](https://docs.influxdata.com/influxdb/v2.3/influxdb-templates/create/#include-user-definable-resource-names). + [include user-definable resource names](https://docs.influxdata.com/influxdb/latest/influxdb-templates/create/#include-user-definable-resource-names). additionalProperties: oneOf: - type: string @@ -13711,7 +13711,7 @@ components: #### Related guides - - [How to pass secrets when installing a template](https://docs.influxdata.com/influxdb/v2.3/influxdb-templates/use/#pass-secrets-when-installing-a-template) + - [How to pass secrets when installing a template](https://docs.influxdata.com/influxdb/latest/influxdb-templates/use/#pass-secrets-when-installing-a-template) additionalProperties: type: string remotes: @@ -14683,7 +14683,7 @@ components: - success - canceled scheduledFor: - description: 'The time [RFC3339 date/time format](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#rfc3339-timestamp) used for the run''s `now` option.' + description: 'The time [RFC3339 date/time format](https://docs.influxdata.com/influxdb/latest/reference/glossary/#rfc3339-timestamp) used for the run''s `now` option.' type: string format: date-time log: @@ -14710,7 +14710,7 @@ components: example: '2006-01-02T15:04:05.999999999Z07:00' requestedAt: readOnly: true - description: 'The time ([RFC3339Nano date/time format](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#rfc3339nano-timestamp)) the run was manually requested.' + description: 'The time ([RFC3339Nano date/time format](https://docs.influxdata.com/influxdb/latest/reference/glossary/#rfc3339nano-timestamp)) the run was manually requested.' type: string format: date-time example: '2006-01-02T15:04:05.999999999Z07:00' @@ -14736,7 +14736,7 @@ components: scheduledFor: nullable: true description: | - The time [RFC3339 date/time format](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#rfc3339-timestamp) + The time [RFC3339 date/time format](https://docs.influxdata.com/influxdb/latest/reference/glossary/#rfc3339-timestamp) used for the run's `now` option. Default is the server _now_ time. type: string @@ -14749,17 +14749,17 @@ components: description: A description of the task. type: string TaskEvery: - description: 'The interval ([duration literal](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#rfc3339-timestamp)) at which the task runs. `every` also determines when the task first runs, depending on the specified time.' + description: 'The interval ([duration literal](https://docs.influxdata.com/influxdb/latest/reference/glossary/#rfc3339-timestamp)) at which the task runs. `every` also determines when the task first runs, depending on the specified time.' type: string format: duration TaskFlux: description: | - Flux with [task configuration options](https://docs.influxdata.com/influxdb/v2.3/process-data/task-options/) + Flux with [task configuration options](https://docs.influxdata.com/influxdb/latest/process-data/task-options/) and the script for the task to run. #### Related guides - - [Task configuration options](https://docs.influxdata.com/influxdb/v2.3/process-data/task-options/) + - [Task configuration options](https://docs.influxdata.com/influxdb/latest/process-data/task-options/) type: string format: Flux TaskName: @@ -14772,12 +14772,12 @@ components: TaskOrg: description: | An organization name. - Identifies the [organization](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#organization) that owns the task. + Identifies the [organization](https://docs.influxdata.com/influxdb/latest/reference/glossary/#organization) that owns the task. type: string TaskOrgID: description: | An organization ID. - Identifies the [organization](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#organization) that owns the task. + Identifies the [organization](https://docs.influxdata.com/influxdb/latest/reference/glossary/#organization) that owns the task. type: string TaskStatusType: type: string @@ -17164,7 +17164,7 @@ components: type: string latestCompleted: type: string - description: 'A timestamp ([RFC3339 date/time format](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#rfc3339-timestamp)) of the latest scheduled and completed run.' + description: 'A timestamp ([RFC3339 date/time format](https://docs.influxdata.com/influxdb/latest/reference/glossary/#rfc3339-timestamp)) of the latest scheduled and completed run.' format: date-time readOnly: true lastRunStatus: @@ -17434,7 +17434,7 @@ components: - endpointID properties: latestCompleted: - description: 'A timestamp ([RFC3339 date/time format](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#rfc3339-timestamp)) of the latest scheduled and completed run.' + description: 'A timestamp ([RFC3339 date/time format](https://docs.influxdata.com/influxdb/latest/reference/glossary/#rfc3339-timestamp)) of the latest scheduled and completed run.' type: string format: date-time readOnly: true @@ -18621,7 +18621,7 @@ components: ownerID: description: | A user ID. - Identifies the [user](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#user) that owns the task. + Identifies the [user](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user) that owns the task. To find a user ID, use the [`GET /api/v2/users` endpoint](#operation/GetUsers) to @@ -18649,7 +18649,7 @@ components: offset: $ref: '#/components/schemas/TaskOffset' latestCompleted: - description: 'A timestamp ([RFC3339 date/time format](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#rfc3339-timestamp)) of the latest scheduled and completed run.' + description: 'A timestamp ([RFC3339 date/time format](https://docs.influxdata.com/influxdb/latest/reference/glossary/#rfc3339-timestamp)) of the latest scheduled and completed run.' type: string format: date-time readOnly: true @@ -18896,7 +18896,7 @@ components: Replace the following: - *`INFLUX_URL`*: your InfluxDB URL - - *`INFLUX_API_TOKEN`*: your [InfluxDB API token](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#token) + - *`INFLUX_API_TOKEN`*: your [InfluxDB API token](https://docs.influxdata.com/influxdb/latest/reference/glossary/#token) ### Related endpoints @@ -18904,8 +18904,8 @@ components: ### Related guides - - [Authorize API requests](https://docs.influxdata.com/influxdb/v2.3/api-guide/api_intro/#authentication) - - [Manage API tokens](https://docs.influxdata.com/influxdb/v2.3/security/tokens/) + - [Authorize API requests](https://docs.influxdata.com/influxdb/latest/api-guide/api_intro/#authentication) + - [Manage API tokens](https://docs.influxdata.com/influxdb/latest/security/tokens/) BasicAuthentication: type: http scheme: basic @@ -18934,7 +18934,7 @@ components: In the examples, replace the following: - **`USERNAME`**: InfluxDB username - - **`PASSWORD`**: InfluxDB [API token](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#token) + - **`PASSWORD`**: InfluxDB [API token](https://docs.influxdata.com/influxdb/latest/reference/glossary/#token) - **`INFLUX_URL`**: your InfluxDB URL #### Encode credentials with cURL diff --git a/contracts/ref/oss.yml b/contracts/ref/oss.yml index ac6ad405f..adb370b8c 100644 --- a/contracts/ref/oss.yml +++ b/contracts/ref/oss.yml @@ -53,7 +53,7 @@ components: results don't include the specified record. Use `after` instead of the `offset` parameter. - For more information about pagination parameters, see [Pagination](https://docs.influxdata.com/influxdb/v2.3/api/#tag/Pagination). + For more information about pagination parameters, see [Pagination](https://docs.influxdata.com/influxdb/latest/api/#tag/Pagination). in: query name: after required: false @@ -82,7 +82,7 @@ components: The offset for pagination. The number of records to skip. - For more information about pagination parameters, see [Pagination](https://docs.influxdata.com/influxdb/v2.3/api/#tag/Pagination). + For more information about pagination parameters, see [Pagination](https://docs.influxdata.com/influxdb/latest/api/#tag/Pagination). in: query name: offset required: false @@ -844,7 +844,7 @@ components: readOnly: true type: string latestCompleted: - description: A timestamp ([RFC3339 date/time format](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#rfc3339-timestamp)) + description: A timestamp ([RFC3339 date/time format](https://docs.influxdata.com/influxdb/latest/reference/glossary/#rfc3339-timestamp)) of the latest scheduled and completed run. format: date-time readOnly: true @@ -1290,7 +1290,7 @@ components: type: object DateTimeLiteral: description: Represents an instant in time with nanosecond precision in [RFC3339Nano - date/time format](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#rfc3339nano-timestamp). + date/time format](https://docs.influxdata.com/influxdb/latest/reference/glossary/#rfc3339nano-timestamp). properties: type: $ref: '#/components/schemas/NodeType' @@ -1357,18 +1357,18 @@ components: properties: predicate: description: | - An expression in [delete predicate syntax](https://docs.influxdata.com/influxdb/v2.3/reference/syntax/delete-predicate/). + An expression in [delete predicate syntax](https://docs.influxdata.com/influxdb/latest/reference/syntax/delete-predicate/). example: tag1="value1" and (tag2="value2" and tag3!="value3") type: string start: description: | - A timestamp ([RFC3339 date/time format](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#rfc3339-timestamp)). + A timestamp ([RFC3339 date/time format](https://docs.influxdata.com/influxdb/latest/reference/glossary/#rfc3339-timestamp)). The earliest time to delete from. format: date-time type: string stop: description: | - A timestamp ([RFC3339 date/time format](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#rfc3339-timestamp)). + A timestamp ([RFC3339 date/time format](https://docs.influxdata.com/influxdb/latest/reference/glossary/#rfc3339-timestamp)). The latest time to delete from. format: date-time type: string @@ -1379,7 +1379,7 @@ components: Dialect: description: | Options for tabular data output. - Default output is [annotated CSV](https://docs.influxdata.com/influxdb/v2.3/reference/syntax/annotated-csv/#csv-response-format) with headers. + Default output is [annotated CSV](https://docs.influxdata.com/influxdb/latest/reference/syntax/annotated-csv/#csv-response-format) with headers. For more information about tabular data **dialect**, see [W3 metadata vocabulary for tabular data](https://www.w3.org/TR/2015/REC-tabular-metadata-20151217/#dialect-descriptions). @@ -1391,7 +1391,7 @@ components: #### Related guides - - See [Annotated CSV annotations](https://docs.influxdata.com/influxdb/v2.3/reference/syntax/annotated-csv/#annotations) for examples and more information. + - See [Annotated CSV annotations](https://docs.influxdata.com/influxdb/latest/reference/syntax/annotated-csv/#annotations) for examples and more information. For more information about **annotations** in tabular data, see [W3 metadata vocabulary for tabular data](https://www.w3.org/TR/2015/REC-tabular-data-model-20151217/#columns). @@ -1414,7 +1414,7 @@ components: default: RFC3339 description: | The format for timestamps in results. - Default is [`RFC3339` date/time format](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#rfc3339-timestamp). + Default is [`RFC3339` date/time format](https://docs.influxdata.com/influxdb/latest/reference/glossary/#rfc3339-timestamp). To include nanoseconds in timestamps, use `RFC3339Nano`. #### Example formatted date/time values @@ -2616,7 +2616,7 @@ components: readOnly: true type: string time: - description: The time ([RFC3339Nano date/time format](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#rfc3339nano-timestamp)) + description: The time ([RFC3339Nano date/time format](https://docs.influxdata.com/influxdb/latest/reference/glossary/#rfc3339nano-timestamp)) that the event occurred. example: 2006-01-02T15:04:05.999999999Z07:00 format: date-time @@ -2957,7 +2957,7 @@ components: readOnly: true type: string latestCompleted: - description: A timestamp ([RFC3339 date/time format](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#rfc3339-timestamp)) + description: A timestamp ([RFC3339 date/time format](https://docs.influxdata.com/influxdb/latest/reference/glossary/#rfc3339-timestamp)) of the latest scheduled and completed run. format: date-time readOnly: true @@ -3307,7 +3307,7 @@ components: type: integer shardGroupDurationSeconds: description: | - The [shard group duration](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#shard). + The [shard group duration](https://docs.influxdata.com/influxdb/latest/reference/glossary/#shard). The number of seconds that each shard group covers. #### InfluxDB Cloud @@ -3316,11 +3316,11 @@ components: #### InfluxDB OSS - - Default value depends on the [bucket retention period](https://docs.influxdata.com/influxdb/v2.3/reference/internals/shards/#shard-group-duration). + - Default value depends on the [bucket retention period](https://docs.influxdata.com/influxdb/latest/reference/internals/shards/#shard-group-duration). #### Related guides - - InfluxDB [shards and shard groups](https://docs.influxdata.com/influxdb/v2.3/reference/internals/shards/) + - InfluxDB [shards and shard groups](https://docs.influxdata.com/influxdb/latest/reference/internals/shards/) format: int64 type: integer type: @@ -3451,7 +3451,7 @@ components: [Retention policy](https://docs.influxdata.com/influxdb/v1.8/concepts/glossary/#retention-policy-rp) is an InfluxDB 1.x concept. The InfluxDB 2.x and Cloud equivalent is - [retention period](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#retention-period). + [retention period](https://docs.influxdata.com/influxdb/latest/reference/glossary/#retention-period). The InfluxDB `/api/v2` API uses `RetentionRules` to configure the retention period. type: string schemaType: @@ -3984,7 +3984,7 @@ components: #### InfluxDB OSS - Default value depends on the - [bucket retention period](https://docs.influxdata.com/influxdb/v2.3/v2.3/reference/internals/shards/#shard-group-duration). + [bucket retention period](https://docs.influxdata.com/influxdb/latest/v2.3/reference/internals/shards/#shard-group-duration). format: int64 type: integer type: @@ -3998,7 +3998,7 @@ components: RetentionRules: description: | Retention rules to expire or retain data. - The InfluxDB `/api/v2` API uses `RetentionRules` to configure the [retention period](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#retention-period). + The InfluxDB `/api/v2` API uses `RetentionRules` to configure the [retention period](https://docs.influxdata.com/influxdb/latest/reference/glossary/#retention-period). #### InfluxDB Cloud @@ -4148,14 +4148,14 @@ components: readOnly: true type: array requestedAt: - description: The time ([RFC3339Nano date/time format](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#rfc3339nano-timestamp)) + description: The time ([RFC3339Nano date/time format](https://docs.influxdata.com/influxdb/latest/reference/glossary/#rfc3339nano-timestamp)) the run was manually requested. example: 2006-01-02T15:04:05.999999999Z07:00 format: date-time readOnly: true type: string scheduledFor: - description: The time [RFC3339 date/time format](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#rfc3339-timestamp) + description: The time [RFC3339 date/time format](https://docs.influxdata.com/influxdb/latest/reference/glossary/#rfc3339-timestamp) used for the run's `now` option. format: date-time type: string @@ -4182,7 +4182,7 @@ components: properties: scheduledFor: description: | - The time [RFC3339 date/time format](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#rfc3339-timestamp) + The time [RFC3339 date/time format](https://docs.influxdata.com/influxdb/latest/reference/glossary/#rfc3339-timestamp) used for the run's `now` option. Default is the server _now_ time. format: date-time @@ -4919,7 +4919,7 @@ components: readOnly: true type: string latestCompleted: - description: A timestamp ([RFC3339 date/time format](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#rfc3339-timestamp)) + description: A timestamp ([RFC3339 date/time format](https://docs.influxdata.com/influxdb/latest/reference/glossary/#rfc3339-timestamp)) of the latest scheduled and completed run. format: date-time readOnly: true @@ -4958,7 +4958,7 @@ components: ownerID: description: | A user ID. - Identifies the [user](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#user) that owns the task. + Identifies the [user](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user) that owns the task. To find a user ID, use the [`GET /api/v2/users` endpoint](#operation/GetUsers) to @@ -5003,19 +5003,19 @@ components: description: A description of the task. type: string TaskEvery: - description: The interval ([duration literal](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#rfc3339-timestamp)) + description: The interval ([duration literal](https://docs.influxdata.com/influxdb/latest/reference/glossary/#rfc3339-timestamp)) at which the task runs. `every` also determines when the task first runs, depending on the specified time. format: duration type: string TaskFlux: description: | - Flux with [task configuration options](https://docs.influxdata.com/influxdb/v2.3/process-data/task-options/) + Flux with [task configuration options](https://docs.influxdata.com/influxdb/latest/process-data/task-options/) and the script for the task to run. #### Related guides - - [Task configuration options](https://docs.influxdata.com/influxdb/v2.3/process-data/task-options/) + - [Task configuration options](https://docs.influxdata.com/influxdb/latest/process-data/task-options/) format: Flux type: string TaskName: @@ -5030,12 +5030,12 @@ components: TaskOrg: description: | An organization name. - Identifies the [organization](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#organization) that owns the task. + Identifies the [organization](https://docs.influxdata.com/influxdb/latest/reference/glossary/#organization) that owns the task. type: string TaskOrgID: description: | An organization ID. - Identifies the [organization](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#organization) that owns the task. + Identifies the [organization](https://docs.influxdata.com/influxdb/latest/reference/glossary/#organization) that owns the task. type: string TaskStatusType: description: | @@ -5350,7 +5350,7 @@ components: When you apply a template, InfluxDB replaces `envRef` objects in the template with the values that you provide in the `envRefs` parameter. - For more examples, see how to [define environment references](https://docs.influxdata.com/influxdb/v2.3/influxdb-templates/use/#define-environment-references). + For more examples, see how to [define environment references](https://docs.influxdata.com/influxdb/latest/influxdb-templates/use/#define-environment-references). The following template fields may use environment references: @@ -5359,7 +5359,7 @@ components: - `spec.associations.name` For more information about including environment references in template fields, see how to - [include user-definable resource names](https://docs.influxdata.com/influxdb/v2.3/influxdb-templates/create/#include-user-definable-resource-names). + [include user-definable resource names](https://docs.influxdata.com/influxdb/latest/influxdb-templates/create/#include-user-definable-resource-names). type: object orgID: description: | @@ -5368,7 +5368,7 @@ components: The organization owns all resources created by the template. To find your organization, see how to - [view organizations](https://docs.influxdata.com/influxdb/v2.3/organizations/view-orgs/). + [view organizations](https://docs.influxdata.com/influxdb/latest/organizations/view-orgs/). type: string remotes: description: | @@ -5429,7 +5429,7 @@ components: #### Related guides - - [How to pass secrets when installing a template](https://docs.influxdata.com/influxdb/v2.3/influxdb-templates/use/#pass-secrets-when-installing-a-template) + - [How to pass secrets when installing a template](https://docs.influxdata.com/influxdb/latest/influxdb-templates/use/#pass-secrets-when-installing-a-template) type: object stackID: description: | @@ -5443,8 +5443,8 @@ components: #### Related guides - - [Stacks](https://docs.influxdata.com/influxdb/v2.3/influxdb-templates/stacks/) - - [View stacks](https://docs.influxdata.com/influxdb/v2.3/influxdb-templates/stacks/view/) + - [Stacks](https://docs.influxdata.com/influxdb/latest/influxdb-templates/stacks/) + - [View stacks](https://docs.influxdata.com/influxdb/latest/influxdb-templates/stacks/view/) type: string template: description: | @@ -6694,7 +6694,7 @@ components: In the examples, replace the following: - **`USERNAME`**: InfluxDB username - - **`PASSWORD`**: InfluxDB [API token](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#token) + - **`PASSWORD`**: InfluxDB [API token](https://docs.influxdata.com/influxdb/latest/reference/glossary/#token) - **`INFLUX_URL`**: your InfluxDB URL #### Encode credentials with cURL @@ -6764,7 +6764,7 @@ components: Replace the following: - *`INFLUX_URL`*: your InfluxDB URL - - *`INFLUX_API_TOKEN`*: your [InfluxDB API token](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#token) + - *`INFLUX_API_TOKEN`*: your [InfluxDB API token](https://docs.influxdata.com/influxdb/latest/reference/glossary/#token) ### Related endpoints @@ -6772,8 +6772,8 @@ components: ### Related guides - - [Authorize API requests](https://docs.influxdata.com/influxdb/v2.3/api-guide/api_intro/#authentication) - - [Manage API tokens](https://docs.influxdata.com/influxdb/v2.3/security/tokens/) + - [Authorize API requests](https://docs.influxdata.com/influxdb/latest/api-guide/api_intro/#authentication) + - [Manage API tokens](https://docs.influxdata.com/influxdb/latest/security/tokens/) in: header name: Authorization type: apiKey @@ -6819,7 +6819,7 @@ paths: #### InfluxDB OSS - InfluxDB OSS returns - [API token](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#token) values in authorizations. + [API token](https://docs.influxdata.com/influxdb/latest/reference/glossary/#token) values in authorizations. - If the request uses an _[operator token](https://docs.influxdata.com/influxdb/latest/security/tokens/#operator-token)_, InfluxDB OSS returns authorizations for all organizations in the instance. @@ -6829,33 +6829,33 @@ paths: #### Related guides - - [View tokens](https://docs.influxdata.com/influxdb/v2.3/security/tokens/view-tokens/) + - [View tokens](https://docs.influxdata.com/influxdb/latest/security/tokens/view-tokens/) operationId: GetAuthorizations parameters: - $ref: '#/components/parameters/TraceSpan' - description: | A user ID. - Only returns authorizations scoped to the specified [user](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#user). + Only returns authorizations scoped to the specified [user](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user). in: query name: userID schema: type: string - description: | A user name. - Only returns authorizations scoped to the specified [user](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#user). + Only returns authorizations scoped to the specified [user](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user). in: query name: user schema: type: string - description: An organization ID. Only returns authorizations that belong to - the specified [organization](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#organization). + the specified [organization](https://docs.influxdata.com/influxdb/latest/reference/glossary/#organization). in: query name: orgID schema: type: string - description: | An organization name. - Only returns authorizations that belong to the specified [organization](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#organization). + Only returns authorizations that belong to the specified [organization](https://docs.influxdata.com/influxdb/latest/reference/glossary/#organization). in: query name: org schema: @@ -6884,7 +6884,7 @@ paths: post: description: | Creates an authorization and returns the authorization with the - generated API [token](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#token). + generated API [token](https://docs.influxdata.com/influxdb/latest/reference/glossary/#token). Use this endpoint to create an authorization, which generates an API token with permissions to `read` or `write` to a specific resource or `type` of resource. @@ -6896,7 +6896,7 @@ paths: InfluxDB enforces access restrictions on API tokens. - In InfluxDB OSS, API tokens are visible to the user who created the authorization and to any - user with an _[operator token](https://docs.influxdata.com/influxdb/v2.3/security/tokens/#operator-token)_. + user with an _[operator token](https://docs.influxdata.com/influxdb/latest/security/tokens/#operator-token)_. - You can't update an authorization's permissions. - Even if an API token has `read-authorizations` permission, the token can't be used to view its authorization details. @@ -6906,7 +6906,7 @@ paths: #### Related guides - - [Create a token](https://docs.influxdata.com/influxdb/v2.3/security/tokens/create-token/) + - [Create a token](https://docs.influxdata.com/influxdb/latest/security/tokens/create-token/) operationId: PostAuthorizations parameters: - $ref: '#/components/parameters/TraceSpan' @@ -7110,7 +7110,7 @@ paths: schema: format: int64 type: integer - - description: The earliest time [RFC3339 date/time format](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#rfc3339-timestamp) + - description: The earliest time [RFC3339 date/time format](https://docs.influxdata.com/influxdb/latest/reference/glossary/#rfc3339-timestamp) to include in the snapshot. examples: RFC3339: @@ -7156,19 +7156,19 @@ paths: /api/v2/buckets: get: description: | - Lists [buckets](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#bucket). + Lists [buckets](https://docs.influxdata.com/influxdb/latest/reference/glossary/#bucket). InfluxDB retrieves buckets owned by the - [organization](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#organization) + [organization](https://docs.influxdata.com/influxdb/latest/reference/glossary/#organization) associated with the authorization - ([API token](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#token)). + ([API token](https://docs.influxdata.com/influxdb/latest/reference/glossary/#token)). To limit which buckets are returned, pass query parameters in your request. If no query parameters are passed, InfluxDB returns all buckets up to the default `limit`. #### InfluxDB OSS - - If you use an _[operator token](https://docs.influxdata.com/influxdb/v2.3/security/tokens/#operator-token)_ + - If you use an _[operator token](https://docs.influxdata.com/influxdb/latest/security/tokens/#operator-token)_ to authenticate your request, InfluxDB retrieves resources for _all organizations_ in the instance. To retrieve resources for only a specific organization, use the @@ -7179,11 +7179,11 @@ paths: | Action | Permission required | |:--------------------------|:--------------------| | Retrieve _user buckets_ | `read-buckets` | - | Retrieve [_system buckets_](https://docs.influxdata.com/influxdb/v2.3/reference/internals/system-buckets/) | `read-orgs` | + | Retrieve [_system buckets_](https://docs.influxdata.com/influxdb/latest/reference/internals/system-buckets/) | `read-orgs` | #### Related Guides - - [Manage buckets](https://docs.influxdata.com/influxdb/v2.3/organizations/buckets/) + - [Manage buckets](https://docs.influxdata.com/influxdb/latest/organizations/buckets/) operationId: GetBuckets parameters: - $ref: '#/components/parameters/TraceSpan' @@ -7292,10 +7292,10 @@ paths: --header "Content-Type: application/json" post: description: | - Creates a [bucket](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#bucket) + Creates a [bucket](https://docs.influxdata.com/influxdb/latest/reference/glossary/#bucket) and returns the bucket resource. The default data - [retention period](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#retention-period) + [retention period](https://docs.influxdata.com/influxdb/latest/reference/glossary/#retention-period) is 30 days. #### InfluxDB OSS @@ -7314,8 +7314,8 @@ paths: #### Related Guides - - [Create a bucket](https://docs.influxdata.com/influxdb/v2.3/organizations/buckets/create-bucket/) - - [Create bucket CLI reference](https://docs.influxdata.com/influxdb/v2.3/reference/cli/influx/bucket/create) + - [Create a bucket](https://docs.influxdata.com/influxdb/latest/organizations/buckets/create-bucket/) + - [Create bucket CLI reference](https://docs.influxdata.com/influxdb/latest/reference/cli/influx/bucket/create) operationId: PostBuckets parameters: - $ref: '#/components/parameters/TraceSpan' @@ -7452,7 +7452,7 @@ paths: #### Related Guides - - [Delete a bucket](https://docs.influxdata.com/influxdb/v2.3/organizations/buckets/delete-bucket/#delete-a-bucket-in-the-influxdb-ui) + - [Delete a bucket](https://docs.influxdata.com/influxdb/latest/organizations/buckets/delete-bucket/#delete-a-bucket-in-the-influxdb-ui) operationId: DeleteBucketsID parameters: - $ref: '#/components/parameters/TraceSpan' @@ -7615,7 +7615,7 @@ paths: #### Related Guides - - [Update a bucket](https://docs.influxdata.com/influxdb/v2.3/organizations/buckets/update-bucket/) + - [Update a bucket](https://docs.influxdata.com/influxdb/latest/organizations/buckets/update-bucket/) operationId: PatchBucketsID parameters: - $ref: '#/components/parameters/TraceSpan' @@ -7754,7 +7754,7 @@ paths: #### Related guides - Use the [`/api/v2/labels` InfluxDB API endpoint](#tag/Labels) to retrieve and manage labels. - - [Manage labels in the InfluxDB UI](https://docs.influxdata.com/influxdb/v2.3/visualize-data/labels/) + - [Manage labels in the InfluxDB UI](https://docs.influxdata.com/influxdb/latest/visualize-data/labels/) operationId: GetBucketsIDLabels parameters: - $ref: '#/components/parameters/TraceSpan' @@ -7818,7 +7818,7 @@ paths: #### Related guides - Use the [`/api/v2/labels` InfluxDB API endpoint](#tag/Labels) to retrieve and manage labels. - - [Manage labels in the InfluxDB UI](https://docs.influxdata.com/influxdb/v2.3/visualize-data/labels/) + - [Manage labels in the InfluxDB UI](https://docs.influxdata.com/influxdb/latest/visualize-data/labels/) operationId: PostBucketsIDLabels parameters: - $ref: '#/components/parameters/TraceSpan' @@ -7944,18 +7944,18 @@ paths: description: | Lists all users for a bucket. - InfluxDB [users](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#user) have + InfluxDB [users](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user) have permission to access InfluxDB. - [Members](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#member) are users in + [Members](https://docs.influxdata.com/influxdb/latest/reference/glossary/#member) are users in an organization with access to the specified resource. Use this endpoint to retrieve all users with access to a bucket. #### Related guides - - [Manage users](https://docs.influxdata.com/influxdb/v2.3/users/) - - [Manage members](https://docs.influxdata.com/influxdb/v2.3/organizations/members/) + - [Manage users](https://docs.influxdata.com/influxdb/latest/users/) + - [Manage members](https://docs.influxdata.com/influxdb/latest/organizations/members/) operationId: GetBucketsIDMembers parameters: - $ref: '#/components/parameters/TraceSpan' @@ -8014,18 +8014,18 @@ paths: description: | Add a user to a bucket and return the new user information. - InfluxDB [users](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#user) have + InfluxDB [users](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user) have permission to access InfluxDB. - [Members](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#member) are users in + [Members](https://docs.influxdata.com/influxdb/latest/reference/glossary/#member) are users in an organization. Use this endpoint to give a user member privileges to a bucket. #### Related guides - - [Manage users](https://docs.influxdata.com/influxdb/v2.3/users/) - - [Manage members](https://docs.influxdata.com/influxdb/v2.3/organizations/members/) + - [Manage users](https://docs.influxdata.com/influxdb/latest/users/) + - [Manage members](https://docs.influxdata.com/influxdb/latest/organizations/members/) operationId: PostBucketsIDMembers parameters: - $ref: '#/components/parameters/TraceSpan' @@ -8105,8 +8105,8 @@ paths: #### Related guides - - [Manage users](https://docs.influxdata.com/influxdb/v2.3/users/) - - [Manage members](https://docs.influxdata.com/influxdb/v2.3/organizations/members/) + - [Manage users](https://docs.influxdata.com/influxdb/latest/users/) + - [Manage members](https://docs.influxdata.com/influxdb/latest/organizations/members/) operationId: DeleteBucketsIDMembersID parameters: - $ref: '#/components/parameters/TraceSpan' @@ -8147,7 +8147,7 @@ paths: /api/v2/buckets/{bucketID}/owners: get: description: | - Lists all [owners](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#owner) + Lists all [owners](https://docs.influxdata.com/influxdb/latest/reference/glossary/#owner) of a bucket. Bucket owners have permission to delete buckets and remove user and member @@ -8176,7 +8176,7 @@ paths: #### Related guides - - [Manage users](https://docs.influxdata.com/influxdb/v2.3/users/) + - [Manage users](https://docs.influxdata.com/influxdb/latest/users/) operationId: GetBucketsIDOwners parameters: - $ref: '#/components/parameters/TraceSpan' @@ -8227,7 +8227,7 @@ paths: - Buckets post: description: | - Adds an owner to a bucket and returns the [owners](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#owner) + Adds an owner to a bucket and returns the [owners](https://docs.influxdata.com/influxdb/latest/reference/glossary/#owner) with role and user detail. Use this endpoint to create a _resource owner_ for the bucket. @@ -8256,7 +8256,7 @@ paths: #### Related guides - - [Manage users](https://docs.influxdata.com/influxdb/v2.3/users/) + - [Manage users](https://docs.influxdata.com/influxdb/latest/users/) operationId: PostBucketsIDOwners parameters: - $ref: '#/components/parameters/TraceSpan' @@ -8358,7 +8358,7 @@ paths: #### Related guides - - [Manage users](https://docs.influxdata.com/influxdb/v2.3/users/) + - [Manage users](https://docs.influxdata.com/influxdb/latest/users/) operationId: DeleteBucketsIDOwnersID parameters: - $ref: '#/components/parameters/TraceSpan' @@ -8727,7 +8727,7 @@ paths: #### Related guides - - [View your runtime server configuration](https://docs.influxdata.com/influxdb/v2.3/reference/config-options/#view-your-runtime-server-configuration) + - [View your runtime server configuration](https://docs.influxdata.com/influxdb/latest/reference/config-options/#view-your-runtime-server-configuration) operationId: GetConfig parameters: - $ref: '#/components/parameters/TraceSpan' @@ -8751,18 +8751,18 @@ paths: /api/v2/dashboards: get: description: | - Lists [dashboards](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#dashboard). + Lists [dashboards](https://docs.influxdata.com/influxdb/latest/reference/glossary/#dashboard). #### Related guides - - [Manage dashboards](https://docs.influxdata.com/influxdb/v2.3/visualize-data/dashboards/). + - [Manage dashboards](https://docs.influxdata.com/influxdb/latest/visualize-data/dashboards/). operationId: GetDashboards parameters: - $ref: '#/components/parameters/TraceSpan' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Descending' - - description: A user ID. Only returns [dashboards](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#dashboard) + - description: A user ID. Only returns [dashboards](https://docs.influxdata.com/influxdb/latest/reference/glossary/#dashboard) where the specified user has the `owner` role. in: query name: owner @@ -8779,7 +8779,7 @@ paths: type: string - description: | A list of dashboard IDs. - Returns only the specified [dashboards](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#dashboard). + Returns only the specified [dashboards](https://docs.influxdata.com/influxdb/latest/reference/glossary/#dashboard). If you specify `id` and `owner`, only `id` is used. in: query name: id @@ -8789,16 +8789,16 @@ paths: type: array - description: | An organization ID. - Only returns [dashboards](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#dashboard) that belong to the specified - [organization](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#organization). + Only returns [dashboards](https://docs.influxdata.com/influxdb/latest/reference/glossary/#dashboard) that belong to the specified + [organization](https://docs.influxdata.com/influxdb/latest/reference/glossary/#organization). in: query name: orgID schema: type: string - description: | An organization name. - Only returns [dashboards](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#dashboard) that belong to the specified - [organization](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#organization). + Only returns [dashboards](https://docs.influxdata.com/influxdb/latest/reference/glossary/#dashboard) that belong to the specified + [organization](https://docs.influxdata.com/influxdb/latest/reference/glossary/#organization). in: query name: org schema: @@ -9735,7 +9735,7 @@ paths: - **allocs**: All past memory allocations - **block**: Stack traces that led to blocking on synchronization primitives - **cpu**: (Optional) Program counters sampled from the executing stack. - Include by passing the `cpu` query parameter with a [duration](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#duration) value. + Include by passing the `cpu` query parameter with a [duration](https://docs.influxdata.com/influxdb/latest/reference/glossary/#duration) value. Equivalent to the report from [`GET /debug/pprof/profile?seconds=NUMBER_OF_SECONDS`](#operation/GetDebugPprofProfile). - **goroutine**: All current goroutines - **heap**: Memory allocations for live objects @@ -9745,7 +9745,7 @@ paths: parameters: - $ref: '#/components/parameters/TraceSpan' - description: | - Collects and returns CPU profiling data for the specified [duration](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#duration). + Collects and returns CPU profiling data for the specified [duration](https://docs.influxdata.com/influxdb/latest/reference/glossary/#duration). in: query name: cpu schema: @@ -10506,8 +10506,8 @@ paths: #### Related guides - - [Delete data](https://docs.influxdata.com/influxdb/v2.3/write-data/delete-data/) - - Learn how to use [delete predicate syntax](https://docs.influxdata.com/influxdb/v2.3/reference/syntax/delete-predicate/). + - [Delete data](https://docs.influxdata.com/influxdb/latest/write-data/delete-data/) + - Learn how to use [delete predicate syntax](https://docs.influxdata.com/influxdb/latest/reference/syntax/delete-predicate/). - Learn how InfluxDB handles [deleted tags](https://docs.influxdata.com/flux/v0.x/stdlib/influxdata/influxdb/schema/measurementtagkeys/) and [deleted fields](https://docs.influxdata.com/flux/v0.x/stdlib/influxdata/influxdb/schema/measurementfieldkeys/). operationId: PostDelete @@ -10584,8 +10584,8 @@ paths: #### Related guides - - [Delete data](https://docs.influxdata.com/influxdb/v2.3/write-data/delete-data/) - - Learn how to use [delete predicate syntax](https://docs.influxdata.com/influxdb/v2.3/reference/syntax/delete-predicate/). + - [Delete data](https://docs.influxdata.com/influxdb/latest/write-data/delete-data/) + - Learn how to use [delete predicate syntax](https://docs.influxdata.com/influxdb/latest/reference/syntax/delete-predicate/). required: true responses: "204": @@ -10662,7 +10662,7 @@ paths: 1. Use [token authentication](#section/Authentication/TokenAuthentication) or a [user session](#tag/Signin) with this endpoint to retrieve feature flags and their values. - 2. Follow the instructions to [enable, disable, or override values for feature flags](https://docs.influxdata.com/influxdb/v2.3/influxdb/v2.4/reference/config-options/#feature-flags). + 2. Follow the instructions to [enable, disable, or override values for feature flags](https://docs.influxdata.com/influxdb/latest/influxdb/v2.4/reference/config-options/#feature-flags). 3. **Optional**: To confirm that your change is applied, do one of the following: - Send a request to this endpoint to retrieve the current feature flag values. @@ -10671,7 +10671,7 @@ paths: #### Related guides - - [InfluxDB configuration options](https://docs.influxdata.com/influxdb/v2.3/influxdb/v2.4/reference/config-options/) + - [InfluxDB configuration options](https://docs.influxdata.com/influxdb/latest/influxdb/v2.4/reference/config-options/) operationId: GetFlags parameters: - $ref: '#/components/parameters/TraceSpan' @@ -10898,7 +10898,7 @@ paths: /api/v2/me/password: put: description: | - Updates the password for the signed-in [user](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#user). + Updates the password for the signed-in [user](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user). This endpoint represents the third step in the following three-step process to let a user with a user session update their password: @@ -10930,7 +10930,7 @@ paths: - $ref: '#/components/parameters/TraceSpan' - description: | The user session cookie for the - [user](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#user) + [user](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user) signed in with [Basic authentication credentials](#section/Authentication/BasicAuthentication). #### Related guides @@ -10985,9 +10985,9 @@ paths: #### Related guides - - For the list of metrics categories, see [InfluxDB OSS metrics](https://docs.influxdata.com/influxdb/v2.3/reference/internals/metrics/). - - Learn how to use InfluxDB to [scrape Prometheus metrics](https://docs.influxdata.com/influxdb/v2.3/write-data/developer-tools/scrape-prometheus-metrics/). - - Learn how InfluxDB [parses the Prometheus exposition format](https://docs.influxdata.com/influxdb/v2.3/reference/prometheus-metrics/). + - For the list of metrics categories, see [InfluxDB OSS metrics](https://docs.influxdata.com/influxdb/latest/reference/internals/metrics/). + - Learn how to use InfluxDB to [scrape Prometheus metrics](https://docs.influxdata.com/influxdb/latest/write-data/developer-tools/scrape-prometheus-metrics/). + - Learn how InfluxDB [parses the Prometheus exposition format](https://docs.influxdata.com/influxdb/latest/reference/prometheus-metrics/). operationId: GetMetrics parameters: - $ref: '#/components/parameters/TraceSpan' @@ -11653,7 +11653,7 @@ paths: /api/v2/orgs: get: description: | - Lists [organizations](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#organization/). + Lists [organizations](https://docs.influxdata.com/influxdb/latest/reference/glossary/#organization/). To limit which organizations are returned, pass query parameters in your request. If no query parameters are passed, InfluxDB returns all organizations up to the default `limit`. @@ -11664,7 +11664,7 @@ paths: #### Related guides - - [View organizations](https://docs.influxdata.com/influxdb/v2.3/organizations/view-orgs/) + - [View organizations](https://docs.influxdata.com/influxdb/latest/organizations/view-orgs/) operationId: GetOrgs parameters: - $ref: '#/components/parameters/TraceSpan' @@ -11736,7 +11736,7 @@ paths: - Security and access endpoints post: description: | - Creates an [organization](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#organization) + Creates an [organization](https://docs.influxdata.com/influxdb/latest/reference/glossary/#organization) and returns the newly created organization. #### InfluxDB Cloud @@ -11745,7 +11745,7 @@ paths: #### Related guides - - [Manage organizations](https://docs.influxdata.com/influxdb/v2.3/organizations) + - [Manage organizations](https://docs.influxdata.com/influxdb/latest/organizations) operationId: PostOrgs parameters: - $ref: '#/components/parameters/TraceSpan' @@ -11843,7 +11843,7 @@ paths: #### Related guides - - [Delete organizations](https://docs.influxdata.com/influxdb/v2.3/organizations/delete-orgs/) + - [Delete organizations](https://docs.influxdata.com/influxdb/latest/organizations/delete-orgs/) operationId: DeleteOrgsID parameters: - $ref: '#/components/parameters/TraceSpan' @@ -11902,7 +11902,7 @@ paths: #### Related guides - - [View organizations](https://docs.influxdata.com/influxdb/v2.3/organizations/view-orgs/) + - [View organizations](https://docs.influxdata.com/influxdb/latest/organizations/view-orgs/) operationId: GetOrgsID parameters: - $ref: '#/components/parameters/TraceSpan' @@ -11972,7 +11972,7 @@ paths: #### Related Guides - - [Update an organization](https://docs.influxdata.com/influxdb/v2.3/organizations/update-org/) + - [Update an organization](https://docs.influxdata.com/influxdb/latest/organizations/update-org/) operationId: PatchOrgsID parameters: - $ref: '#/components/parameters/TraceSpan' @@ -12019,10 +12019,10 @@ paths: description: | Lists all users that belong to an organization. - InfluxDB [users](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#user) have + InfluxDB [users](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user) have permission to access InfluxDB. - [Members](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#member) are users + [Members](https://docs.influxdata.com/influxdb/latest/reference/glossary/#member) are users within the organization. #### InfluxDB Cloud @@ -12044,8 +12044,8 @@ paths: #### Related guides - - [Manage users](https://docs.influxdata.com/influxdb/v2.3/users/) - - [Manage members](https://docs.influxdata.com/influxdb/v2.3/organizations/members/) + - [Manage users](https://docs.influxdata.com/influxdb/latest/users/) + - [Manage members](https://docs.influxdata.com/influxdb/latest/organizations/members/) operationId: GetOrgsIDMembers parameters: - $ref: '#/components/parameters/TraceSpan' @@ -12118,10 +12118,10 @@ paths: description: | Add a user to an organization. - InfluxDB [users](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#user) have + InfluxDB [users](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user) have permission to access InfluxDB. - [Members](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#member) are users + [Members](https://docs.influxdata.com/influxdb/latest/reference/glossary/#member) are users within the organization. #### InfluxDB Cloud @@ -12141,8 +12141,8 @@ paths: #### Related guides - - [Manage users](https://docs.influxdata.com/influxdb/v2.3/users/) - - [Manage members](https://docs.influxdata.com/influxdb/v2.3/organizations/members/) + - [Manage users](https://docs.influxdata.com/influxdb/latest/users/) + - [Manage members](https://docs.influxdata.com/influxdb/latest/organizations/members/) operationId: PostOrgsIDMembers parameters: - $ref: '#/components/parameters/TraceSpan' @@ -12241,7 +12241,7 @@ paths: #### Related guides - - [Manage members](https://docs.influxdata.com/influxdb/v2.3/organizations/members/) + - [Manage members](https://docs.influxdata.com/influxdb/latest/organizations/members/) operationId: DeleteOrgsIDMembersID parameters: - $ref: '#/components/parameters/TraceSpan' @@ -12424,7 +12424,7 @@ paths: /api/v2/orgs/{orgID}/owners/{userID}: delete: description: | - Removes an [owner](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#owner) from + Removes an [owner](https://docs.influxdata.com/influxdb/latest/reference/glossary/#owner) from the organization. Organization owners have permission to delete organizations and remove user and member @@ -12615,7 +12615,7 @@ paths: #### Related guides - - [Influx ping](https://docs.influxdata.com/influxdb/v2.3/reference/cli/influx/ping/) + - [Influx ping](https://docs.influxdata.com/influxdb/latest/reference/cli/influx/ping/) operationId: GetPing responses: "204": @@ -12660,7 +12660,7 @@ paths: #### Related guides - - [Influx ping](https://docs.influxdata.com/influxdb/v2.3/reference/cli/influx/ping/) + - [Influx ping](https://docs.influxdata.com/influxdb/latest/reference/cli/influx/ping/) operationId: HeadPing responses: "204": @@ -12704,7 +12704,7 @@ paths: #### Related guides - - [Query with the InfluxDB API](https://docs.influxdata.com/influxdb/v2.3/query-data/execute-queries/influx-api/) + - [Query with the InfluxDB API](https://docs.influxdata.com/influxdb/latest/query-data/execute-queries/influx-api/) - [Get started with Flux](https://docs.influxdata.com/flux/v0.x/get-started/) operationId: PostQuery parameters: @@ -12828,9 +12828,9 @@ paths: description: | #### InfluxDB Cloud: - returns this error if a **read** or **write** request exceeds your - plan's [adjustable service quotas](https://docs.influxdata.com/influxdb/v2.3/account-management/limits/#adjustable-service-quotas) + plan's [adjustable service quotas](https://docs.influxdata.com/influxdb/latest/account-management/limits/#adjustable-service-quotas) or if a **delete** request exceeds the maximum - [global limit](https://docs.influxdata.com/influxdb/v2.3/account-management/limits/#global-limits) + [global limit](https://docs.influxdata.com/influxdb/latest/account-management/limits/#global-limits) - returns `Retry-After` header that describes when to try the write again. #### InfluxDB OSS: @@ -13017,7 +13017,7 @@ paths: post: description: | Analyzes a Flux query and returns a complete package source [Abstract Syntax - Tree (AST)](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#abstract-syntax-tree-ast) + Tree (AST)](https://docs.influxdata.com/influxdb/latest/reference/glossary/#abstract-syntax-tree-ast) for the query. Use this endpoint for deep query analysis such as debugging unexpected query @@ -15211,7 +15211,7 @@ paths: post: description: | Authenticates [Basic authentication credentials](#section/Authentication/BasicAuthentication) - for a [user](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#user), + for a [user](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user), and then, if successful, generates a user session. To authenticate a user, pass the HTTP `Authorization` header with the @@ -15539,12 +15539,12 @@ paths: #### Related guides - - [View InfluxDB stacks](https://docs.influxdata.com/influxdb/v2.3/influxdb-templates/stacks/). + - [View InfluxDB stacks](https://docs.influxdata.com/influxdb/latest/influxdb-templates/stacks/). operationId: ListStacks parameters: - description: | An organization ID. - Only returns stacks owned by the specified [organization](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#organization). + Only returns stacks owned by the specified [organization](https://docs.influxdata.com/influxdb/latest/reference/glossary/#organization). #### InfluxDB Cloud @@ -15659,8 +15659,8 @@ paths: #### Related guides - - [Initialize an InfluxDB stack](https://docs.influxdata.com/influxdb/v2.3/influxdb-templates/stacks/init/). - - [Use InfluxDB templates](https://docs.influxdata.com/influxdb/v2.3/influxdb-templates/use/#apply-templates-to-an-influxdb-instance). + - [Initialize an InfluxDB stack](https://docs.influxdata.com/influxdb/latest/influxdb-templates/stacks/init/). + - [Use InfluxDB templates](https://docs.influxdata.com/influxdb/latest/influxdb-templates/use/#apply-templates-to-an-influxdb-instance). operationId: CreateStack requestBody: content: @@ -15854,20 +15854,20 @@ paths: /api/v2/tasks: get: description: | - Lists [tasks](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task). + Lists [tasks](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task). To limit which tasks are returned, pass query parameters in your request. If no query parameters are passed, InfluxDB returns all tasks up to the default `limit`. #### Related guide - - [Process data with InfluxDB tasks](https://docs.influxdata.com/influxdb/v2.3/process-data/) + - [Process data with InfluxDB tasks](https://docs.influxdata.com/influxdb/latest/process-data/) operationId: GetTasks parameters: - $ref: '#/components/parameters/TraceSpan' - description: | A task name. - Only returns [tasks](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task) + Only returns [tasks](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task) that have the specified name. Different tasks may have the same name. in: query @@ -15876,36 +15876,36 @@ paths: type: string - description: | A task ID. - Only returns [tasks](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task) created after the specified task. + Only returns [tasks](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task) created after the specified task. in: query name: after schema: type: string - description: | A user ID. - Only returns [tasks](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task) - owned by the specified [user](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#user). + Only returns [tasks](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task) + owned by the specified [user](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user). in: query name: user schema: type: string - description: | An organization name. - Only returns tasks owned by the specified [organization](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#organization). + Only returns tasks owned by the specified [organization](https://docs.influxdata.com/influxdb/latest/reference/glossary/#organization). in: query name: org schema: type: string - description: | An organization ID. - Only returns [tasks](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task) owned by the specified [organization](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#organization). + Only returns [tasks](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task) owned by the specified [organization](https://docs.influxdata.com/influxdb/latest/reference/glossary/#organization). in: query name: orgID schema: type: string - description: | A task status. - Only returns [tasks](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task) that have the specified status. + Only returns [tasks](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task) that have the specified status. in: query name: status schema: @@ -15914,7 +15914,7 @@ paths: - inactive type: string - description: | - The maximum number of [tasks](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task) to return. + The maximum number of [tasks](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task) to return. Default is `100`. The minimum is `1` and the maximum is `500`. @@ -15929,7 +15929,7 @@ paths: type: integer - description: | A task type. - Specifies the level of detail for [tasks](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task) in the response. + Specifies the level of detail for [tasks](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task) in the response. Default is `system`. The default (`system`) response contains all the metadata properties for tasks. To reduce the response size, pass `basic` to omit some task properties (`flux`, `createdAt`, `updatedAt`). @@ -16035,16 +16035,16 @@ paths: --header 'Authorization: Token INFLUX_API_TOKEN' post: description: | - Creates a [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task) and returns the task. + Creates a [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task) and returns the task. Use this endpoint to create a scheduled task that runs a script. #### Related guides - - [Get started with tasks](https://docs.influxdata.com/influxdb/v2.3/process-data/get-started/) - - [Create a task](https://docs.influxdata.com/influxdb/v2.3/process-data/manage-tasks/create-task/) - - [Common tasks](https://docs.influxdata.com/influxdb/v2.3/process-data/common-tasks/) - - [Task configuration options](https://docs.influxdata.com/influxdb/v2.3/process-data/task-options/) + - [Get started with tasks](https://docs.influxdata.com/influxdb/latest/process-data/get-started/) + - [Create a task](https://docs.influxdata.com/influxdb/latest/process-data/manage-tasks/create-task/) + - [Common tasks](https://docs.influxdata.com/influxdb/latest/process-data/common-tasks/) + - [Task configuration options](https://docs.influxdata.com/influxdb/latest/process-data/task-options/) operationId: PostTasks parameters: - $ref: '#/components/parameters/TraceSpan' @@ -16112,7 +16112,7 @@ paths: /api/v2/tasks/{taskID}: delete: description: | - Deletes the specified [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task) + Deletes the specified [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task) and all associated records (task runs, logs, and labels). Once the task is deleted, InfluxDB cancels all scheduled runs of the task. @@ -16124,7 +16124,7 @@ paths: - $ref: '#/components/parameters/TraceSpan' - description: | A task ID. - Specifies the [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task) to delete. + Specifies the [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task) to delete. in: path name: taskID required: true @@ -16149,13 +16149,13 @@ paths: - Tasks get: description: | - Retrieves the specified [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task). + Retrieves the specified [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task). operationId: GetTasksID parameters: - $ref: '#/components/parameters/TraceSpan' - description: | A task ID. - Specifies the [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task) to retrieve. + Specifies the [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task) to retrieve. in: path name: taskID required: true @@ -16184,7 +16184,7 @@ paths: - Tasks patch: description: | - Updates the specified [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task), + Updates the specified [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task), and then cancels all scheduled runs of the task. Use this endpoint to set, modify, or clear task properties--for example: `cron`, `name`, `flux`, `status`. @@ -16192,14 +16192,14 @@ paths: #### Related guides - - [Update a task](https://docs.influxdata.com/influxdb/v2.3/process-data/manage-tasks/update-task/) - - [Task configuration options](https://docs.influxdata.com/influxdb/v2.3/process-data/task-options/) + - [Update a task](https://docs.influxdata.com/influxdb/latest/process-data/manage-tasks/update-task/) + - [Task configuration options](https://docs.influxdata.com/influxdb/latest/process-data/task-options/) operationId: PatchTasksID parameters: - $ref: '#/components/parameters/TraceSpan' - description: | A task ID. - Specifies the [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task)to update. + Specifies the [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task)to update. in: path name: taskID required: true @@ -16279,7 +16279,7 @@ paths: - Tasks post: description: | - Adds a label to a [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task). + Adds a label to a [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task). Use this endpoint to add a label to a task. Labels are a way to add metadata to InfluxDB resources. @@ -16290,7 +16290,7 @@ paths: - $ref: '#/components/parameters/TraceSpan' - description: | A task ID. - Specifies the [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task) to label. + Specifies the [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task) to label. in: path name: taskID required: true @@ -16327,13 +16327,13 @@ paths: /api/v2/tasks/{taskID}/labels/{labelID}: delete: description: | - Deletes a label from a [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task). + Deletes a label from a [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task). operationId: DeleteTasksIDLabelsID parameters: - $ref: '#/components/parameters/TraceSpan' - description: | A task ID. - Specifies the [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task) to delete the label from. + Specifies the [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task) to delete the label from. in: path name: taskID required: true @@ -16366,7 +16366,7 @@ paths: /api/v2/tasks/{taskID}/logs: get: description: | - Lists all log events for a [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task). + Lists all log events for a [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task). When a task runs, InfluxDB creates a `run` record in the task’s history. Logs associated with each run provide relevant log messages, timestamps, and the exit status of the `run` attempt. @@ -16376,7 +16376,7 @@ paths: operationId: GetTasksIDLogs parameters: - $ref: '#/components/parameters/TraceSpan' - - description: A task ID. Specifies the [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task) + - description: A task ID. Specifies the [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task) to retrieve logs for. in: path name: taskID @@ -16445,13 +16445,13 @@ paths: **Deprecated**: Tasks don't use `owner` and `member` roles. Use [`/api/v2/authorizations`](#tag/Authorizations) to assign user permissions. - Lists all users that have the `member` role for the specified [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task). + Lists all users that have the `member` role for the specified [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task). operationId: GetTasksIDMembers parameters: - $ref: '#/components/parameters/TraceSpan' - description: | A task ID. - Specifies the [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task) to retrieve members for. + Specifies the [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task) to retrieve members for. in: path name: taskID required: true @@ -16483,13 +16483,13 @@ paths: **Deprecated**: Tasks don't use `owner` and `member` roles. Use [`/api/v2/authorizations`](#tag/Authorizations) to assign user permissions. - Adds a specified user to members of the specified [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task) and then returns + Adds a specified user to members of the specified [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task) and then returns the member. operationId: PostTasksIDMembers parameters: - $ref: '#/components/parameters/TraceSpan' - description: | - A [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task) ID. + A [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task) ID. Specifies the task for the member. in: path name: taskID @@ -16530,7 +16530,7 @@ paths: **Deprecated**: Tasks don't use `owner` and `member` roles. Use [`/api/v2/authorizations`](#tag/Authorizations) to assign user permissions. - Removes a member from a [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task). + Removes a member from a [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task). operationId: DeleteTasksIDMembersID parameters: - $ref: '#/components/parameters/TraceSpan' @@ -16540,7 +16540,7 @@ paths: required: true schema: type: string - - description: A task ID. Specifies the [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task) + - description: A task ID. Specifies the [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task) to remove the member from. in: path name: taskID @@ -16628,7 +16628,7 @@ paths: - $ref: '#/components/parameters/TraceSpan' - description: | A task ID. - Specifies the [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task) for the owner. + Specifies the [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task) for the owner. in: path name: taskID required: true @@ -16695,11 +16695,11 @@ paths: **Deprecated**: Tasks don't use `owner` and `member` roles. Use [`/api/v2/authorizations`](#tag/Authorizations) to assign user permissions. - Removes an owner from a [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task). + Removes an owner from a [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task). operationId: DeleteTasksIDOwnersID parameters: - $ref: '#/components/parameters/TraceSpan' - - description: A user ID. Specifies the owner to remove from the [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task). + - description: A user ID. Specifies the owner to remove from the [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task). in: path name: userID required: true @@ -16707,7 +16707,7 @@ paths: type: string - description: | A task ID. - Specifies the [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task) to remove the owner from. + Specifies the [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task) to remove the owner from. in: path name: taskID required: true @@ -16728,7 +16728,7 @@ paths: /api/v2/tasks/{taskID}/runs: get: description: | - Lists runs for the specified [task](https://docs.influxdata.com/influxdb/v2.3/process-data/). + Lists runs for the specified [task](https://docs.influxdata.com/influxdb/latest/process-data/). To limit which task runs are returned, pass query parameters in your request. If you don't pass query parameters, InfluxDB returns all runs for the task @@ -16738,7 +16738,7 @@ paths: - $ref: '#/components/parameters/TraceSpan' - description: | A task ID. - Specifies the [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task) to + Specifies the [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task) to to list runs for. in: path name: taskID @@ -16761,7 +16761,7 @@ paths: minimum: 1 type: integer - description: | - A timestamp ([RFC3339 date/time format](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#rfc3339-timestamp)). + A timestamp ([RFC3339 date/time format](https://docs.influxdata.com/influxdb/latest/reference/glossary/#rfc3339-timestamp)). Only returns runs scheduled after the specified time. in: query name: afterTime @@ -16769,7 +16769,7 @@ paths: format: date-time type: string - description: | - A timestamp ([RFC3339 date/time format](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#rfc3339-timestamp)). + A timestamp ([RFC3339 date/time format](https://docs.influxdata.com/influxdb/latest/reference/glossary/#rfc3339-timestamp)). Only returns runs scheduled before the specified time. in: query name: beforeTime @@ -16811,7 +16811,7 @@ paths: - $ref: '#/components/parameters/TraceSpan' - description: | A task ID. - Specifies the [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task) to + Specifies the [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task) to to run. in: path name: taskID @@ -16855,7 +16855,7 @@ paths: /api/v2/tasks/{taskID}/runs/{runID}: delete: description: | - Cancels a running [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task). + Cancels a running [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task). Use this endpoint to cancel a running task. @@ -16867,7 +16867,7 @@ paths: - $ref: '#/components/parameters/TraceSpan' - description: | A task ID. - Specifies the [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task) to + Specifies the [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task) to to cancel. in: path name: taskID @@ -16921,7 +16921,7 @@ paths: - Tasks get: description: | - Retrieves the specified run for the specified [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task). + Retrieves the specified run for the specified [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task). Use this endpoint to retrieve detail and logs for a specific task run. operationId: GetTasksIDRunsID @@ -16929,7 +16929,7 @@ paths: - $ref: '#/components/parameters/TraceSpan' - description: | A task ID. - Specifies the [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task) + Specifies the [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task) that the task run belongs to. in: path name: taskID @@ -16994,11 +16994,11 @@ paths: Lists all logs for a task run. A log is a list of run events with `runID`, `time`, and `message` properties. - Use this endpoint to help analyze [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task) performance and troubleshoot failed task runs. + Use this endpoint to help analyze [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task) performance and troubleshoot failed task runs. operationId: GetTasksIDRunsIDLogs parameters: - $ref: '#/components/parameters/TraceSpan' - - description: A task ID. Specifies the [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task) + - description: A task ID. Specifies the [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task) that the run belongs to. in: path name: taskID @@ -17068,7 +17068,7 @@ paths: /api/v2/tasks/{taskID}/runs/{runID}/retry: post: description: | - Queues a [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task) run to + Queues a [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task) run to retry and then returns the scheduled run. To manually start a _new_ task run, use the @@ -17082,7 +17082,7 @@ paths: - $ref: '#/components/parameters/TraceSpan' - description: | A task ID. - Specifies the [task](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task) that the task run belongs to. + Specifies the [task](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task) that the task run belongs to. in: path name: taskID required: true @@ -17616,8 +17616,8 @@ paths: post: description: | Applies a template to - create or update a [stack](https://docs.influxdata.com/influxdb/v2.3/influxdb-templates/stacks/) of InfluxDB - [resources](https://docs.influxdata.com/influxdb/v2.3/reference/cli/influx/export/all/#resources). + create or update a [stack](https://docs.influxdata.com/influxdb/latest/influxdb-templates/stacks/) of InfluxDB + [resources](https://docs.influxdata.com/influxdb/latest/reference/cli/influx/export/all/#resources). The response contains the diff of changes and the stack ID. Use this endpoint to install an InfluxDB template to an organization. @@ -17633,18 +17633,18 @@ paths: #### Custom values for templates - - Some templates may contain [environment references](https://docs.influxdata.com/influxdb/v2.3/influxdb-templates/create/#include-user-definable-resource-names) for custom metadata. + - Some templates may contain [environment references](https://docs.influxdata.com/influxdb/latest/influxdb-templates/create/#include-user-definable-resource-names) for custom metadata. To provide custom values for environment references, pass the _`envRefs`_ property in the request body. For more information and examples, see how to - [define environment references](https://docs.influxdata.com/influxdb/v2.3/influxdb-templates/use/#define-environment-references). + [define environment references](https://docs.influxdata.com/influxdb/latest/influxdb-templates/use/#define-environment-references). - Some templates may contain queries that use - [secrets](https://docs.influxdata.com/influxdb/v2.3/security/secrets/). + [secrets](https://docs.influxdata.com/influxdb/latest/security/secrets/). To provide custom secret values, pass the _`secrets`_ property in the request body. Don't expose secret values in templates. - For more information, see [how to pass secrets when installing a template](https://docs.influxdata.com/influxdb/v2.3/influxdb-templates/use/#pass-secrets-when-installing-a-template). + For more information, see [how to pass secrets when installing a template](https://docs.influxdata.com/influxdb/latest/influxdb-templates/use/#pass-secrets-when-installing-a-template). #### Required permissions @@ -17657,8 +17657,8 @@ paths: #### Related guides - - [Use templates](https://docs.influxdata.com/influxdb/v2.3/influxdb-templates/use/) - - [Stacks](https://docs.influxdata.com/influxdb/v2.3/influxdb-templates/stacks/) + - [Use templates](https://docs.influxdata.com/influxdb/latest/influxdb-templates/use/) + - [Stacks](https://docs.influxdata.com/influxdb/latest/influxdb-templates/stacks/) operationId: ApplyTemplate requestBody: content: @@ -17947,7 +17947,7 @@ paths: /api/v2/users: get: description: | - Lists [users](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#user). + Lists [users](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user). Default limit is `20`. To limit which users are returned, pass query parameters in your request. @@ -17972,14 +17972,14 @@ paths: - $ref: '#/components/parameters/After' - description: | A user name. - Only lists the specified [user](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#user). + Only lists the specified [user](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user). in: query name: name schema: type: string - description: | A user ID. - Only lists the specified [user](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#user). + Only lists the specified [user](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user). in: query name: id schema: @@ -18028,7 +18028,7 @@ paths: - Users post: description: | - Creates a [user](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#user) that can access InfluxDB. + Creates a [user](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user) that can access InfluxDB. Returns the user. Use this endpoint to create a user that can sign in to start a user session @@ -18143,7 +18143,7 @@ paths: /api/v2/users/{userID}: delete: description: | - Deletes a [user](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#user). + Deletes a [user](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user). #### Required permissions @@ -18155,13 +18155,13 @@ paths: #### Related guides - - [Manage users](https://docs.influxdata.com/influxdb/v2.3/organizations/users/) + - [Manage users](https://docs.influxdata.com/influxdb/latest/organizations/users/) operationId: DeleteUsersID parameters: - $ref: '#/components/parameters/TraceSpan' - description: | A user ID. - Specifies the [user](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#user) to delete. + Specifies the [user](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user) to delete. in: path name: userID required: true @@ -18190,17 +18190,17 @@ paths: - Users get: description: | - Retrieves a [user](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#user). + Retrieves a [user](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user). #### Related guides - - [Manage users](https://docs.influxdata.com/influxdb/v2.3/organizations/users/) + - [Manage users](https://docs.influxdata.com/influxdb/latest/organizations/users/) operationId: GetUsersID parameters: - $ref: '#/components/parameters/TraceSpan' - description: | A user ID. - Retrieves the specified [user](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#user). + Retrieves the specified [user](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user). in: path name: userID required: true @@ -18222,7 +18222,7 @@ paths: - Users patch: description: | - Updates a [user](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#user) and returns the user. + Updates a [user](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user) and returns the user. #### Required permissions @@ -18234,13 +18234,13 @@ paths: #### Related guides - - [Manage users](https://docs.influxdata.com/influxdb/v2.3/organizations/users/) + - [Manage users](https://docs.influxdata.com/influxdb/latest/organizations/users/) operationId: PatchUsersID parameters: - $ref: '#/components/parameters/TraceSpan' - description: | A user ID. - Specifies the [user](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#user) to update. + Specifies the [user](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user) to update. in: path name: userID required: true @@ -18690,7 +18690,7 @@ paths: description: | Writes data to a bucket. - Use this endpoint to send data in [line protocol](https://docs.influxdata.com/influxdb/v2.3/reference/syntax/line-protocol/) format to InfluxDB. + Use this endpoint to send data in [line protocol](https://docs.influxdata.com/influxdb/latest/reference/syntax/line-protocol/) format to InfluxDB. #### InfluxDB Cloud @@ -18725,9 +18725,9 @@ paths: #### Related guides - - [Write data with the InfluxDB API](https://docs.influxdata.com/influxdb/v2.3/write-data/developer-tools/api) - - [Optimize writes to InfluxDB](https://docs.influxdata.com/influxdb/v2.3/write-data/best-practices/optimize-writes/) - - [Troubleshoot issues writing data](https://docs.influxdata.com/influxdb/v2.3/write-data/troubleshoot/) + - [Write data with the InfluxDB API](https://docs.influxdata.com/influxdb/latest/write-data/developer-tools/api) + - [Optimize writes to InfluxDB](https://docs.influxdata.com/influxdb/latest/write-data/best-practices/optimize-writes/) + - [Troubleshoot issues writing data](https://docs.influxdata.com/influxdb/latest/write-data/troubleshoot/) operationId: PostWrite parameters: - $ref: '#/components/parameters/TraceSpan' @@ -18783,7 +18783,7 @@ paths: #### Related guides - - [Troubleshoot issues writing data](https://docs.influxdata.com/influxdb/v2.3/write-data/troubleshoot/) + - [Troubleshoot issues writing data](https://docs.influxdata.com/influxdb/latest/write-data/troubleshoot/) in: header name: Accept schema: @@ -18856,7 +18856,7 @@ paths: format: byte type: string description: | - In the request body, provide data in [line protocol format](https://docs.influxdata.com/influxdb/v2.3/reference/syntax/line-protocol/). + In the request body, provide data in [line protocol format](https://docs.influxdata.com/influxdb/latest/reference/syntax/line-protocol/). To send compressed data, do the following: @@ -18866,7 +18866,7 @@ paths: #### Related guides - - [Best practices for optimizing writes](https://docs.influxdata.com/influxdb/v2.3/write-data/best-practices/optimize-writes/) + - [Best practices for optimizing writes](https://docs.influxdata.com/influxdb/latest/write-data/best-practices/optimize-writes/) required: true responses: "204": @@ -18884,7 +18884,7 @@ paths: #### Related guides - - [How to check for write errors](https://docs.influxdata.com/influxdb/v2.3/write-data/troubleshoot/) + - [How to check for write errors](https://docs.influxdata.com/influxdb/latest/write-data/troubleshoot/) "400": content: application/json: @@ -19536,7 +19536,7 @@ tags: - Tokens stop working when the user who created the token is deleted. API tokens are visible to the user who created the authorization and to any - user with an _[operator token](https://docs.influxdata.com/influxdb/v2.3/security/tokens/#operator-token)_. + user with an _[operator token](https://docs.influxdata.com/influxdb/latest/security/tokens/#operator-token)_. In InfluxDB OSS, even if an API token has `read-authorizations` permission, the token can't be used to view its authorization details. @@ -19547,7 +19547,7 @@ tags: Optionally, when creating an authorization, you can scope it to a specific user. If a user signs in with username and password, creating a _user session_, the session carries the permissions granted by all the user's authorizations. - For more information, see [how to assign a token to a specific user](https://docs.influxdata.com/influxdb/v2.3/security/tokens/create-token/). + For more information, see [how to assign a token to a specific user](https://docs.influxdata.com/influxdb/latest/security/tokens/create-token/). To create a user session, use the [`POST /api/v2/signin` endpoint](#operation/PostSignin). ### Related endpoints @@ -19557,21 +19557,21 @@ tags: ### Related guides - - [Authorize API requests](https://docs.influxdata.com/influxdb/v2.3/api-guide/api_intro/#authentication) - - [Manage API tokens](https://docs.influxdata.com/influxdb/v2.3/security/tokens/) - - [Assign a token to a specific user](https://docs.influxdata.com/influxdb/v2.3/security/tokens/create-token/) + - [Authorize API requests](https://docs.influxdata.com/influxdb/latest/api-guide/api_intro/#authentication) + - [Manage API tokens](https://docs.influxdata.com/influxdb/latest/security/tokens/) + - [Assign a token to a specific user](https://docs.influxdata.com/influxdb/latest/security/tokens/create-token/) name: Authorizations - description: | - Store your data in InfluxDB [buckets](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#bucket). + Store your data in InfluxDB [buckets](https://docs.influxdata.com/influxdb/latest/reference/glossary/#bucket). A bucket is a named location where time series data is stored. All buckets - have a [retention period](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#retention-period), + have a [retention period](https://docs.influxdata.com/influxdb/latest/reference/glossary/#retention-period), a duration of time that each data point persists. InfluxDB drops all points with timestamps older than the bucket’s retention period. A bucket belongs to an organization. ### Related guides - - [Manage buckets](https://docs.influxdata.com/influxdb/v2.3/organizations/buckets/) + - [Manage buckets](https://docs.influxdata.com/influxdb/latest/organizations/buckets/) name: Buckets - description: | Generate profiling and trace reports. @@ -19592,7 +19592,7 @@ tags: Delete data from an InfluxDB bucket. name: Delete - description: | - Create and manage your [organizations](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#organization). + Create and manage your [organizations](https://docs.influxdata.com/influxdb/latest/reference/glossary/#organization). An organization is a workspace for a group of users. Organizations can be used to separate different environments, projects, teams or users within InfluxDB. @@ -19603,7 +19603,7 @@ tags: Retrieve data, analyze queries, and get query suggestions. name: Query - description: | - Process and analyze your data with [tasks](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#task) + Process and analyze your data with [tasks](https://docs.influxdata.com/influxdb/latest/reference/glossary/#task) in the InfluxDB task engine. Use the `/api/v2/tasks` endpoints to schedule and manage tasks, retry task runs, and retrieve run logs. @@ -19622,8 +19622,8 @@ tags: #### Related guides - - [Get started with tasks](https://docs.influxdata.com/influxdb/v2.3/process-data/get-started/) - - [Common data processing tasks](https://docs.influxdata.com/influxdb/v2.3/process-data/common-tasks/) + - [Get started with tasks](https://docs.influxdata.com/influxdb/latest/process-data/get-started/) + - [Common data processing tasks](https://docs.influxdata.com/influxdb/latest/process-data/common-tasks/) name: Tasks - description: | Export and apply InfluxDB **templates**. @@ -19646,8 +19646,8 @@ tags: #### Related guides - - [InfluxDB stacks](https://docs.influxdata.com/influxdb/v2.3/influxdb-templates/stacks/) - - [InfluxDB templates](https://docs.influxdata.com/influxdb/v2.3/influxdb-templates/) + - [InfluxDB stacks](https://docs.influxdata.com/influxdb/latest/influxdb-templates/stacks/) + - [InfluxDB templates](https://docs.influxdata.com/influxdb/latest/influxdb-templates/) name: Templates - description: | Manage users for your organization. @@ -19664,11 +19664,11 @@ tags: #### Related guides - - [Manage users](https://docs.influxdata.com/influxdb/v2.3/influxdb/latest/users/) - - [Create a token scoped to a user](https://docs.influxdata.com/influxdb/v2.3/latest/security/tokens/create-token/#create-a-token-scoped-to-a-user) + - [Manage users](https://docs.influxdata.com/influxdb/latest/influxdb/latest/users/) + - [Create a token scoped to a user](https://docs.influxdata.com/influxdb/latest/latest/security/tokens/create-token/#create-a-token-scoped-to-a-user) name: Users - description: | - Write time series data to [buckets](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#bucket). + Write time series data to [buckets](https://docs.influxdata.com/influxdb/latest/reference/glossary/#bucket). name: Write - description: | Use one of the following schemes to authenticate to the InfluxDB API: @@ -19680,10 +19680,10 @@ tags: name: Authentication x-traitTag: true - description: | - See the [**API Quick Start**](https://docs.influxdata.com/influxdb/v2.3/api-guide/api_intro/) + See the [**API Quick Start**](https://docs.influxdata.com/influxdb/latest/api-guide/api_intro/) to get up and running authenticating with tokens, writing to buckets, and querying data. - [**InfluxDB API client libraries**](https://docs.influxdata.com/influxdb/v2.3/api-guide/client-libraries/) + [**InfluxDB API client libraries**](https://docs.influxdata.com/influxdb/latest/api-guide/client-libraries/) are available for popular languages and ready to import into your application. name: Quick start x-traitTag: true @@ -19723,10 +19723,10 @@ tags: | Query parameter | Value type | Description | |:------------------------ |:--------------------- |:-------------------------------------------| - | `bucket` | string | The bucket name or ID ([find your bucket](https://docs.influxdata.com/influxdb/v2.3/organizations/buckets/view-buckets/). | - | `bucketID` | string | The bucket ID ([find your bucket](https://docs.influxdata.com/influxdb/v2.3/organizations/buckets/view-buckets/). | - | `org` | string | The organization name or ID ([find your organization](https://docs.influxdata.com/influxdb/v2.3/organizations/view-orgs/). | - | `orgID` | 16-byte string | The organization ID ([find your organization](https://docs.influxdata.com/influxdb/v2.3/organizations/view-orgs/). | + | `bucket` | string | The bucket name or ID ([find your bucket](https://docs.influxdata.com/influxdb/latest/organizations/buckets/view-buckets/). | + | `bucketID` | string | The bucket ID ([find your bucket](https://docs.influxdata.com/influxdb/latest/organizations/buckets/view-buckets/). | + | `org` | string | The organization name or ID ([find your organization](https://docs.influxdata.com/influxdb/latest/organizations/view-orgs/). | + | `orgID` | 16-byte string | The organization ID ([find your organization](https://docs.influxdata.com/influxdb/latest/organizations/view-orgs/). | name: Common parameters x-traitTag: true - description: | diff --git a/scripts/generate.sh b/scripts/generate.sh index 1f9d54748..d7b227dcd 100755 --- a/scripts/generate.sh +++ b/scripts/generate.sh @@ -2,7 +2,6 @@ CONTRACTS=${CONTRACTS:-contracts} INFLUXDB_DOCS_URL=https://docs.influxdata.com/influxdb -OSS_VERSION=v2.3 mkdir -p $CONTRACTS @@ -14,7 +13,7 @@ sed -e '/#REF_COMMON_PARAMETERS/{r ./src/common/_parameters.yml' -e 'd}' | sed -e '/#REF_COMMON_RESPONSES/{r ./src/common/_responses.yml' -e 'd}' | sed -e '/#REF_COMMON_SCHEMAS/{r ./src/common/_schemas.yml' -e 'd}' > src/.oss_gen.yml && \ swagger-cli bundle src/.oss_gen.yml --type yaml | \ -(sed -e "s|{{% INFLUXDB_DOCS_URL %}}|${INFLUXDB_DOCS_URL}/${OSS_VERSION}|g" > ${CONTRACTS}/oss.yml) && \ +(sed -e "s|{{% INFLUXDB_DOCS_URL %}}|${INFLUXDB_DOCS_URL}/latest|g" > ${CONTRACTS}/oss.yml) && \ swagger-cli bundle ${CONTRACTS}/oss.yml --outfile ${CONTRACTS}/oss.yml --type yaml swagger-cli bundle src/.oss_gen.yml --outfile ${CONTRACTS}/oss.json --type json && \ rm src/.oss_gen.yml @@ -38,7 +37,7 @@ sed -e '/#REF_COMMON_PARAMETERS/{r ./src/common/_parameters.yml' -e 'd}' | sed -e '/#REF_COMMON_RESPONSES/{r ./src/common/_responses.yml' -e 'd}' | sed -e '/#REF_COMMON_SCHEMAS/{r ./src/common/_schemas.yml' -e 'd}' > src/.common_gen.yml && \ swagger-cli bundle src/.common_gen.yml --type yaml | \ -(sed -e "s|{{% INFLUXDB_DOCS_URL %}}|${INFLUXDB_DOCS_URL}/${OSS_VERSION}|g" > ${CONTRACTS}/common.yml) && \ +(sed -e "s|{{% INFLUXDB_DOCS_URL %}}|${INFLUXDB_DOCS_URL}/latest|g" > ${CONTRACTS}/common.yml) && \ swagger-cli bundle ${CONTRACTS}/common.yml --outfile ${CONTRACTS}/common.yml --type yaml rm src/.common_gen.yml