diff --git a/api-docs/cloud-serverless/v2/ref.yml b/api-docs/cloud-serverless/v2/ref.yml new file mode 100644 index 000000000..d8e91b2ab --- /dev/null +++ b/api-docs/cloud-serverless/v2/ref.yml @@ -0,0 +1,14836 @@ +openapi: 3.0.0 +info: + title: InfluxDB Cloud Serverless API Service + description: | + The InfluxDB v2 HTTP API lets you use `/api/v2` endpoints for managing retention policy mappings and writing data stored in an InfluxDB v3 instance. + + This documentation is generated from the + [InfluxDB OpenAPI specification](https://raw.githubusercontent.com/influxdata/openapi/master/contracts/ref/cloud.yml). + license: + name: MIT + url: https://opensource.org/licenses/MIT + version: '' +servers: + - url: https://{baseurl} + description: InfluxDB Cloud Serverless API URL + variables: + baseurl: + enum: + - us-east-1-1.aws.cloud2.influxdata.com + default: us-east-1-1.aws.cloud2.influxdata.com + description: InfluxDB Cloud Serverless URL +security: + - TokenAuthentication: [] +tags: + - description: | + ### Write data + + InfluxDB Cloud Serverless provides the following HTTP API endpoints for writing data: + + - **Recommended**: [`/api/v2/write` endpoint](#operation/PostWrite) + for new write workloads or for bringing existing InfluxDB v2 write workloads to v3. + - [`/write` endpoint](#operation/PostLegacyWrite) for bringing existing InfluxDB v1 write workloads to v3. + + Both endpoints accept the same line protocol format and process data in the same way. + + ### Query data + + InfluxDB Cloud Serverless provides the following protocols for executing a query: + + - **Recommended**: _Flight+gRPC_ request that contains an SQL or InfluxQL query. See how to [get started querying InfluxDB using Flight and SQL](/influxdb/cloud-serverless/get-started/query/). + - HTTP API [`/query` request](/influxdb/cloud-serverless/api/#operation/GetLegacyQuery) that contains an InfluxQL query. + Use this protocol when bringing existing InfluxDB v1 query workloads to v3. + + ### InfluxDB v2 compatibility + + The HTTP API [`/api/v2/write` endpoint](#operation/PostWrite) works with the [`Token` authentication scheme](#section/Authentication/TokenAuthentication) and existing InfluxDB 2.x tools and code for [writing data](/influxdb/cloud-serverless/write-data/). + + See how to [use the InfluxDB v2 HTTP API with InfluxDB Cloud Serverless](/influxdb/cloud-serverless/guides/api-compatibility/v2/). + + ### InfluxDB v1 compatibility + + The HTTP API [`/write` endpoint](#operation/PostLegacyWrite) and [`/query` endpoint](#operation/GetLegacyQuery) work with InfluxDB 1.x username/password [authentication schemes](#section/Authentication/) and existing InfluxDB 1.x tools and code. + + See how to [use the InfluxDB v1 HTTP API with InfluxDB Cloud Serverless](/influxdb/cloud-serverless/guides/api-compatibility/v1/). + name: API compatibility + x-traitTag: true + - description: | + Use one of the following schemes to authenticate to the InfluxDB API: + + - [Token authentication](#section/Authentication/TokenAuthentication) + - [Basic authentication](#section/Authentication/BasicAuthentication) + - [Querystring authentication](#section/Authentication/QuerystringAuthentication) + + name: Authentication + x-traitTag: true + - description: | + Create and manage authorizations (API tokens). + + An _authorization_ contains a list of `read` and `write` + permissions for organization resources and provides an API token for authentication. + An authorization belongs to an organization and only contains permissions for that organization. + + We recommend the following for managing your tokens: + + - Create a generic user to create and manage tokens for writing data. + - Store your tokens in a secure password vault for future access. + + ### User sessions with authorizations + + Optionally, when creating an authorization, you can scope it to a specific user. + If the 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](/influxdb/cloud-serverless/security/tokens/create-token/). + To create a user session, use the [`POST /api/v2/signin` endpoint](#operation/PostSignin). + + ### Related endpoints + + - [Signin](#tag/Signin) + - [Signout](#tag/Signout) + + ### Related guides + + - [Authorize API requests](/influxdb/cloud-serverless/api-guide/api_intro/#authentication) + - [Manage API tokens](/influxdb/cloud-serverless/security/tokens/) + - [Assign a token to a specific user](/influxdb/cloud-serverless/security/tokens/create-token/) + name: Authorizations (API tokens) + - name: Bucket Schemas + - description: | + Store your data in InfluxDB [buckets](/influxdb/cloud-serverless/reference/glossary/#bucket). + A bucket is a named location where time series data is stored. All buckets + have a [retention period](/influxdb/cloud-serverless/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](/influxdb/cloud-serverless/admin/buckets/) + name: Buckets + - name: Cells + - name: Checks + - description: | + To specify resources, some InfluxDB API endpoints require parameters or + properties in the request--for example, + writing to a `bucket` resource in an `org` (_organization_ resource). + + ### Common parameters + + | Query parameter | Value type | Description | + |:------------------------ |:--------------------- |:-------------------------------------------| + | `bucket` | string | The bucket name or ID ([find your bucket](/influxdb/cloud-serverless/admin/buckets/view-buckets/). | + | `bucketID` | string | The bucket ID ([find your bucket](/influxdb/cloud-serverless/admin/buckets/view-buckets/). | + | `org` | string | The organization name or ID ([find your organization](/influxdb/cloud-serverless/organizations/view-orgs/). | + | `orgID` | 16-byte string | The organization ID ([find your organization](/influxdb/cloud-serverless/organizations/view-orgs/). | + name: Common parameters + x-traitTag: true + - name: Config + - name: Dashboards + - name: Data I/O endpoints + - description: | + The InfluxDB 1.x data model includes [databases](/influxdb/v1.8/concepts/glossary/#database) + and [retention policies](/influxdb/v1.8/concepts/glossary/#retention-policy-rp). + InfluxDB 2.x replaces databases and retention policies with buckets. + To support InfluxDB 1.x query and write patterns in InfluxDB 2.x, + databases and retention policies are mapped to buckets using the + database and retention policy (DBRP) mapping service. + The DBRP mapping service uses the database and retention policy + specified in 1.x compatibility API requests to route operations to a bucket. + + ### Related guides + + - [Database and retention policy mapping](/influxdb/cloud-serverless/reference/api/influxdb-1x/dbrp/) + name: DBRPs + - description: | + Delete data from an InfluxDB bucket. + name: Delete + - description: | + InfluxDB HTTP API endpoints use standard HTTP request and response headers. + The following table shows common headers used by many InfluxDB API endpoints. + Some endpoints may use other headers that perform functions more specific to those endpoints--for example, + the `POST /api/v2/write` endpoint accepts the `Content-Encoding` header to indicate the compression applied to line protocol in the request body. + + | Header | Value type | Description | + |:------------------------ |:--------------------- |:-------------------------------------------| + | `Accept` | string | The content type that the client can understand. | + | `Authorization` | string | The authorization scheme and credential. | + | `Content-Length` | integer | The size of the entity-body, in bytes. | + | `Content-Type` | string | The format of the data in the request body. | + name: Headers + x-traitTag: true + - description: | + Store, manage, and execute scripts in InfluxDB. + A script stores your custom Flux script and provides an invokable + endpoint that accepts runtime parameters. + In a script, you can specify custom runtime parameters + (`params`)--for example, `params.myparameter`. + Once you create a script, InfluxDB generates an + [`/api/v2/scripts/SCRIPT_ID/invoke` endpoint](#operation/PostScriptsIDInvoke) + for your organization. + You can run the script from API requests and tasks, defining parameter + values for each run. + When the script runs, InfluxDB replaces `params` references in the + script with the runtime parameter values you define. + + Use the `/api/v2/scripts` endpoints to create and manage scripts. + See related guides to learn how to define parameters and execute scripts. + + + name: Invokable Scripts + - name: Labels + - name: Legacy Authorizations + - name: Limits + - name: NotificationEndpoints + - name: NotificationRules + - description: | + Manage your [organization](/influxdb/cloud-serverless/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. + + Use the `/api/v2/orgs` endpoints to view and manage organizations. + name: Organizations + - description: | + Some InfluxDB API [list operations](#tag/SupportedOperations) may support the following query parameters for paginating results: + + | Query parameter | Value type | Description | + |:------------------------ |:--------------------- |:-------------------------------------------| + | `limit` | integer | The maximum number of records to return (after other parameters are applied). | + | `offset` | integer | The number of records to skip (before `limit`, after other parameters are applied). | + | `after` | string (resource ID) | Only returns resources created after the specified resource. | + + ### Limitations + + - For specific endpoint parameters and examples, see the endpoint definition. + - If you specify an `offset` parameter value greater than the total number of records, + then InfluxDB returns an empty list in the response + (given `offset` skips the specified number of records). + + The following example passes `offset=50` to skip the first 50 results, + but the user only has 10 buckets: + + ```sh + curl --request GET "INFLUX_URL/api/v2/buckets?limit=1&offset=50" \ + --header "Authorization: Token INFLUX_API_TOKEN" + ``` + + The response contains the following: + + ```json + { + "links": { + "prev": "/api/v2/buckets?descending=false\u0026limit=1\u0026offset=49\u0026orgID=ORG_ID", + "self": "/api/v2/buckets?descending=false\u0026limit=1\u0026offset=50\u0026orgID=ORG_ID" + }, + "buckets": [] + } + ``` + name: Pagination + x-traitTag: true + - name: Ping + - description: | + Query data stored in a bucket. + + - HTTP clients can query the v1 [`/query` endpoint](/influxdb/cloud-serverless/api/#operation/GetLegacyQuery) + using **InfluxQL** and retrieve data in **CSV** or **JSON** format. + - _Flight + gRPC_ clients can query using **SQL** or **InfluxQL** and retrieve data in **Arrow** format. + + #### Related guides + + - [Get started querying InfluxDB](/influxdb/cloud-serverless/get-started/query/) + - [Execute queries](/influxdb/cloud-serverless/query-data/execute-queries/) + name: Query + - description: | + See the [**Get started**](/influxdb/cloud-serverless/get-started/) tutorial + to get up and running authenticating with tokens, writing to buckets, and querying data. + + [**InfluxDB API client libraries and Flight clients**](/influxdb/cloud-serverless/reference/client-libraries/) + are available to integrate InfluxDB with your application. + name: Quick start + x-traitTag: true + - name: Resources + - description: | + InfluxDB HTTP API endpoints use standard HTTP status codes for success and failure responses. + The response body may include additional details. + For details about a specific operation's response, + see **Responses** and **Response Samples** for that operation. + + API operations may return the following HTTP status codes: + + |  Code  | Status | Description | + |:-----------:|:------------------------ |:--------------------- | + | `200` | Success | | + | `201` | Created | Successfully created a resource. The response body may contain details, for example [`/write`](#operation/PostLegacyWrite) and [`/api/v2/write`](#operation/PostWrite) response bodies contain details of partial write failures. | + | `204` | No content | The request succeeded. | + | `400` | Bad request | InfluxDB can't parse the request due to an incorrect parameter or bad syntax. For _writes_, the error may indicate one of the following problems: | + | `401` | Unauthorized | May indicate one of the following: | + | `404` | Not found | Requested resource was not found. `message` in the response body provides details about the requested resource. | + | `405` | Method not allowed | The API path doesn't support the HTTP method used in the request--for example, you send a `POST` request to an endpoint that only allows `GET`. | + | `413` | Request entity too large | Request payload exceeds the size limit. | + | `422` | Unprocessable entity | Request data is invalid. `code` and `message` in the response body provide details about the problem. | + | `429` | Too many requests | API token is temporarily over the request quota. The `Retry-After` header describes when to try the request again. | + | `500` | Internal server error | | + | `503` | Service unavailable | Server is temporarily unavailable to process the request. The `Retry-After` header describes when to try the request again. | + name: Response codes + x-traitTag: true + - name: Routes + - name: Rules + - name: Secrets + - name: Security and access endpoints + - name: Setup + - name: Signin + - name: Signout + - description: "The following table shows the most common operations that the InfluxDB `/api/v2` API supports.\nSome resources may support other operations that perform functions more specific to those resources.\nFor example, you can use the `PATCH /api/v2/scripts` endpoint to update properties of a script\nresource.\n\n| Operation | |\n|:----------|:-----------------------------------------------------------------------|\n| Write | Writes (`POST`) data to a bucket. |\n| Run | Executes (`POST`) a query or script and returns the result. |\n| List |\tRetrieves (`GET`) a list of zero or more resources. |\n| Create |\tCreates (`POST`) a new resource and returns the resource. |\n| Update |\tModifies (`PUT`) an existing resource to reflect data in your request. |\n| Delete |\tRemoves (`DELETE`) a specific resource. |\n" + name: Supported operations + x-traitTag: true + - name: System information endpoints + - description: | + Process and analyze your data with tasks + in the InfluxDB task engine. + Use the `/api/v2/tasks` endpoints to schedule and manage tasks, retry task runs, and retrieve run logs. + + To configure a task, provide the script and the schedule to run the task. + For examples, see how to create a task with the [`POST /api/v2/tasks` endpoint](#operation/PostTasks). + + + + ### Properties + + A `task` object contains information about an InfluxDB task resource. + + The following table defines the properties that appear in this object: + + + + + name: Tasks + - name: Telegraf Plugins + - name: Telegrafs + - description: | + Export and apply InfluxDB **templates**. + Manage **stacks** of templated InfluxDB resources. + + InfluxDB templates are prepackaged configurations for resources. + Use InfluxDB templates to configure a fresh instance of InfluxDB, + back up your dashboard configuration, or share your configuration. + + Use the `/api/v2/templates` endpoints to export templates and apply templates. + + **InfluxDB stacks** are stateful InfluxDB templates that let you + add, update, and remove installed template resources over time, avoid duplicating + resources when applying the same or similar templates more than once, and + apply changes to distributed instances of InfluxDB OSS or InfluxDB Cloud. + + Use the `/api/v2/stacks` endpoints to manage installed template resources. + + + name: Templates + - name: Usage + - description: | + Retrieve specific users. + + InfluxDB Cloud lets you invite and collaborate with multiple users in your organization. + To invite and remove users from your organization, use the InfluxDB Cloud user interface (UI); + you can't use the InfluxDB API to manage users in InfluxDB Cloud. + Once a user is added to your organization, you can use the + `GET /api/v2/users` and `GET /api/v2/users/USER_ID` API endpoints to + view specific members. + + ### User sessions with authorizations + + Optionally, you can scope an authorization (and its API token) to a 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. + To create a user session, use the [`POST /api/v2/signin` endpoint](#operation/PostSignin). + + ### Related guides + + - [Manage users](/influxdb/cloud-serverless/organizations/users/) + name: Users + - name: Variables + - name: Views + - description: | + Write time series data to [buckets](/influxdb/cloud-serverless/reference/glossary/#bucket) using InfluxDB v1 or v2 endpoints. + name: Write +paths: + /api/v2: + get: + description: | + Retrieves all the top level routes for the InfluxDB API. + + #### Limitations + + - Only returns top level routes--for example, the response contains + `"tasks":"/api/v2/tasks"`, and doesn't contain resource-specific routes + for tasks (`/api/v2/tasks/TASK_ID/...`). + operationId: GetRoutes + parameters: + - $ref: '#/components/parameters/TraceSpan' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Routes' + description: | + Success. + The response body contains key-value pairs with the resource name and + top-level route. + summary: List all top level routes + tags: + - Routes + - System information endpoints + /api/v2/authorizations: + get: + description: | + Lists authorizations. + + To limit which authorizations are returned, pass query parameters in your request. + If no query parameters are passed, InfluxDB returns all authorizations. + + InfluxDB Cloud Serverless doesn't expose [API token](/influxdb/cloud-serverless/reference/glossary/#token) + values in `GET /api/v2/authorizations` responses; + returns `token: redacted` for all authorizations. + + #### Required permissions + + To retrieve an authorization, the request must use an API token that has the + following permissions: + + - `read-authorizations` + - `read-user` for the user that the authorization is scoped to + + #### Related guides + + - [View tokens](/influxdb/cloud-serverless/security/tokens/view-tokens/) + operationId: GetAuthorizations + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: | + A user ID. + Only returns authorizations scoped to the specified [user](/influxdb/cloud-serverless/reference/glossary/#user). + in: query + name: userID + schema: + type: string + - description: | + A user name. + Only returns authorizations scoped to the specified [user](/influxdb/cloud-serverless/reference/glossary/#user). + in: query + name: user + schema: + type: string + - description: An organization ID. Only returns authorizations that belong to the specified [organization](/influxdb/cloud-serverless/reference/glossary/#organization). + in: query + name: orgID + schema: + type: string + - description: | + An organization name. + Only returns authorizations that belong to the specified [organization](/influxdb/cloud-serverless/reference/glossary/#organization). + in: query + name: org + schema: + type: string + - description: | + An API [token](/influxdb/cloud-serverless/reference/glossary/#token) value. + Specifies an authorization by its `token` property value + and returns the authorization. + + #### InfluxDB OSS + + - Doesn't support this parameter. InfluxDB OSS ignores the `token=` parameter, + applies other parameters, and then returns the result. + + #### Limitations + + - The parameter is non-repeatable. If you specify more than one, + only the first one is used. If a resource with the specified + property value doesn't exist, then the response body contains an empty list. + in: query + name: token + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Authorizations' + description: | + Success. The response body contains a list of authorizations. + + If the response body is missing authorizations that you expect, check that the API + token used in the request has `read-user` permission for the users (`userID` property value) + in those authorizations. + + #### InfluxDB OSS + + - **Warning**: The response body contains authorizations with their + [API token](/influxdb/cloud-serverless/reference/glossary/#token) values in clear text. + - If the request uses an _[operator token](/influxdb/latest/security/tokens/#operator-token)_, + InfluxDB OSS returns authorizations for all organizations in the instance. + '400': + $ref: '#/components/responses/GeneralServerError' + description: Invalid request + '401': + $ref: '#/components/responses/AuthorizationError' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/GeneralServerError' + description: Unexpected error + summary: List authorizations + tags: + - Authorizations (API tokens) + - Security and access endpoints + post: + description: | + Creates an authorization and returns the authorization with the + generated API [token](/influxdb/cloud-serverless/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. + The API token is the authorization's `token` property value. + + To follow best practices for secure API token generation and retrieval, + InfluxDB enforces access restrictions on API tokens. + + - InfluxDB allows access to the API token value immediately after the authorization is created. + - You can’t change access (read/write) permissions for an API token after it’s created. + - Tokens stop working when the user who created the token is deleted. + + We recommend the following for managing your tokens: + + - Create a generic user to create and manage tokens for writing data. + - Store your tokens in a secure password vault for future access. + + #### Required permissions + + - `write-authorizations` + - `write-user` for the user that the authorization is scoped to + + #### Related guides + + - [Create a token](/influxdb/cloud-serverless/security/tokens/create-token/) + operationId: PostAuthorizations + parameters: + - $ref: '#/components/parameters/TraceSpan' + requestBody: + content: + application/json: + examples: + AuthorizationPostRequest: + $ref: '#/components/examples/AuthorizationPostRequest' + AuthorizationWithResourcePostRequest: + $ref: '#/components/examples/AuthorizationWithResourcePostRequest' + AuthorizationWithUserPostRequest: + $ref: '#/components/examples/AuthorizationWithUserPostRequest' + schema: + $ref: '#/components/schemas/AuthorizationPostRequest' + description: The authorization to create. + required: true + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/Authorization' + description: | + Success. The authorization is created. The response body contains the + authorization. + '400': + $ref: '#/components/responses/GeneralServerError' + description: Invalid request + '401': + $ref: '#/components/responses/AuthorizationError' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/GeneralServerError' + description: Unexpected error + summary: Create an authorization + tags: + - Authorizations (API tokens) + - Security and access endpoints + /api/v2/authorizations/{authID}: + delete: + description: | + Deletes an authorization. + + Use the endpoint to delete an API token. + + If you want to disable an API token instead of delete it, + [update the authorization's status to `inactive`](#operation/PatchAuthorizationsID). + operationId: DeleteAuthorizationsID + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: An authorization ID. Specifies the authorization to delete. + in: path + name: authID + required: true + schema: + type: string + responses: + '204': + description: Success. The authorization is deleted. + '400': + content: + application/json: + examples: + notFound: + summary: | + The specified resource ID is invalid. + value: + code: invalid + message: id must have a length of 16 bytes + schema: + $ref: '#/components/schemas/Error' + description: | + Bad request. + '401': + $ref: '#/components/responses/AuthorizationError' + '404': + content: + application/json: + examples: + notFound: + summary: | + The requested authorization doesn't exist. + value: + code: not found + message: authorization not found + schema: + $ref: '#/components/schemas/Error' + description: | + Not found. + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/GeneralServerError' + description: Unexpected error + summary: Delete an authorization + tags: + - Authorizations (API tokens) + - Security and access endpoints + get: + description: | + Retrieves an authorization. + + Use this endpoint to retrieve information about an API token, including + the token's permissions and the user that the token is scoped to. + + #### InfluxDB OSS + + - InfluxDB OSS returns + [API token](/influxdb/cloud-serverless/reference/glossary/#token) values in authorizations. + - If the request uses an _[operator token](/influxdb/latest/security/tokens/#operator-token)_, + InfluxDB OSS returns authorizations for all organizations in the instance. + + #### Related guides + + - [View tokens](/influxdb/cloud-serverless/security/tokens/view-tokens/) + operationId: GetAuthorizationsID + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: An authorization ID. Specifies the authorization to retrieve. + in: path + name: authID + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Authorization' + description: Success. The response body contains the authorization. + '400': + content: + application/json: + examples: + notFound: + summary: | + The specified resource ID is invalid. + value: + code: invalid + message: id must have a length of 16 bytes + schema: + $ref: '#/components/schemas/Error' + description: | + Bad request. + '401': + $ref: '#/components/responses/AuthorizationError' + '404': + content: + application/json: + examples: + notFound: + summary: | + The requested authorization doesn't exist. + value: + code: not found + message: authorization not found + schema: + $ref: '#/components/schemas/Error' + description: | + Not found. + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/GeneralServerError' + description: Unexpected error + summary: Retrieve an authorization + tags: + - Authorizations (API tokens) + - Security and access endpoints + patch: + description: | + Updates an authorization. + + Use this endpoint to set an API token's status to be _active_ or _inactive_. + InfluxDB rejects requests that use inactive API tokens. + operationId: PatchAuthorizationsID + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: An authorization ID. Specifies the authorization to update. + in: path + name: authID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AuthorizationUpdateRequest' + description: In the request body, provide the authorization properties to update. + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Authorization' + description: Success. The response body contains the updated authorization. + default: + $ref: '#/components/responses/GeneralServerError' + description: Unexpected error + summary: Update an API token to be active or inactive + tags: + - Authorizations (API tokens) + - Security and access endpoints + /api/v2/buckets: + get: + description: | + Lists [buckets](/influxdb/cloud-serverless/reference/glossary/#bucket). + + InfluxDB retrieves buckets owned by the + [organization](/influxdb/cloud-serverless/reference/glossary/#organization) + associated with the authorization + ([API token](/influxdb/cloud-serverless/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](/influxdb/cloud-serverless/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 + `org` parameter or the `orgID` parameter to specify the organization. + + #### Required permissions + + | Action | Permission required | + |:--------------------------|:--------------------| + | Retrieve _user buckets_ | `read-buckets` | + | Retrieve [_system buckets_](/influxdb/cloud-serverless/reference/internals/system-buckets/) | `read-orgs` | + + #### Related Guides + + - [Manage buckets](/influxdb/cloud-serverless/admin/buckets/) + operationId: GetBuckets + parameters: + - $ref: '#/components/parameters/TraceSpan' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Limit' + - $ref: '#/components/parameters/After' + - description: | + An organization name. + + #### InfluxDB Cloud Serverless + + - Doesn't use the `org` parameter or `orgID` parameter. + - Lists buckets for the organization associated with the authorization (API token). + in: query + name: org + schema: + type: string + - description: | + An organization ID. + + #### InfluxDB Cloud Serverless + + - Doesn't use the `org` parameter or `orgID` parameter. + - Lists buckets for the organization associated with the authorization (API token). + in: query + name: orgID + schema: + type: string + - description: | + A bucket name. + Only returns buckets with the specified name. + in: query + name: name + schema: + type: string + - description: | + A bucket ID. + Only returns the bucket with the specified ID. + in: query + name: id + schema: + type: string + responses: + '200': + content: + application/json: + examples: + successResponse: + value: + buckets: + - createdAt: '2022-03-15T17:22:33.72617939Z' + description: System bucket for monitoring logs + id: 77ca9dace40a9bfc + labels: [] + links: + labels: /api/v2/buckets/77ca9dace40a9bfc/labels + members: /api/v2/buckets/77ca9dace40a9bfc/members + org: /api/v2/orgs/INFLUX_ORG_ID + owners: /api/v2/buckets/77ca9dace40a9bfc/owners + self: /api/v2/buckets/77ca9dace40a9bfc + write: /api/v2/write?org=ORG_ID&bucket=77ca9dace40a9bfc + name: _monitoring + orgID: INFLUX_ORG_ID + retentionRules: + - everySeconds: 604800 + type: expire + schemaType: implicit + type: system + updatedAt: '2022-03-15T17:22:33.726179487Z' + links: + self: /api/v2/buckets?descending=false&limit=20&name=_monitoring&offset=0&orgID=ORG_ID + schema: + $ref: '#/components/schemas/Buckets' + description: | + Success. + The response body contains a list of `buckets`. + '401': + $ref: '#/components/responses/AuthorizationError' + '500': + $ref: '#/components/responses/InternalServerError' + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: List buckets + tags: + - Buckets + x-codeSamples: + - label: 'cURL: filter buckets by name' + lang: Shell + source: | + curl --request GET "http://localhost:8086/api/v2/buckets?name=_monitoring" \ + --header "Authorization: Token INFLUX_TOKEN" \ + --header "Accept: application/json" \ + --header "Content-Type: application/json" + post: + description: | + Creates a [bucket](/influxdb/cloud-serverless/reference/glossary/#bucket) + and returns the bucket resource. + The default data + [retention period](/influxdb/cloud-serverless/reference/glossary/#retention-period) + is 30 days. + + #### InfluxDB OSS + + - A single InfluxDB OSS instance supports active writes or queries for + approximately 20 buckets across all organizations at a given time. + Reading or writing to more than 20 buckets at a time can adversely affect + performance. + + #### Limitations + + - InfluxDB Cloud Free Plan allows users to create up to two buckets. + Exceeding the bucket quota will result in an HTTP `403` status code. + For additional information regarding InfluxDB Cloud offerings, see + [InfluxDB Cloud Pricing](https://www.influxdata.com/influxdb-cloud-pricing/). + + #### Related Guides + + - [Create a bucket](/influxdb/cloud-serverless/admin/buckets/create-bucket/) + - [Create bucket CLI reference](/influxdb/cloud-serverless/reference/cli/influx/bucket/create) + operationId: PostBuckets + parameters: + - $ref: '#/components/parameters/TraceSpan' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PostBucketRequest' + description: The bucket to create. + required: true + responses: + '201': + content: + application/json: + examples: + successResponse: + value: + createdAt: '2022-08-03T23:04:41.073704121Z' + description: A bucket holding air sensor data + id: 37407e232b3911d8 + labels: [] + links: + labels: /api/v2/buckets/37407e232b3911d8/labels + members: /api/v2/buckets/37407e232b3911d8/members + org: /api/v2/orgs/INFLUX_ORG_ID + owners: /api/v2/buckets/37407e232b3911d8/owners + self: /api/v2/buckets/37407e232b3911d8 + write: /api/v2/write?org=INFLUX_ORG_ID&bucket=37407e232b3911d8 + name: air_sensor + orgID: INFLUX_ORG_ID + retentionRules: + - everySeconds: 2592000 + type: expire + schemaType: implicit + type: user + updatedAt: '2022-08-03T23:04:41.073704228Z' + schema: + $ref: '#/components/schemas/Bucket' + description: | + Success. + The bucket is created. + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: | + Bad request. + '401': + $ref: '#/components/responses/AuthorizationError' + '403': + content: + application/json: + examples: + quotaExceeded: + summary: Bucket quota exceeded + value: + code: forbidden + message: creating bucket would exceed quota + schema: + $ref: '#/components/schemas/Error' + description: | + Forbidden. + The bucket quota is exceeded. + headers: + X-Platform-Error-Code: + description: | + The reason for the error. + schema: + example: forbidden + type: string + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: | + Unprocessable Entity. + The request body failed validation. + '500': + $ref: '#/components/responses/InternalServerError' + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Create a bucket + tags: + - Buckets + x-codeSamples: + - label: 'cURL: create a bucket with retention period' + lang: Shell + source: | + curl --request POST "http://localhost:8086/api/v2/buckets \ + --header "Authorization: Token INFLUX_TOKEN" \ + --header "Accept: application/json" \ + --header "Content-Type: application/json" \ + --data '{ + "name": "air_sensor", + "description": "A bucket holding air sensor data", + "orgID": "INFLUX_ORG_ID", + "retentionRules": [ + { + "type": "expire", + "everySeconds": 2592000, + } + ] + }' + - label: cURL + lang: Shell + source: '' + /api/v2/buckets/{bucketID}: + delete: + description: | + Deletes a bucket and all associated records. + + #### InfluxDB Cloud Serverless + + - Does the following when you send a delete request: + + 1. Validates the request and queues the delete. + 2. Returns an HTTP `204` status code if queued; _error_ otherwise. + 3. Handles the delete asynchronously. + + #### Limitations + + - Only one bucket can be deleted per request. + + #### Related Guides + + - [Manage buckets](/influxdb/cloud-serverless/admin/buckets/) + operationId: DeleteBucketsID + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: | + Bucket ID. + The ID of the bucket to delete. + in: path + name: bucketID + required: true + schema: + type: string + responses: + '204': + description: | + Success. + + #### InfluxDB Cloud Serverless + - The bucket is queued for deletion. + '400': + content: + application/json: + examples: + invalidID: + summary: | + Invalid ID. + value: + code: invalid + message: id must have a length of 16 bytes + schema: + $ref: '#/components/schemas/Error' + description: | + Bad Request. + '401': + $ref: '#/components/responses/AuthorizationError' + '404': + content: + application/json: + examples: + notFound: + summary: | + The requested bucket was not found. + value: + code: not found + message: bucket not found + schema: + $ref: '#/components/schemas/Error' + description: | + Not found. + Bucket not found. + '500': + $ref: '#/components/responses/InternalServerError' + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Delete a bucket + tags: + - Buckets + x-codeSamples: + - label: cURL + lang: Shell + source: | + curl --request DELETE "http://localhost:8086/api/v2/buckets/BUCKET_ID" \ + --header "Authorization: Token INFLUX_TOKEN" \ + --header 'Accept: application/json' + get: + description: | + Retrieves a bucket. + + Use this endpoint to retrieve information for a specific bucket. + operationId: GetBucketsID + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: | + The ID of the bucket to retrieve. + in: path + name: bucketID + required: true + schema: + type: string + responses: + '200': + content: + application/json: + examples: + successResponse: + value: + createdAt: '2022-08-03T23:04:41.073704121Z' + description: bucket for air sensor data + id: 37407e232b3911d8 + labels: [] + links: + labels: /api/v2/buckets/37407e232b3911d8/labels + members: /api/v2/buckets/37407e232b3911d8/members + org: /api/v2/orgs/INFLUX_ORG_ID + owners: /api/v2/buckets/37407e232b3911d8/owners + self: /api/v2/buckets/37407e232b3911d8 + write: /api/v2/write?org=INFLUX_ORG_ID&bucket=37407e232b3911d8 + name: air-sensor + orgID: bea7ea952287f70d + retentionRules: + - everySeconds: 2592000 + type: expire + schemaType: implicit + type: user + updatedAt: '2022-08-03T23:04:41.073704228Z' + schema: + $ref: '#/components/schemas/Bucket' + description: | + Success. + The response body contains the bucket information. + '401': + $ref: '#/components/responses/AuthorizationError' + '404': + content: + application/json: + examples: + notFound: + summary: | + The requested bucket wasn't found. + value: + code: not found + message: bucket not found + schema: + $ref: '#/components/schemas/Error' + description: | + Not found. + Bucket not found. + '500': + $ref: '#/components/responses/InternalServerError' + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Retrieve a bucket + tags: + - Buckets + patch: + description: | + Updates a bucket. + + Use this endpoint to update properties + (`name`, `description`, and `retentionRules`) of a bucket. + + #### InfluxDB Cloud Serverless + + - Requires the `retentionRules` property in the request body. If you don't + provide `retentionRules`, InfluxDB responds with an HTTP `403` status code. + + #### Related Guides + + - [Update a bucket](/influxdb/cloud-serverless/admin/buckets/update-bucket/) + operationId: PatchBucketsID + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The bucket ID. + in: path + name: bucketID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchBucketRequest' + description: The bucket update to apply. + required: true + responses: + '200': + content: + application/json: + examples: + successResponse: + value: + createdAt: '2022-08-03T23:04:41.073704121Z' + description: bucket holding air sensor data + id: 37407e232b3911d8 + labels: [] + links: + labels: /api/v2/buckets/37407e232b3911d8/labels + members: /api/v2/buckets/37407e232b3911d8/members + org: /api/v2/orgs/INFLUX_ORG_ID + owners: /api/v2/buckets/37407e232b3911d8/owners + self: /api/v2/buckets/37407e232b3911d8 + write: /api/v2/write?org=INFLUX_ORG_ID&bucket=37407e232b3911d8 + name: air_sensor + orgID: INFLUX_ORG_ID + retentionRules: + - everySeconds: 2592000 + type: expire + schemaType: implicit + type: user + updatedAt: '2022-08-07T22:49:49.422962913Z' + schema: + $ref: '#/components/schemas/Bucket' + description: An updated bucket + '400': + content: + application/json: + examples: + invalidJSONStringValue: + description: | + If the request body contains invalid JSON, InfluxDB returns `invalid` + with detail about the problem. + summary: Invalid JSON + value: + code: invalid + message: 'invalid json: invalid character ''\'''' looking for beginning of value' + schema: + $ref: '#/components/schemas/Error' + description: | + Bad Request. + '401': + $ref: '#/components/responses/AuthorizationError' + '403': + content: + application/json: + examples: + invalidRetention: + summary: | + The retention policy provided exceeds the max retention for the + organization. + value: + code: forbidden + message: provided retention exceeds orgs maximum retention duration + schema: + $ref: '#/components/schemas/Error' + description: | + Forbidden. + '404': + content: + application/json: + examples: + notFound: + summary: | + The requested bucket wasn't found. + value: + code: not found + message: bucket not found + schema: + $ref: '#/components/schemas/Error' + description: | + Not found. + Bucket not found. + '500': + $ref: '#/components/responses/InternalServerError' + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Update a bucket + tags: + - Buckets + x-codeSamples: + - label: cURL + lang: Shell + source: | + curl --request PATCH "http://localhost:8086/api/v2/buckets/BUCKET_ID \ + --header "Authorization: Token INFLUX_TOKEN" \ + --header "Accept: application/json" \ + --header "Content-Type: application/json" \ + --data '{ + "name": "air_sensor", + "description": "bucket holding air sensor data", + "retentionRules": [ + { + "type": "expire", + "everySeconds": 2592000 + } + ] + }' + /api/v2/buckets/{bucketID}/labels: + get: + description: | + Lists all labels for a bucket. + + Labels are objects that contain `labelID`, `name`, `description`, and `color` + key-value pairs. They may be used for grouping and filtering InfluxDB + resources. + Labels are also capable of grouping across different resources--for example, + you can apply a label named `air_sensor` to a bucket and a task to quickly + organize resources. + + #### Related guides + + - Use the [`/api/v2/labels` InfluxDB API endpoint](#tag/Labels) to retrieve and manage labels. + - [Manage buckets](/influxdb/cloud-serverless/admin/buckets/) + operationId: GetBucketsIDLabels + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: | + The ID of the bucket to retrieve labels for. + in: path + name: bucketID + required: true + schema: + type: string + responses: + '200': + content: + application/json: + examples: + successResponse: + value: + labels: + - id: 09cbd068e7ebb000 + name: production_buckets + orgID: INFLUX_ORG_ID + links: + self: /api/v2/labels + schema: + $ref: '#/components/schemas/LabelsResponse' + description: | + Success. + The response body contains a list of all labels for the bucket. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/AuthorizationError' + '404': + $ref: '#/components/responses/ResourceNotFoundError' + '500': + $ref: '#/components/responses/InternalServerError' + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: List all labels for a bucket + tags: + - Buckets + post: + description: | + Adds a label to a bucket and returns the new label information. + + Labels are objects that contain `labelID`, `name`, `description`, and `color` + key-value pairs. They may be used for grouping and filtering across one or + more kinds of **resources**--for example, you can apply a label named + `air_sensor` to a bucket and a task to quickly organize resources. + + #### Limitations + + - Before adding a label to a bucket, you must create the label if you + haven't already. To create a label with the InfluxDB API, send a `POST` + request to the [`/api/v2/labels` endpoint](#operation/PostLabels)). + + #### Related guides + + - Use the [`/api/v2/labels` InfluxDB API endpoint](#tag/Labels) to retrieve and manage labels. + - [Manage labels in the InfluxDB UI](/influxdb/cloud-serverless/visualize-data/labels/) + operationId: PostBucketsIDLabels + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: | + Bucket ID. + The ID of the bucket to label. + in: path + name: bucketID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LabelMapping' + description: An object that contains a _`labelID`_ to add to the bucket. + required: true + responses: + '201': + content: + application/json: + examples: + successResponse: + value: + label: + id: 09cbd068e7ebb000 + name: production_buckets + orgID: INFLUX_ORG_ID + links: + self: /api/v2/labels + schema: + $ref: '#/components/schemas/LabelResponse' + description: | + Success. + The response body contains the label information. + '400': + $ref: '#/components/responses/BadRequestError' + examples: + invalidRequest: + summary: The `labelID` is missing from the request body. + value: + code: invalid + message: label id is required + '401': + $ref: '#/components/responses/AuthorizationError' + '404': + $ref: '#/components/responses/ResourceNotFoundError' + '422': + content: + application/json: + examples: + conflictingResource: + summary: | + Label already exists on the resource. + value: + code: conflict + message: Cannot add label, label already exists on resource + schema: + $ref: '#/components/schemas/Error' + description: | + Unprocessable entity. + Label already exists on the resource. + '500': + $ref: '#/components/responses/InternalServerError' + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Add a label to a bucket + tags: + - Buckets + x-codeSamples: + - label: cURL + lang: Shell + source: | + curl --request POST "http://localhost:8086/api/v2/buckets/BUCKETS_ID/labels \ + --header "Authorization: Token INFLUX_TOKEN" \ + --header "Accept: application/json" \ + --header "Content-Type: application/json" \ + --data '{ + "labelID": "09cbd068e7ebb000" + }' + /api/v2/buckets/{bucketID}/labels/{labelID}: + delete: + operationId: DeleteBucketsIDLabelsID + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The bucket ID. + in: path + name: bucketID + required: true + schema: + type: string + - description: The ID of the label to delete. + in: path + name: labelID + required: true + schema: + type: string + responses: + '204': + description: Delete has been accepted + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Bucket not found + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Delete a label from a bucket + tags: + - Buckets + /api/v2/buckets/{bucketID}/members: + get: + description: | + Lists all users for a bucket. + + InfluxDB [users](/influxdb/cloud-serverless/reference/glossary/#user) have + permission to access InfluxDB. + + [Members](/influxdb/cloud-serverless/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. + + + operationId: GetBucketsIDMembers + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: | + The ID of the bucket to retrieve users for. + in: path + name: bucketID + required: true + schema: + type: string + responses: + '200': + content: + application/json: + examples: + successResponse: + value: + links: + self: /api/v2/buckets/37407e232b3911d8/members + users: + - id: 791df274afd48a83 + links: + self: /api/v2/users/791df274afd48a83 + name: example_user_1 + role: member + status: active + - id: 09cfb87051cbe000 + links: + self: /api/v2/users/09cfb87051cbe000 + name: example_user_2 + role: owner + status: active + schema: + $ref: '#/components/schemas/ResourceMembers' + description: | + Success. + The response body contains a list of all users for the bucket. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/AuthorizationError' + '404': + $ref: '#/components/responses/ResourceNotFoundError' + '500': + $ref: '#/components/responses/InternalServerError' + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: List all users with member privileges for a bucket + tags: + - Buckets + post: + description: | + Add a user to a bucket and return the new user information. + + InfluxDB [users](/influxdb/cloud-serverless/reference/glossary/#user) have + permission to access InfluxDB. + + [Members](/influxdb/cloud-serverless/reference/glossary/#member) are users in + an organization. + + Use this endpoint to give a user member privileges to a bucket. + + #### Related guides + + - [Manage users](/influxdb/cloud-serverless/users/) + - [Manage members](/influxdb/cloud-serverless/organizations/members/) + operationId: PostBucketsIDMembers + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: | + The ID of the bucket to retrieve users for. + in: path + name: bucketID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AddResourceMemberRequestBody' + description: A user to add as a member to the bucket. + required: true + responses: + '201': + content: + application/json: + examples: + successResponse: + value: + id: 09cfb87051cbe000 + links: + self: /api/v2/users/09cfb87051cbe000 + name: example_user_1 + role: member + status: active + schema: + $ref: '#/components/schemas/ResourceMember' + description: | + Success. + The response body contains the user information. + '400': + $ref: '#/components/responses/BadRequestError' + examples: + invalidRequest: + summary: The user `id` is missing from the request body. + value: + code: invalid + message: user id missing or invalid + '401': + $ref: '#/components/responses/AuthorizationError' + '404': + $ref: '#/components/responses/ResourceNotFoundError' + '500': + $ref: '#/components/responses/InternalServerError' + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Add a member to a bucket + tags: + - Buckets + x-codeSamples: + - label: cURL + lang: Shell + source: | + curl --request POST "http://localhost:8086/api/v2/buckets/BUCKET_ID/members \ + --header "Authorization: Token INFLUX_API_TOKEN" \ + --header "Accept: application/json" \ + --header "Content-Type: application/json" \ + --data '{ + "id": "09cfb87051cbe000" + } + /api/v2/buckets/{bucketID}/members/{userID}: + delete: + description: | + Removes a member from a bucket. + + Use this endpoint to remove a user's member privileges from a bucket. This + removes the user's `read` and `write` permissions for the bucket. + + #### Related guides + + - [Manage users](/influxdb/cloud-serverless/users/) + - [Manage members](/influxdb/cloud-serverless/organizations/members/) + operationId: DeleteBucketsIDMembersID + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: | + The ID of the user to remove. + in: path + name: userID + required: true + schema: + type: string + - description: | + The ID of the bucket to remove a user from. + in: path + name: bucketID + required: true + schema: + type: string + responses: + '204': + description: | + Success. + The user is no longer a member of the bucket. + '401': + $ref: '#/components/responses/AuthorizationError' + '404': + $ref: '#/components/responses/ResourceNotFoundError' + '500': + $ref: '#/components/responses/InternalServerError' + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Remove a member from a bucket + tags: + - Buckets + /api/v2/buckets/{bucketID}/owners: + get: + description: | + Lists all [owners](/influxdb/cloud-serverless/reference/glossary/#owner) + of a bucket. + + Bucket owners have permission to delete buckets and remove user and member + permissions from the bucket. + + InfluxDB Cloud Serverless uses [`/api/v2/authorizations`](#tag/Authorizations-(API-tokens)) to assign resource permissions; doesn't use `owner` and `member` roles. + + + #### Limitations + + - Owner permissions are separate from API token permissions. + - Owner permissions are used in the context of the InfluxDB UI. + + #### Required permissions + + - `read-orgs INFLUX_ORG_ID` + + *`INFLUX_ORG_ID`* is the ID of the organization that you want to retrieve a + list of owners for. + + #### Related endpoints + + - [Authorizations](#tag/Authorizations-(API-tokens)) + operationId: GetBucketsIDOwners + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: | + The ID of the bucket to retrieve owners for. + in: path + name: bucketID + required: true + schema: + type: string + responses: + '200': + content: + application/json: + examples: + successResponse: + value: + links: + self: /api/v2/buckets/BUCKET_ID/owners + users: + - id: d88d182d91b0950f + links: + self: /api/v2/users/d88d182d91b0950f + name: example-owner + role: owner + status: active + schema: + $ref: '#/components/schemas/ResourceOwners' + description: | + Success. + The response body contains a list of all owners for the bucket. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/AuthorizationError' + '404': + $ref: '#/components/responses/ResourceNotFoundError' + '500': + $ref: '#/components/responses/InternalServerError' + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: List all owners of a bucket + tags: + - Buckets + post: + description: | + Adds an owner to a bucket and returns the [owners](/influxdb/cloud-serverless/reference/glossary/#owner) + with role and user detail. + + Use this endpoint to create a _resource owner_ for the bucket. + Bucket owners have permission to delete buckets and remove user and member + permissions from the bucket. + + InfluxDB Cloud Serverless uses [`/api/v2/authorizations`](#tag/Authorizations-(API-tokens)) to assign resource permissions; doesn't use `owner` and `member` roles. + + #### Limitations + + - Owner permissions are separate from API token permissions. + - Owner permissions are used in the context of the InfluxDB UI. + + #### Required permissions + + - `write-orgs INFLUX_ORG_ID` + *`INFLUX_ORG_ID`* is the ID of the organization that you want to add + an owner for. + + #### Related endpoints + + - [Authorizations](#tag/Authorizations-(API-tokens)) + + #### Related guides + + - [Manage users](/influxdb/cloud-serverless/users/) + operationId: PostBucketsIDOwners + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: | + The ID of the bucket to add an owner for. + in: path + name: bucketID + required: true + schema: + type: string + requestBody: + content: + application/json: + examples: + successResponse: + value: + id: d88d182d91b0950f + links: + self: /api/v2/users/d88d182d91b0950f + name: example-user + role: owner + status: active + schema: + $ref: '#/components/schemas/AddResourceMemberRequestBody' + description: A user to add as an owner for the bucket. + required: true + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/ResourceOwner' + description: | + Created. + The bucket `owner` role is assigned to the user. + The response body contains the resource owner with + role and user detail. + '400': + $ref: '#/components/responses/BadRequestError' + examples: + invalidRequest: + summary: The user `id` is missing from the request body. + value: + code: invalid + message: user id missing or invalid + '401': + $ref: '#/components/responses/AuthorizationError' + '404': + $ref: '#/components/responses/ResourceNotFoundError' + '500': + $ref: '#/components/responses/InternalServerError' + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Add an owner to a bucket + tags: + - Buckets + x-codeSamples: + - label: cURL + lang: Shell + source: | + curl --request POST "http://localhost:8086/api/v2/buckets/BUCKET_ID/owners \ + --header "Authorization: Token INFLUX_API_TOKEN" \ + --header "Accept: application/json" \ + --header "Content-Type: application/json" \ + --data '{ + "id": "09cfb87051cbe000" + } + /api/v2/buckets/{bucketID}/owners/{userID}: + delete: + description: | + Removes an owner from a bucket. + + Use this endpoint to remove a user's `owner` role for a bucket. + + InfluxDB Cloud Serverless uses [`/api/v2/authorizations`](#tag/Authorizations-(API-tokens)) to assign resource permissions; doesn't use `owner` and `member` roles. + + #### Limitations + + - Owner permissions are separate from API token permissions. + - Owner permissions are used in the context of the InfluxDB UI. + + #### Required permissions + + - `write-orgs INFLUX_ORG_ID` + + *`INFLUX_ORG_ID`* is the ID of the organization that you want to remove an owner + from. + + #### Related endpoints + + - [Authorizations](#tag/Authorizations-(API-tokens)) + + #### Related guides + + - [Manage users](/influxdb/cloud-serverless/users/) + operationId: DeleteBucketsIDOwnersID + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: | + The ID of the owner to remove. + in: path + name: userID + required: true + schema: + type: string + - description: | + The ID of the bucket to remove an owner from. + in: path + name: bucketID + required: true + schema: + type: string + responses: + '204': + description: | + Success. + The user is no longer an owner of the bucket. + '401': + $ref: '#/components/responses/AuthorizationError' + '404': + $ref: '#/components/responses/ResourceNotFoundError' + '500': + $ref: '#/components/responses/InternalServerError' + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Remove an owner from a bucket + tags: + - Buckets + /api/v2/buckets/{bucketID}/schema/measurements: + get: + description: | + Lists _explicit_ + [schemas](/influxdb/cloud-serverless/reference/glossary/#schema) + (`"schemaType": "explicit"`) for a bucket. + + _Explicit_ schemas are used to enforce column names, tags, fields, and data + types for your data. + + By default, buckets have an _implicit_ schema-type (`"schemaType": "implicit"`) + that conforms to your data. + + #### Related guides + + - [Using bucket schemas](https://www.influxdata.com/blog/new-bucket-schema-option-protect-from-unwanted-schema-changes/) + operationId: getMeasurementSchemas + parameters: + - description: | + An organization name. + Specifies the organization that owns the schema. + in: query + name: org + schema: + type: string + - description: | + An organization ID. + Specifies the organization that owns the schema. + in: query + name: orgID + schema: + type: string + - description: | + A measurement name. + Only returns measurement schemas with the specified name. + in: query + name: name + schema: + type: string + - description: | + A bucket ID. + Lists measurement schemas for the specified bucket. + in: path + name: bucketID + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/MeasurementSchemaList' + description: A list of measurement schemas returning summary information. + headers: + ETag: + description: The current version of the bucket schema + schema: + type: string + '400': + content: + application/json: + examples: + invalidSchemaType: + summary: Invalid schema type. + value: + code: invalid + message: bucket schemaType must be explicit + schema: + $ref: '#/components/schemas/Error' + description: | + Bad request. + '401': + $ref: '#/components/responses/AuthorizationError' + '404': + $ref: '#/components/responses/ResourceNotFoundError' + '500': + $ref: '#/components/responses/InternalServerError' + summary: List measurement schemas of a bucket + tags: + - Bucket Schemas + post: + description: | + Creates an _explicit_ measurement [schema](/influxdb/cloud-serverless/reference/glossary/#schema) + for a bucket. + + _Explicit_ schemas are used to enforce column names, tags, fields, and data + types for your data. + + By default, buckets have an _implicit_ schema-type (`"schemaType": "implicit"`) + that conforms to your data. + + Use this endpoint to create schemas that prevent non-conforming write requests. + + #### Limitations + + - Buckets must be created with the "explicit" `schemaType` in order to use + schemas. + + + operationId: createMeasurementSchema + parameters: + - description: | + An organization name. + Specifies the organization that owns the schema. + in: query + name: org + schema: + type: string + - description: | + An organization ID. + Specifies the organization that owns the schema. + in: query + name: orgID + schema: + type: string + - description: | + A bucket ID. + Adds a schema for the specified bucket. + in: path + name: bucketID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MeasurementSchemaCreateRequest' + required: true + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/MeasurementSchema' + description: The current version of the measurement schema. + headers: + ETag: + description: The current version of the measurement schema + schema: + type: string + '400': + content: + application/json: + examples: + badNameExample: + description: The error returned when the name is invalid, such as too few or too many characters or the name contains non-printable ASCII or is not valid UTF-8. + summary: Invalid name + value: + code: invalid + message: name is invalid + duplicateColumnNamesExample: + description: The error returned when the request body contains duplicate column names. + summary: Duplicate column names + value: + code: invalid + message: Duplicate column names + missingColumnsExample: + description: The error returned when the request body is missing the columns property. + summary: Missing columns + value: + code: invalid + message: columns is required + missingFieldExample: + description: The error returned when the request body is missing at least one field type column. + summary: Missing field + value: + code: invalid + message: At least one field column is required + missingTimestampExample: + description: The error returned when the request body is missing a timestamp type column. + summary: Missing timestamp + value: + code: invalid + message: Timestamp column is required + schema: + $ref: '#/components/schemas/Error' + description: | + Bad request. + '401': + $ref: '#/components/responses/AuthorizationError' + '404': + $ref: '#/components/responses/ResourceNotFoundError' + '500': + $ref: '#/components/responses/InternalServerError' + summary: Create a measurement schema for a bucket + tags: + - Bucket Schemas + x-codeSamples: + - label: cURL + lang: Shell + source: | + curl --request POST "INFLUX_URL/api/v2/buckets/BUCKET_ID/schema/measurements \ + --header "Authorization: Token INFLUX_API_TOKEN" \ + --header "Accept: application/json" \ + --header "Content-Type: application/json" \ + --data '{ + "name": "temperature", + "column": [ + { + "type": "tag", + "name": "location" + }, + { + "type": "field", + "name": "value", + "dataType": "float" + }, + { + "type": "timestamp", + "name": "time" + } + ] + }' + summary: Bucket schemas + /api/v2/buckets/{bucketID}/schema/measurements/{measurementID}: + get: + description: | + Retrieves an explicit measurement [schema](/influxdb/cloud-serverless/reference/glossary/#schema). + operationId: getMeasurementSchema + parameters: + - description: | + Organization name. + Specifies the organization that owns the schema. + in: query + name: org + schema: + type: string + - description: | + Organization ID. + Specifies the organization that owns the schema. + in: query + name: orgID + schema: + type: string + - description: | + A bucket ID. + Retrieves schemas for the specified bucket. + in: path + name: bucketID + required: true + schema: + type: string + - description: | + The measurement schema ID. + Specifies the measurement schema to retrieve. + in: path + name: measurementID + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/MeasurementSchema' + description: Schema definition for a single measurement + headers: + ETag: + description: The current version of the measurement schema + schema: + type: string + '401': + $ref: '#/components/responses/AuthorizationError' + '404': + $ref: '#/components/responses/ResourceNotFoundError' + '500': + $ref: '#/components/responses/InternalServerError' + summary: Retrieve a measurement schema + tags: + - Bucket Schemas + patch: + description: | + Updates a measurement [schema](/influxdb/cloud-serverless/reference/glossary/#schema). + + Use this endpoint to update the fields (`name`, `type`, and `dataType`) of a + measurement schema. + + #### Limitations + + - You can't update the `name` of a measurement. + + #### Related guides + + - [Manage bucket schemas](/influxdb/cloud-serverless/admin/buckets/bucket-schema/). + - [Using bucket schemas](https://www.influxdata.com/blog/new-bucket-schema-option-protect-from-unwanted-schema-changes/). + operationId: updateMeasurementSchema + parameters: + - description: | + An organization name. + Specifies the organization that owns the schema. + in: query + name: org + schema: + type: string + - description: | + An organization ID. + Specifies the organization that owns the schema. + in: query + name: orgID + schema: + type: string + - description: | + A bucket ID. + Specifies the bucket to retrieve schemas for. + in: path + name: bucketID + required: true + schema: + type: string + - description: | + A measurement schema ID. + Retrieves the specified measurement schema. + in: path + name: measurementID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MeasurementSchemaUpdateRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/MeasurementSchema' + description: | + Success. + The response body contains the measurement schema. + '400': + content: + application/json: + examples: + missingColumnsExample: + description: The error returned when the request body does not contain all the columns from the source. + summary: Deleted columns + value: + code: invalid + message: Unable to delete columns from schema + schema: + $ref: '#/components/schemas/Error' + description: | + Bad request. + '401': + $ref: '#/components/responses/AuthorizationError' + '404': + $ref: '#/components/responses/ResourceNotFoundError' + '500': + $ref: '#/components/responses/InternalServerError' + summary: Update a measurement schema + tags: + - Bucket Schemas + x-codeSamples: + - label: cURL + lang: Shell + source: | + curl --request PATCH "INFLUX_URL/api/v2/buckets/BUCKET_ID/schema/measurements \ + --header "Authorization: Token INFLUX_API_TOKEN" \ + --header "Accept: application/json" \ + --header "Content-Type: application/json" \ + --data '{ + "column": [ + { + "type": "tag", + "name": "location" + }, + { + "type": "field", + "name": "value", + "dataType": "float" + }, + { + "type": "timestamp", + "name": "time" + } + ] + }' + summary: Bucket Schema + /api/v2/checks: {} + /api/v2/checks/{checkID}: {} + /api/v2/checks/{checkID}/labels: {} + /api/v2/checks/{checkID}/labels/{labelID}: {} + /api/v2/checks/{checkID}/query: {} + /api/v2/dashboards: {} + /api/v2/dashboards/{dashboardID}: {} + /api/v2/dashboards/{dashboardID}/cells: {} + /api/v2/dashboards/{dashboardID}/cells/{cellID}: {} + /api/v2/dashboards/{dashboardID}/cells/{cellID}/view: {} + /api/v2/dashboards/{dashboardID}/labels: {} + /api/v2/dashboards/{dashboardID}/labels/{labelID}: {} + /api/v2/dashboards/{dashboardID}/members: {} + /api/v2/dashboards/{dashboardID}/members/{userID}: {} + /api/v2/dashboards/{dashboardID}/owners: {} + /api/v2/dashboards/{dashboardID}/owners/{userID}: {} + /api/v2/dbrps: + get: + description: | + Lists database retention policy (DBRP) mappings. + + #### Related guide + + - [Database and retention policy mapping](/influxdb/cloud-serverless/reference/api/influxdb-1x/dbrp/) + operationId: GetDBRPs + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: | + An organization ID. + Only returns DBRP mappings for the specified organization. + in: query + name: orgID + schema: + type: string + - description: | + An organization name. + Only returns DBRP mappings for the specified organization. + in: query + name: org + schema: + type: string + - description: | + A DBPR mapping ID. + Only returns the specified DBRP mapping. + in: query + name: id + schema: + type: string + - description: | + A bucket ID. + Only returns DBRP mappings that belong to the specified bucket. + in: query + name: bucketID + schema: + type: string + - description: Specifies filtering on default + in: query + name: default + schema: + type: boolean + - description: | + A database. + Only returns DBRP mappings that belong to the 1.x database. + in: query + name: db + schema: + type: string + - description: | + A [retention policy](/influxdb/v1.8/concepts/glossary/#retention-policy-rp). + Specifies the 1.x retention policy to filter on. + in: query + name: rp + schema: + type: string + responses: + '200': + content: + application/json: + examples: + successResponse: + value: + content: + - bucketID: 4d4d9d5b61dee751 + database: example_database_1 + default: true + id: 0a3cbb5dd526a000 + orgID: bea7ea952287f70d + retention_policy: autogen + - bucketID: 4d4d9d5b61dee751 + database: example_database_2 + default: false + id: 0a3cbcde20e38000 + orgID: bea7ea952287f70d + retention_policy: example_retention_policy + schema: + $ref: '#/components/schemas/DBRPs' + description: Success. The response body contains a list of database retention policy mappings. + '400': + content: + application/json: + examples: + invalidRequest: + description: | + The query parameters contain invalid values. + value: + code: invalid + message: invalid ID + schema: + $ref: '#/components/schemas/Error' + description: Bad request. The request has one or more invalid parameters. + '401': + $ref: '#/components/responses/AuthorizationError' + '500': + $ref: '#/components/responses/InternalServerError' + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: List database retention policy mappings + tags: + - DBRPs + post: + description: | + Creates a database retention policy (DBRP) mapping and returns the mapping. + + Use this endpoint to add InfluxDB 1.x API compatibility to your + InfluxDB Cloud or InfluxDB OSS 2.x buckets. Your buckets must contain a + DBRP mapping in order to query and write using the InfluxDB 1.x API. + object. + + #### Related guide + + - [Database and retention policy mapping](/influxdb/cloud-serverless/reference/api/influxdb-1x/dbrp/) + operationId: PostDBRP + parameters: + - $ref: '#/components/parameters/TraceSpan' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DBRPCreate' + description: | + The database retention policy mapping to add. + + Note that _`retention_policy`_ is a required parameter in the request body. + The value of _`retention_policy`_ can be any arbitrary `string` name or + value, with the default value commonly set as `autogen`. + The value of _`retention_policy`_ isn't a [retention_policy](/influxdb/cloud-serverless/reference/glossary/#retention-policy-rp) + required: true + responses: + '201': + content: + application/json: + examples: + successResponse: + value: + bucketID: 4d4d9d5b61dee751 + database: example_database + default: true + id: 0a3cbb5dd526a000 + orgID: bea7ea952287f70d + retention_policy: autogen + schema: + $ref: '#/components/schemas/DBRP' + description: Created. The response body contains the database retention policy mapping. + '400': + content: + application/json: + examples: + invalidRequest: + description: | + The query parameters contain invalid values. + value: + code: invalid + message: invalid ID + schema: + $ref: '#/components/schemas/Error' + description: Bad request. The mapping in the request has one or more invalid IDs. + '401': + $ref: '#/components/responses/AuthorizationError' + '404': + $ref: '#/components/responses/ResourceNotFoundError' + '500': + $ref: '#/components/responses/InternalServerError' + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Add a database retention policy mapping + tags: + - DBRPs + x-codeSamples: + - label: 'cURL: create a database retention policy mapping' + lang: Shell + source: | + curl --request POST \ + "http://localhost:8086/api/v2/dbrp/" \ + --header 'Content-type: application/json' \ + --header "Authorization: Token INFLUXDB_TOKEN" \ + --data-binary @- << EOF + { \ + "bucketID": "INFLUXDB_BUCKET_ID", \ + "orgID": "INFLUXDB_ORG_ID", \ + "database": "database_name", \ + "default": true, \ + "retention_policy": "example_retention_policy_name" \ + } + EOF + /api/v2/dbrps/{dbrpID}: + delete: + description: | + Deletes the specified database retention policy (DBRP) mapping. + + #### Related guide + + - [Database and retention policy mapping](/influxdb/cloud-serverless/reference/api/influxdb-1x/dbrp/) + operationId: DeleteDBRPID + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: | + An organization ID. + Specifies the organization that owns the DBRP mapping. + in: query + name: orgID + schema: + type: string + - description: | + An organization name. + Specifies the organization that owns the DBRP mapping. + in: query + name: org + schema: + type: string + - description: | + A DBRP mapping ID. + Only returns the specified DBRP mapping. + in: path + name: dbrpID + required: true + schema: + type: string + responses: + '204': + description: Success. The delete is accepted. + '400': + content: + application/json: + examples: + invalidRequest: + description: | + The query parameters contain invalid values. + value: + code: invalid + message: invalid ID + schema: + $ref: '#/components/schemas/Error' + description: Bad Request. Query parameters contain invalid values. + '401': + $ref: '#/components/responses/AuthorizationError' + '404': + $ref: '#/components/responses/ResourceNotFoundError' + '500': + $ref: '#/components/responses/InternalServerError' + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Delete a database retention policy + tags: + - DBRPs + get: + description: | + Retrieves the specified retention policy (DBRP) mapping. + + #### Related guide + + - [Database and retention policy mapping](/influxdb/cloud-serverless/reference/api/influxdb-1x/dbrp/) + operationId: GetDBRPsID + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: | + An organization ID. + Specifies the organization that owns the DBRP mapping. + in: query + name: orgID + schema: + type: string + - description: | + An organization name. + Specifies the organization that owns the DBRP mapping. + in: query + name: org + schema: + type: string + - description: | + A DBRP mapping ID. + Specifies the DBRP mapping. + in: path + name: dbrpID + required: true + schema: + type: string + responses: + '200': + content: + application/json: + examples: + successResponse: + value: + content: + bucketID: 4d4d9d5b61dee751 + database: example_database_1 + default: true + id: 0a3cbb5dd526a000 + orgID: bea7ea952287f70d + retention_policy: autogen + schema: + $ref: '#/components/schemas/DBRPGet' + description: Success. The response body contains the DBRP mapping. + '400': + content: + application/json: + examples: + invalidRequest: + description: | + The query parameters contain invalid values. + value: + code: invalid + message: invalid ID + schema: + $ref: '#/components/schemas/Error' + description: Bad Request. Query parameters contain invalid values. + '401': + $ref: '#/components/responses/AuthorizationError' + '404': + $ref: '#/components/responses/ResourceNotFoundError' + '500': + $ref: '#/components/responses/InternalServerError' + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Retrieve a database retention policy mapping + tags: + - DBRPs + patch: + operationId: PatchDBRPID + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: | + An organization ID. + Specifies the organization that owns the DBRP mapping. + in: query + name: orgID + schema: + type: string + - description: | + An organization name. + Specifies the organization that owns the DBRP mapping. + in: query + name: org + schema: + type: string + - description: | + A DBRP mapping ID. + Specifies the DBRP mapping. + in: path + name: dbrpID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DBRPUpdate' + description: | + Updates the database retention policy (DBRP) mapping and returns the mapping. + + Use this endpoint to modify the _retention policy_ (`retention_policy` property) of a DBRP mapping. + + #### Related guide + + - [Database and retention policy mapping](/influxdb/cloud-serverless/reference/api/influxdb-1x/dbrp/) + required: true + responses: + '200': + content: + application/json: + examples: + successResponse: + value: + content: + bucketID: 4d4d9d5b61dee751 + database: example_database + default: false + id: 0a3cbb5dd526a000 + orgID: bea7ea952287f70d + retention_policy: example_retention_policy + schema: + $ref: '#/components/schemas/DBRPGet' + description: An updated mapping + '400': + content: + application/json: + examples: + invalidRequest: + description: | + The query parameters contain invalid values. + value: + code: invalid + message: invalid ID + schema: + $ref: '#/components/schemas/Error' + description: Bad Request. Query parameters contain invalid values. + '401': + $ref: '#/components/responses/AuthorizationError' + '404': + $ref: '#/components/responses/ResourceNotFoundError' + '500': + $ref: '#/components/responses/InternalServerError' + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Update a database retention policy mapping + tags: + - DBRPs + x-codeSamples: + - label: 'cURL: Update a DBRP mapping' + lang: Shell + source: | + curl --request PATCH \ + "http://localhost:8086/api/v2/dbrp/DBRP_ID" \ + --header 'Content-type: application/json' \ + --header "Authorization: Token INFLUX_API_TOKEN" \ + --data-binary @- << EOF + { + "default": true, + "retention_policy": "example_retention_policy_name" + } + EOF + /api/v2/delete: + post: + description: | + Deletes data from a bucket. + + **NOTE**: This endpoint has been **disabled** for InfluxDB Cloud Serverless organizations. + See how to [**delete data**](/influxdb/cloud-serverless/write-data/delete-data/). + + #### Related guides + + - [Delete data](/influxdb/cloud-serverless/write-data/delete-data/) + operationId: PostDelete + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: | + An organization name or ID. + + #### InfluxDB Cloud Serverless + + - Doesn't use the `org` parameter or `orgID` parameter. + in: query + name: org + schema: + description: The organization name or ID. + type: string + - description: | + A bucket name or ID. + Specifies the bucket to delete data from. + If you pass both `bucket` and `bucketID`, `bucketID` takes precedence. + in: query + name: bucket + schema: + description: The bucket name or ID. + type: string + - description: | + An organization ID. + + #### InfluxDB Cloud Serverless + + - Doesn't use the `org` parameter or `orgID` parameter. + in: query + name: orgID + schema: + description: The organization ID. + type: string + - description: | + A bucket ID. + Specifies the bucket to delete data from. + If you pass both `bucket` and `bucketID`, `bucketID` takes precedence. + in: query + name: bucketID + schema: + description: The bucket ID. + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DeletePredicateRequest' + description: | + Time range parameters and an optional **delete predicate expression**. + + To select points to delete within the specified time range, pass a + **delete predicate expression** in the `predicate` property of the request body. + If you don't pass a `predicate`, InfluxDB deletes all data with timestamps + in the specified time range. + required: true + responses: + '204': + description: | + **NOTE**: This endpoint has been **disabled** for InfluxDB Cloud Serverless organizations. + See how to [**delete data**](/influxdb/cloud-serverless/write-data/delete-data/). + '400': + content: + application/json: + examples: + orgNotFound: + summary: Organization not found + value: + code: invalid + message: 'failed to decode request body: organization not found' + schema: + $ref: '#/components/schemas/Error' + description: | + Bad request. + The response body contains detail about the error. + + #### InfluxDB OSS + + - Returns this error if the `org` parameter or `orgID` parameter doesn't match an organization. + '401': + $ref: '#/components/responses/AuthorizationError' + '404': + $ref: '#/components/responses/ResourceNotFoundError' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/GeneralServerError' + summary: Delete data + tags: + - Delete + /api/v2/flags: {} + /api/v2/labels: {} + /api/v2/labels/{labelID}: {} + /api/v2/maps/mapToken: + get: + operationId: getMapboxToken + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Token' + description: Temporary token for Mapbox. + '401': + $ref: '#/components/responses/ServerError' + '500': + $ref: '#/components/responses/ServerError' + default: + $ref: '#/components/responses/ServerError' + summary: Get a mapbox token + /api/v2/me: {} + /api/v2/me/password: {} + /api/v2/notificationEndpoints: {} + /api/v2/notificationEndpoints/{endpointID}: {} + /api/v2/notificationEndpoints/{endpointID}/labels: {} + /api/v2/notificationEndpoints/{endpointID}/labels/{labelID}: {} + /api/v2/notificationRules: {} + /api/v2/notificationRules/{ruleID}: {} + /api/v2/notificationRules/{ruleID}/labels: {} + /api/v2/notificationRules/{ruleID}/labels/{labelID}: {} + /api/v2/notificationRules/{ruleID}/query: {} + /api/v2/orgs: + get: + description: | + Lists [organizations](/influxdb/cloud-serverless/reference/glossary/#organization/). + + InfluxDB Cloud Serverless only returns the organization that owns the token passed in the request. + + #### Related guides + + - [View organizations](/influxdb/cloud-serverless/organizations/view-orgs/) + operationId: GetOrgs + parameters: + - $ref: '#/components/parameters/TraceSpan' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Limit' + - $ref: '#/components/parameters/Descending' + - description: | + An organization name. + Only returns the specified organization. + in: query + name: org + schema: + type: string + - description: | + An organization ID. + Only returns the specified organization. + in: query + name: orgID + schema: + type: string + - description: | + A user ID. + Only returns organizations where the specified user is a member or owner. + in: query + name: userID + schema: + type: string + responses: + '200': + content: + application/json: + examples: + successResponse: + value: + links: + self: /api/v2/orgs + orgs: + - createdAt: '2022-07-17T23:00:30.778487Z' + description: Example InfluxDB organization + id: INFLUX_ORG_ID + links: + buckets: /api/v2/buckets?org=INFLUX_ORG + dashboards: /api/v2/dashboards?org=INFLUX_ORG + labels: /api/v2/orgs/INFLUX_ORG_ID/labels + logs: /api/v2/orgs/INFLUX_ORG_ID/logs + members: /api/v2/orgs/INFLUX_ORG_ID/members + owners: /api/v2/orgs/INFLUX_ORG_ID/owners + secrets: /api/v2/orgs/INFLUX_ORG_ID/secrets + self: /api/v2/orgs/INFLUX_ORG_ID + tasks: /api/v2/tasks?org=InfluxData + name: INFLUX_ORG + updatedAt: '2022-07-17T23:00:30.778487Z' + schema: + $ref: '#/components/schemas/Organizations' + description: Success. The response body contains a list of organizations. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/AuthorizationError' + '404': + $ref: '#/components/responses/ResourceNotFoundError' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/GeneralServerError' + summary: List organizations + tags: + - Organizations + post: + description: | + Creates an [organization](/influxdb/cloud-serverless/reference/glossary/#organization) + and returns the newly created organization. + + InfluxDB Cloud Serverless doesn't allow you to use this endpoint to create organizations. + + #### Related guides + + - [Manage organizations](/influxdb/cloud-serverless/organizations) + operationId: PostOrgs + parameters: + - $ref: '#/components/parameters/TraceSpan' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PostOrganizationRequest' + description: The organization to create. + required: true + responses: + '201': + content: + application/json: + examples: + successResponse: + value: + createdAt: '2022-08-24T23:05:52.881317Z' + description: '' + id: INFLUX_ORG_ID + links: + buckets: /api/v2/buckets?org=INFLUX_ORG + dashboards: /api/v2/dashboards?org=INFLUX_ORG + labels: /api/v2/orgs/INFLUX_ORG_ID/labels + logs: /api/v2/orgs/INFLUX_ORG_ID/logs + members: /api/v2/orgs/INFLUX_ORG_ID/members + owners: /api/v2/orgs/INFLUX_ORG_ID/owners + secrets: /api/v2/orgs/INFLUX_ORG_ID/secrets + self: /api/v2/orgs/INFLUX_ORG_ID + tasks: /api/v2/tasks?org=INFLUX_ORG + name: INFLUX_ORG + updatedAt: '2022-08-24T23:05:52.881318Z' + schema: + $ref: '#/components/schemas/Organization' + description: Created. The response body contains the organization information. + '400': + $ref: '#/components/responses/BadRequestError' + examples: + invalidRequest: + summary: The `name` field is missing from the request body. + value: + code: invalid + message: org name is empty + '401': + $ref: '#/components/responses/AuthorizationError' + '404': + $ref: '#/components/responses/ResourceNotFoundError' + '500': + $ref: '#/components/responses/InternalServerError' + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Create an organization + tags: + - Organizations + x-codeSamples: + - label: cURL + lang: Shell + source: | + curl --request POST "http://localhost:8086/api/v2/orgs \ + --header "Authorization: Token INFLUX_API_TOKEN" \ + --header "Accept: application/json" \ + --header "Content-Type: application/json" \ + --data '{ + "name": "INFLUX_ORG", + "description: "Example InfluxDB organization" + }' + /api/v2/orgs/{orgID}: + delete: + description: | + Deletes an organization. + + Deleting an organization from InfluxDB Cloud can't be undone. + Once deleted, all data associated with the organization is removed. + + #### InfluxDB Cloud + + - Does the following when you send a delete request: + + 1. Validates the request and queues the delete. + 2. Returns an HTTP `204` status code if queued; _error_ otherwise. + 3. Handles the delete asynchronously. + + #### InfluxDB OSS + + - Validates the request, handles the delete synchronously, + and then responds with success or failure. + + #### Limitations + + - Only one organization can be deleted per request. + + #### Related guides + + - [Delete organizations](/influxdb/cloud-serverless/organizations/delete-orgs/) + operationId: DeleteOrgsID + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: | + The ID of the organization to delete. + in: path + name: orgID + required: true + schema: + type: string + responses: + '204': + description: | + Success. + + #### InfluxDB Cloud + - The organization is queued for deletion. + + #### InfluxDB OSS + - The organization is deleted. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/AuthorizationError' + '404': + content: + application/json: + examples: + notFound: + summary: | + The requested organization was not found. + value: + code: not found + message: org not found + schema: + $ref: '#/components/schemas/Error' + description: | + Not found. + InfluxDB can't find the organization. + '500': + $ref: '#/components/responses/InternalServerError' + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Delete an organization + tags: + - Organizations + get: + description: | + Retrieves an organization. + + Use this endpoint to retrieve information for a specific organization. + + #### Related guides + + - [View organizations](/influxdb/cloud-serverless/organizations/view-orgs/) + operationId: GetOrgsID + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: | + The ID of the organization to retrieve. + in: path + name: orgID + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Organization' + description: | + Success. + The response body contains the organization information. + '401': + $ref: '#/components/responses/AuthorizationError' + '404': + content: + application/json: + examples: + notFound: + summary: | + The requested organization wasn't found. + value: + code: not found + message: organization not found + schema: + $ref: '#/components/schemas/Error' + description: | + Not found. + Organization not found. + '500': + $ref: '#/components/responses/InternalServerError' + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Retrieve an organization + tags: + - Organizations + patch: + description: | + Updates an organization. + + Use this endpoint to update properties + (`name`, `description`) of an organization. + + Updating an organization’s name affects all resources that reference the + organization by name, including the following: + + - Queries + - Dashboards + - Tasks + - Telegraf configurations + - Templates + + If you change an organization name, be sure to update the organization name + in these resources as well. + + #### Related Guides + + - [Update an organization](/influxdb/cloud-serverless/organizations/update-org/) + operationId: PatchOrgsID + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: | + The ID of the organization to update. + in: path + name: orgID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchOrganizationRequest' + description: The organization update to apply. + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Organization' + description: Success. The response body contains the updated organization. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/AuthorizationError' + '404': + $ref: '#/components/responses/ResourceNotFoundError' + '500': + $ref: '#/components/responses/InternalServerError' + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Update an organization + tags: + - Organizations + /api/v2/orgs/{orgID}/limits: + get: + operationId: GetOrgLimitsID + parameters: + - description: The ID of the organization. + in: path + name: orgID + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + description: These are org limits similar to those configured in/by quartz. + properties: + limits: + $ref: '#/components/schemas/Limit' + links: + $ref: '#/components/schemas/Links' + type: object + description: Limits defined for the organization. + default: + $ref: '#/components/responses/GeneralServerError' + description: unexpected error + summary: Retrieve limits for an organization + tags: + - Limits + /api/v2/orgs/{orgID}/members: + get: + description: | + Lists all users that belong to an organization. + + InfluxDB Cloud Serverless doesn't use `owner` and `member` roles. + Use [`/api/v2/authorizations`](#tag/Authorizations-(API-tokens)) to manage resource permissions. + operationId: GetOrgsIDMembers + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: | + The ID of the organization to retrieve users for. + in: path + name: orgID + required: true + schema: + type: string + responses: + '200': + content: + application/json: + examples: + successResponse: + value: + links: + self: /api/v2/orgs/055aa4783aa38398/members + users: + - id: 791df274afd48a83 + links: + self: /api/v2/users/791df274afd48a83 + name: example_user_1 + role: member + status: active + - id: 09cfb87051cbe000 + links: + self: /api/v2/users/09cfb87051cbe000 + name: example_user_2 + role: owner + status: active + schema: + $ref: '#/components/schemas/ResourceMembers' + description: | + Success. + The response body contains a list of all users within the organization. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/AuthorizationError' + '404': + content: + application/json: + examples: + notFound: + summary: | + The requested organization wasn't found. + value: + code: not found + message: 404 page not found + schema: + $ref: '#/components/schemas/Error' + description: | + Not found. + InfluxDB can't find the organization. + '500': + $ref: '#/components/responses/InternalServerError' + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: List all members of an organization + tags: + - Organizations + post: + description: | + Add a user to an organization. + + InfluxDB Cloud Serverless doesn't use `owner` and `member` roles. + Use [`/api/v2/authorizations`](#tag/Authorizations-(API-tokens)) to manage resource permissions. + operationId: PostOrgsIDMembers + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: | + The ID of the organization. + in: path + name: orgID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AddResourceMemberRequestBody' + description: | + The user to add to the organization. + required: true + responses: + '201': + content: + application/json: + examples: + successResponse: + value: + id: 09cfb87051cbe000 + links: + self: /api/v2/users/09cfb87051cbe000 + name: example_user_1 + role: member + status: active + schema: + $ref: '#/components/schemas/ResourceMember' + description: | + Success. + The response body contains the user information. + '400': + $ref: '#/components/responses/BadRequestError' + examples: + invalidRequest: + summary: The user `id` is missing from the request body. + value: + code: invalid + message: user id missing or invalid + '401': + $ref: '#/components/responses/AuthorizationError' + '404': + $ref: '#/components/responses/ResourceNotFoundError' + '500': + $ref: '#/components/responses/InternalServerError' + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Add a member to an organization + tags: + - Organizations + x-codeSamples: + - label: cURL + lang: Shell + source: | + curl --request POST "http://localhost:8086/api/v2/orgs/INFLUX_ORG_ID/members \ + --header "Authorization: Token INFLUX_API_TOKEN" \ + --header "Accept: application/json" \ + --header "Content-Type: application/json" \ + --data '{ + "id": "09cfb87051cbe000" + }' + /api/v2/orgs/{orgID}/members/{userID}: + delete: + description: | + Removes a member from an organization. + + InfluxDB Cloud Serverless doesn't use `owner` and `member` roles. + Use [`/api/v2/authorizations`](#tag/Authorizations-(API-tokens)) to manage resource permissions. + operationId: DeleteOrgsIDMembersID + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The ID of the user to remove. + in: path + name: userID + required: true + schema: + type: string + - description: The ID of the organization to remove a user from. + in: path + name: orgID + required: true + schema: + type: string + responses: + '204': + description: | + Success. + The user is no longer a member of the organization. + '401': + $ref: '#/components/responses/AuthorizationError' + '404': + $ref: '#/components/responses/ResourceNotFoundError' + '500': + $ref: '#/components/responses/InternalServerError' + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Remove a member from an organization + tags: + - Organizations + /api/v2/orgs/{orgID}/owners: + get: + description: | + Lists all owners of an organization. + + InfluxDB Cloud Serverless doesn't use `owner` and `member` roles. + Use [`/api/v2/authorizations`](#tag/Authorizations-(API-tokens)) to manage resource permissions. + operationId: GetOrgsIDOwners + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: | + The ID of the organization to list owners for. + in: path + name: orgID + required: true + schema: + type: string + responses: + '200': + content: + application/json: + examples: + successResponse: + value: + links: + self: /api/v2/orgs/055aa4783aa38398/owners + users: + - id: 09cfb87051cbe000 + links: + self: /api/v2/users/09cfb87051cbe000 + name: example_user_2 + role: owner + status: active + schema: + $ref: '#/components/schemas/ResourceOwners' + description: A list of organization owners + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Organization not found + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: List all owners of an organization + tags: + - Organizations + post: + description: | + Adds an owner to an organization. + + InfluxDB Cloud Serverless doesn't use `owner` and `member` roles. + Use [`/api/v2/authorizations`](#tag/Authorizations-(API-tokens)) to manage resource permissions. + operationId: PostOrgsIDOwners + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The ID of the organization that you want to add an owner for. + in: path + name: orgID + required: true + schema: + type: string + requestBody: + content: + application/json: + examples: + successResponse: + value: + id: 09cfb87051cbe000 + links: + self: /api/v2/users/09cfb87051cbe000 + name: example_user_1 + role: owner + status: active + schema: + $ref: '#/components/schemas/AddResourceMemberRequestBody' + description: The user to add as an owner of the organization. + required: true + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/ResourceOwner' + description: | + Success. The user is an owner of the organization. + The response body contains the owner with role and user detail. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/AuthorizationError' + '404': + $ref: '#/components/responses/ResourceNotFoundError' + '500': + $ref: '#/components/responses/InternalServerError' + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Add an owner to an organization + tags: + - Organizations + x-codeSamples: + - label: cURL + lang: Shell + source: | + curl --request POST "http://localhost:8086/api/v2/orgs/INFLUX_ORG_ID/owners \ + --header "Authorization: Token INFLUX_API_TOKEN" \ + --header "Accept: application/json" \ + --header "Content-Type: application/json" \ + --data '{ + "id": "09cfb87051cbe000" + }' + /api/v2/orgs/{orgID}/owners/{userID}: + delete: + description: | + Removes an [owner](/influxdb/cloud-serverless/reference/glossary/#owner) from + the organization. + + InfluxDB Cloud Serverless doesn't use `owner` and `member` roles. + Use [`/api/v2/authorizations`](#tag/Authorizations-(API-tokens)) to manage resource permissions. + operationId: DeleteOrgsIDOwnersID + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The ID of the user to remove. + in: path + name: userID + required: true + schema: + type: string + - description: | + The ID of the organization to remove an owner from. + in: path + name: orgID + required: true + schema: + type: string + responses: + '204': + description: | + Success. + The user is no longer an owner of the organization. + '401': + $ref: '#/components/responses/AuthorizationError' + '404': + $ref: '#/components/responses/ResourceNotFoundError' + '500': + $ref: '#/components/responses/InternalServerError' + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Remove an owner from an organization + tags: + - Organizations + /api/v2/orgs/{orgID}/secrets: + get: + operationId: GetOrgsIDSecrets + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The organization ID. + in: path + name: orgID + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SecretKeysResponse' + description: A list of all secret keys + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: List all secret keys for an organization + tags: + - Secrets + patch: + operationId: PatchOrgsIDSecrets + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The organization ID. + in: path + name: orgID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Secrets' + description: Secret key value pairs to update/add + required: true + responses: + '204': + description: Keys successfully patched + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Update secrets in an organization + tags: + - Secrets + /api/v2/orgs/{orgID}/secrets/{secretID}: + delete: + operationId: DeleteOrgsIDSecretsID + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The organization ID. + in: path + name: orgID + required: true + schema: + type: string + - description: The secret ID. + in: path + name: secretID + required: true + schema: + type: string + responses: + '204': + description: Keys successfully deleted + default: + $ref: '#/components/responses/GeneralServerError' + description: Unexpected error + summary: Delete a secret from an organization + tags: + - Secrets + /api/v2/orgs/{orgID}/secrets/delete: + post: + deprecated: true + operationId: PostOrgsIDSecrets + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The organization ID. + in: path + name: orgID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SecretKeys' + description: Secret key to delete + required: true + responses: + '204': + description: Keys successfully patched + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Delete secrets from an organization + tags: + - Secrets + /api/v2/orgs/{orgID}/usage: + get: + operationId: GetOrgUsageID + parameters: + - description: The ID of the organization. + in: path + name: orgID + required: true + schema: + type: string + - description: | + Earliest time ([unix timestamp format](/influxdb/cloud-serverless/reference/glossary/#unix-timestamp)) to include in results. + in: query + name: start + required: true + schema: + format: unix timestamp + type: integer + - description: | + Latest time ([unix timestamp format](/influxdb/cloud-serverless/reference/glossary/#unix-timestamp)) to include in results. + in: query + name: stop + required: false + schema: + format: unix timestamp + type: integer + - description: return raw usage data + in: query + name: raw + required: false + schema: + default: false + type: boolean + responses: + '200': + content: + text/csv: + schema: + example: | + #group,false,false,true,true,false,false,true,true,true,true #datatype,string,long,dateTime:RFC3339,dateTime:RFC3339,dateTime:RFC3339,double,string,string,string,string #default,_result,,,,,,,,, ,result,table,_start,_stop,_time,_value,_field,_measurement,bucket_id,org_id ,,0,2021-05-10T14:25:10.865702397Z,2021-05-10T15:25:10.865702397Z,2021-05-10T15:00:00Z,5434066,gauge,storage_usage_bucket_bytes,2f6ba0cf9a2fdcbb,cec6fc1d2176dc11 ,,1,2021-05-10T14:25:10.865702397Z,2021-05-10T15:25:10.865702397Z,2021-05-10T15:00:00Z,9924053.966666665,gauge,storage_usage_bucket_bytes,8af67bcaf69d9daf,cec6fc1d2176dc11 + type: string + description: Usage data + headers: + Content-Encoding: + description: Lists any encodings (usually compression algorithms) that have been applied to the response payload. + schema: + default: identity + description: The content coding. `gzip` for compressed data or `identity` for unmodified, uncompressed data. + enum: + - gzip + - identity + type: string + default: + $ref: '#/components/responses/GeneralServerError' + description: unexpected error + summary: Retrieve usage for an organization + tags: + - Usage + /ping: {} + /api/v2/query: + post: + deprecated: true + description: | + Retrieves data from buckets. + + This endpoint isn't supported in InfluxDB Cloud Serverless. + + See how to [query data](/influxdb/cloud-serverless/query-data/). + operationId: PostQuery + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The content encoding (usually a compression algorithm) that the client can understand. + in: header + name: Accept-Encoding + schema: + default: identity + description: The content coding. Use `gzip` for compressed data or `identity` for unmodified, uncompressed data. + enum: + - gzip + - identity + type: string + - in: header + name: Content-Type + schema: + enum: + - application/json + - application/vnd.flux + type: string + - description: | + An organization name or ID. + + #### InfluxDB Cloud Serverless + + - Doesn't use the `org` parameter or `orgID` parameter. + in: query + name: org + schema: + type: string + - description: | + An organization ID. + + #### InfluxDB Cloud Serverless + + - Doesn't use the `org` parameter or `orgID` parameter. + in: query + name: orgID + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Query' + application/vnd.flux: + schema: + type: string + description: Flux query or specification to execute + responses: + '200': + content: + application/csv: + schema: + type: string + description: | + This endpoint isn't supported in InfluxDB Cloud Serverless. + See how to [query data](/influxdb/cloud-serverless/query-data/). + headers: + Content-Encoding: + description: Lists encodings (usually compression algorithms) that have been applied to the response payload. + schema: + default: identity + description: | + The content coding: `gzip` for compressed data or `identity` for unmodified, uncompressed data. + enum: + - gzip + - identity + type: string + Trace-Id: + description: The trace ID, if generated, of the request. + schema: + description: Trace ID of a request. + type: string + '400': + content: + application/json: + examples: + orgNotFound: + summary: Organization not found + value: + code: invalid + message: 'failed to decode request body: organization not found' + schema: + $ref: '#/components/schemas/Error' + description: | + Bad request. + The response body contains detail about the error. + + #### InfluxDB OSS + + - Returns this error if the `org` parameter or `orgID` parameter doesn't match an organization. + '401': + $ref: '#/components/responses/AuthorizationError' + '404': + $ref: '#/components/responses/ResourceNotFoundError' + '429': + description: | + #### InfluxDB Cloud Serverless: + - returns this error if a **read** or **write** request exceeds your + plan's [adjustable service quotas](/influxdb/cloud-serverless/account-management/limits/#adjustable-service-quotas) + or if a **delete** request exceeds the maximum + [global limit](/influxdb/cloud-serverless/account-management/limits/#global-limits). + headers: + Retry-After: + description: Non-negative decimal integer indicating seconds to wait before retrying the request. + schema: + format: int32 + type: integer + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/GeneralServerError' + summary: Query data + tags: + - Query + /api/v2/query/analyze: + post: + deprecated: true + description: | + This endpoint isn't supported in InfluxDB Cloud Serverless. + See how to [query data](/influxdb/cloud-serverless/query-data/). + operationId: PostQueryAnalyze + parameters: + - $ref: '#/components/parameters/TraceSpan' + - in: header + name: Content-Type + schema: + enum: + - application/json + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Query' + description: Flux query to analyze + responses: + '200': + content: + application/json: + examples: + missingQueryPropertyKey: + description: | + Returns an error object if the Flux query is missing a property key. + + The following sample query is missing the _`bucket`_ property key: + + ```json + { + "query": "from(: \"iot_center\")\ + ... + } + ``` + summary: Missing property key error + value: + errors: + - character: 0 + column: 6 + line: 1 + message: missing property key + schema: + $ref: '#/components/schemas/AnalyzeQueryResponse' + description: | + This endpoint isn't supported in InfluxDB Cloud Serverless. + See how to [query data](/influxdb/cloud-serverless/query-data/). + '400': + content: + application/json: + examples: + invalidJSONStringValue: + description: If the request body contains invalid JSON, returns `invalid` and problem detail. + summary: Invalid JSON + value: + code: invalid + message: 'invalid json: invalid character ''\'''' looking for beginning of value' + schema: + $ref: '#/components/schemas/Error' + description: | + Bad request. + InfluxDB is unable to parse the request. + The response body contains detail about the problem. + headers: + X-Platform-Error-Code: + description: | + The reason for the error. + schema: + example: invalid + type: string + default: + content: + application/json: + examples: + emptyJSONObject: + description: | + If the request body contains an empty JSON object, returns `internal error`. + summary: Empty JSON object in request body + value: + code: internal error + message: An internal error has occurred - check server logs + schema: + $ref: '#/components/schemas/Error' + description: Internal server error + headers: + X-Influx-Error: + description: A string that describes the problem. + schema: + type: string + X-Influx-Reference: + description: The numeric reference code for the error type. + schema: + type: integer + X-Platform-Error-Code: + description: The reason for the error. + schema: + example: internal error + type: string + summary: Analyze a Flux query + tags: + - Query + /api/v2/query/ast: + post: + deprecated: true + description: | + This endpoint isn't supported in InfluxDB Cloud Serverless. + See how to [query data](/influxdb/cloud-serverless/query-data/). + operationId: PostQueryAst + parameters: + - $ref: '#/components/parameters/TraceSpan' + - in: header + name: Content-Type + schema: + enum: + - application/json + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LanguageRequest' + description: The Flux query to analyze. + responses: + '200': + content: + schema: + $ref: '#/components/schemas/ASTResponse' + description: | + This endpoint isn't supported in InfluxDB Cloud Serverless. + See how to [query data](/influxdb/cloud-serverless/query-data/). + '400': + content: + application/json: + examples: + invalidASTValue: + description: | + If the request body contains a missing property key in `from()`, + returns `invalid` and problem detail. + summary: Invalid AST + value: + code: invalid + message: 'invalid AST: loc 1:6-1:19: missing property key' + schema: + $ref: '#/components/schemas/Error' + description: | + Bad request. + InfluxDB is unable to parse the request. + The response body contains detail about the problem. + headers: + X-Platform-Error-Code: + description: | + The reason for the error. + schema: + example: invalid + type: string + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Internal server error. + summary: Generate a query Abstract Syntax Tree (AST) + tags: + - Query + /api/v2/query/suggestions: + get: + deprecated: true + description: | + This endpoint isn't supported in InfluxDB Cloud Serverless. + See how to [query data](/influxdb/cloud-serverless/query-data/). + operationId: GetQuerySuggestions + parameters: + - $ref: '#/components/parameters/TraceSpan' + responses: + '200': + description: | + This endpoint isn't supported in InfluxDB Cloud Serverless. + See how to [query data](/influxdb/cloud-serverless/query-data/). + '301': + content: + text/html: + examples: + movedPermanently: + description: | + The URL has been permanently moved. Use `/api/v2/query/suggestions`. + summary: Invalid URL + value: | + Moved Permanently + schema: + properties: + body: + description: Response message with URL of requested resource. + readOnly: true + type: string + description: | + Moved Permanently. + InfluxData has moved the URL of the endpoint. + Use `/api/v2/query/suggestions` (without a trailing slash). + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Internal server error. + summary: List Flux query suggestions + tags: + - Query + x-codeSamples: + - label: cURL + lang: Shell + source: | + curl --request GET "INFLUX_URL/api/v2/query/suggestions" \ + --header "Accept: application/json" \ + --header "Authorization: Token INFLUX_API_TOKEN" + /api/v2/query/suggestions/{name}: + get: + deprecated: true + description: | + This endpoint isn't supported in InfluxDB Cloud Serverless. + See how to [query data](/influxdb/cloud-serverless/query-data/). + operationId: GetQuerySuggestionsName + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: | + A [Flux function](https://docs.influxdata.com/flux/v0.x/stdlib/all-functions/) name. + in: path + name: name + required: true + schema: + type: string + responses: + '200': + description: | + This endpoint isn't supported in InfluxDB Cloud Serverless. + See how to [query data](/influxdb/cloud-serverless/query-data/). + '500': + content: + application/json: + examples: + internalError: + description: | + The requested function doesn't exist. + summary: Invalid function + value: + code: internal error + message: An internal error has occurred + schema: + $ref: '#/components/schemas/Error' + description: | + Internal server error. + The value passed for _`name`_ may have been misspelled. + summary: Retrieve a query suggestion for a branching suggestion + tags: + - Query + /api/v2/resources: + get: + operationId: GetResources + parameters: + - $ref: '#/components/parameters/TraceSpan' + responses: + '200': + content: + application/json: + schema: + items: + type: string + type: array + description: All resources targets + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Internal server error + summary: List all known resources + tags: + - Resources + - System information endpoints + /api/v2/scripts: + get: + description: | + Lists scripts. + + + operationId: GetScripts + parameters: + - description: | + The offset for pagination. + The number of records to skip. + + For more information about pagination parameters, see [Pagination](/influxdb/cloud-serverless/api/#tag/Pagination). + in: query + name: offset + required: false + schema: + minimum: 0 + type: integer + - description: | + The maximum number of scripts to return. Default is `100`. + in: query + name: limit + required: false + schema: + default: 100 + maximum: 500 + minimum: 0 + type: integer + - description: The script name. Lists scripts with the specified name. + in: query + name: name + required: false + schema: + type: string + responses: + '200': + content: + application/json: + examples: + successResponse: + value: + scripts: + - createdAt: '2022-07-17T23:49:45.731237Z' + description: find the last point from Sample Bucket + id: 09afa3b220fe4000 + language: flux + name: getLastPointFromSampleBucket + orgID: bea7ea952287f70d + script: 'from(bucket: SampleBucket) |> range(start: -7d) |> limit(n:1)' + updatedAt: '2022-07-17T23:49:45.731237Z' + - createdAt: '2022-07-17T23:43:26.660308Z' + description: getLastPoint finds the last point in a bucket + id: 09afa23ff13e4000 + language: flux + name: getLastPoint + orgID: bea7ea952287f70d + script: 'from(bucket: params.mybucket) |> range(start: -7d) |> limit(n:1)' + updatedAt: '2022-07-17T23:43:26.660308Z' + schema: + $ref: '#/components/schemas/Scripts' + description: | + Success. + The response body contains the list of scripts. + '400': + content: + application/json: + examples: + invalidSyntaxError: + summary: Query parameter contains invalid syntax. + value: + code: 3 + details: [] + message: 'parsing field "limit": strconv.ParseUint: parsing "-1": invalid syntax' + schema: + $ref: '#/components/schemas/Error' + description: | + Bad request. + InfluxDB is unable to parse the request. + The response body contains detail about the error. + '401': + $ref: '#/components/responses/AuthorizationError' + '500': + $ref: '#/components/responses/InternalServerError' + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error. + summary: List scripts + tags: + - Invokable Scripts + x-codeSamples: + - label: 'cURL: retrieves the first 100 scripts.' + lang: Shell + source: | + curl --request GET "INFLUX_URL/api/v2/scripts?limit=100&offset=0" \ + --header "Authorization: Token INFLUX_API_TOKEN" \ + --header "Accept: application/json" \ + --header "Content-Type: application/json" + post: + description: | + Creates an invokable script + and returns the script. + + + operationId: PostScripts + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ScriptCreateRequest' + description: The script to create. + required: true + responses: + '201': + content: + application/json: + examples: + successResponse: + value: + createdAt: '2022-07-17T23:43:26.660308Z' + description: getLastPoint finds the last point in a bucket + id: 09afa23ff13e4000 + language: flux + name: getLastPoint + orgID: bea7ea952287f70d + script: 'from(bucket: params.mybucket) |> range(start: -7d) |> limit(n:1)' + updatedAt: '2022-07-17T23:43:26.660308Z' + schema: + $ref: '#/components/schemas/Script' + description: | + Success. + The response body contains the script and its metadata. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/AuthorizationError' + '422': + content: + application/json: + examples: + uniquenessError: + description: | + A script with the same `name` exists. + value: + code: conflict + message: uniqueness violation + schema: + $ref: '#/components/schemas/Error' + description: | + Unprocessable entity. + '500': + $ref: '#/components/responses/InternalServerError' + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error. + summary: Create a script + tags: + - Invokable Scripts + /api/v2/scripts/{scriptID}: + delete: + description: | + Deletes a script and all associated records. + + #### Limitations + + - You can delete only one script per request. + - If the script ID you provide doesn't exist for the organization, InfluxDB + responds with an HTTP `204` status code. + + + operationId: DeleteScriptsID + parameters: + - description: | + A script ID. + Deletes the specified script. + in: path + name: scriptID + required: true + schema: + type: string + responses: + '204': + description: | + Success. + The script is queued for deletion. + '401': + $ref: '#/components/responses/AuthorizationError' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/ServerError' + description: Unexpected error + summary: Delete a script + tags: + - Invokable Scripts + x-codeSamples: + - label: cURL + lang: Shell + source: | + curl -X 'DELETE' \ + "https://cloud2.influxdata.com/api/v2/scripts/SCRIPT_ID" \ + --header "Authorization: Token INFLUX_TOKEN" \ + --header 'Accept: application/json' + get: + description: | + Retrieves a script. + + + operationId: GetScriptsID + parameters: + - description: | + A script ID. + Retrieves the specified script. + in: path + name: scriptID + required: true + schema: + type: string + responses: + '200': + content: + application/json: + examples: + successResponse: + value: + createdAt: '2022-07-17T23:49:45.731237Z' + description: getLastPoint finds the last point in a bucket + id: 09afa3b220fe4000 + language: flux + name: getLastPoint + orgID: bea7ea952287f70d + script: 'from(bucket: my-bucket) |> range(start: -7d) |> limit(n:1)' + updatedAt: '2022-07-17T23:49:45.731237Z' + schema: + $ref: '#/components/schemas/Script' + description: Success. The response body contains the script. + '401': + $ref: '#/components/responses/AuthorizationError' + '404': + content: + application/json: + examples: + notFound: + summary: | + The requested script was not found. + value: + code: not found + message: script "09afa3b220fe400" not found + schema: + $ref: '#/components/schemas/Error' + description: | + Not found. + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/ServerError' + description: Internal server error. + summary: Retrieve a script + tags: + - Invokable Scripts + patch: + description: | + Updates an invokable script. + + Use this endpoint to modify values for script properties (`description` and `script`). + + To update a script, pass an object that contains the updated key-value pairs. + + #### Limitations + + - If you send an empty request body, the script will neither update nor + store an empty script, but InfluxDB will respond with an HTTP `200` status + code. + + + operationId: PatchScriptsID + parameters: + - description: | + A script ID. + Updates the specified script. + in: path + name: scriptID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ScriptUpdateRequest' + description: | + An object that contains the updated script properties to apply. + required: true + responses: + '200': + content: + application/json: + examples: + successResponse: + value: + createdAt: '2022-07-17T23:49:45.731237Z' + description: get last point from new bucket + id: 09afa3b220fe4000 + language: flux + name: getLastPoint + orgID: bea7ea952287f70d + script: 'from(bucket: newBucket) |> range(start: -7d) |> limit(n:1)' + updatedAt: '2022-07-19T22:27:23.185436Z' + schema: + $ref: '#/components/schemas/Script' + description: Success. The response body contains the updated script. + '401': + $ref: '#/components/responses/AuthorizationError' + '404': + content: + application/json: + examples: + notFound: + summary: | + The requested script wasn't found. + value: + code: not found + message: script "09afa3b220fe400" not found + schema: + $ref: '#/components/schemas/Error' + description: | + Not found. + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/ServerError' + description: Internal server error + summary: Update a script + tags: + - Invokable Scripts + x-codeSamples: + - label: cURL + lang: Shell + source: | + curl -X 'PATCH' \ + "https://cloud2.influxdata.com/api/v2/scripts/SCRIPT_ID" \ + --header "Authorization: Token INFLUX_TOKEN" \ + --header "Accept: application/json" + --header "Content-Type: application/json" + --data '{ + "description": "get last point from new bucket", + "script": "from(bucket: updatedBucket) |> range(start: -7d) |> limit(n:1)", "language": "flux" + }' + /api/v2/scripts/{scriptID}/invoke: + post: + description: | + Runs a script and returns the result. + When the script runs, InfluxDB replaces `params` keys referenced in the script with + `params` key-values passed in the request body--for example: + + The following sample script contains a _`mybucket`_ parameter : + + ```json + "script": "from(bucket: params.mybucket) + |> range(start: -7d) + |> limit(n:1)" + ``` + + The following example `POST /api/v2/scripts/SCRIPT_ID/invoke` request body + passes a value for the _`mybucket`_ parameter: + + ```json + { + "params": { + "mybucket": "air_sensor" + } + } + ``` + + + operationId: PostScriptsIDInvoke + parameters: + - description: | + A script ID. + Runs the specified script. + in: path + name: scriptID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ScriptInvocationParams' + responses: + '200': + content: + text/csv: + examples: + successResponse: + value: | + ,result,table,_start,_stop,_time,_value,_field,_measurement,host + ,_result,0,2019-10-30T01:28:02.52716421Z,2022-07-26T01:28:02.52716421Z,2020-01-01T00:00:00Z,72.01,used_percent,mem,host2 + schema: + $ref: '#/components/schemas/ScriptHTTPResponseData' + description: | + Success. + The response body contains the result of the script execution. + '400': + content: + application/json: + examples: + invalidParameters: + summary: The parameters passed to the script are invalid. + value: + code: invalid + message: invalid parameters provided + schema: + $ref: '#/components/schemas/Error' + description: | + Bad request. + InfluxDB is unable to parse the request. + The response body contains detail about the error. + headers: + X-Platform-Error-Code: + description: | + The reason for the error. + schema: + example: invalid + type: string + '401': + $ref: '#/components/responses/AuthorizationError' + '404': + content: + application/json: + examples: + bucketNotFound: + description: InfluxDB can't find the requested bucket. + summary: | + Bucket not found + value: + code: not found + message: 'failed to initialize execute state: could not find bucket "test-bucket"' + scriptNotFound: + description: InfluxDB can't find the requested script. + summary: | + Script not found + value: + code: not found + message: script "09afa3b220fe400" not found + schema: + $ref: '#/components/schemas/Error' + description: | + Not found. + headers: + X-Platform-Error-Code: + description: | + The reason for the error. + schema: + example: not found + type: string + '500': + $ref: '#/components/responses/InternalServerError' + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error. + summary: Invoke a script + tags: + - Invokable Scripts + /api/v2/scripts/{scriptID}/params: + get: + description: | + Analyzes a script and determines required parameters. + Find all `params` keys referenced in a script and return a list + of keys. If it is possible to determine the type of the value + from the context then the type is also returned -- for example: + + The following sample script contains a _`mybucket`_ parameter : + + ```json + "script": "from(bucket: params.mybucket) + |> range(start: -7d) + |> limit(n:1)" + ``` + + Requesting the parameters using `GET /api/v2/scripts/SCRIPT_ID/params` + returns the following: + + ```json + { + "params": { + "mybucket": "string" + } + } + ``` + + The type name returned for a parameter will be one of: + + - `any` + - `bool` + - `duration` + - `float` + - `int` + - `string` + - `time` + - `uint` + + The type name `any` is used when the type of a parameter cannot + be determined from the context, or the type is determined to + be a structured type such as an array or record. + + + operationId: GetScriptsIDParams + parameters: + - description: | + A script ID. + The script to analyze for params. + in: path + name: scriptID + required: true + schema: + type: string + responses: + '200': + content: + application/json: + examples: + successResponse: + value: + params: + mybucket: string + schema: + $ref: '#/components/schemas/Params' + description: | + Success. + The response body contains the parameters found, along with their types. + '401': + $ref: '#/components/responses/AuthorizationError' + '404': + content: + application/json: + examples: + scriptNotFound: + description: InfluxDB can't find the requested script. + summary: | + Script not found + value: + code: not found + message: script "09afa3b220fe400" not found + schema: + $ref: '#/components/schemas/Error' + description: | + Not found. + headers: + X-Platform-Error-Code: + description: | + The reason for the error. + schema: + example: not found + type: string + '500': + $ref: '#/components/responses/InternalServerError' + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error. + summary: Find script parameters. + tags: + - Invokable Scripts + x-codeSamples: + - label: cURL + lang: Shell + source: | + curl --request GET "https://cloud2.influxdata.com/api/v2/scripts/SCRIPT_ID/params" \ + --header "Authorization: Token INFLUX_TOKEN" + /api/v2/setup: {} + /api/v2/setup/user: {} + /api/v2/signin: {} + /api/v2/signout: {} + /api/v2/stacks: + get: + description: | + Lists installed InfluxDB stacks. + + To limit stacks in the response, pass query parameters in your request. + If no query parameters are passed, InfluxDB returns all installed stacks + for the organization. + + + operationId: ListStacks + parameters: + - description: | + An organization ID. + Only returns stacks owned by the specified [organization](/influxdb/cloud-serverless/reference/glossary/#organization). + + #### InfluxDB Cloud + + - Doesn't require this parameter; + InfluxDB only returns resources allowed by the API token. + in: query + name: orgID + required: true + schema: + type: string + - description: | + A stack name. + Finds stack `events` with this name and returns the stacks. + + Repeatable. + To filter for more than one stack name, + repeat this parameter with each name--for example: + + - `INFLUX_URL/api/v2/stacks?&orgID=INFLUX_ORG_ID&name=project-stack-0&name=project-stack-1` + examples: + findStackByName: + summary: Find stacks with the event name + value: project-stack-0 + in: query + name: name + schema: + type: string + - description: | + A stack ID. + Only returns the specified stack. + + Repeatable. + To filter for more than one stack ID, + repeat this parameter with each ID--for example: + + - `INFLUX_URL/api/v2/stacks?&orgID=INFLUX_ORG_ID&stackID=09bd87cd33be3000&stackID=09bef35081fe3000` + examples: + findStackByID: + summary: Find a stack with the ID + value: 09bd87cd33be3000 + in: query + name: stackID + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + stacks: + items: + $ref: '#/components/schemas/Stack' + type: array + type: object + description: Success. The response body contains the list of stacks. + '400': + content: + application/json: + examples: + orgIdMissing: + summary: The orgID query parameter is missing + value: + code: invalid + message: 'organization id[""] is invalid: id must have a length of 16 bytes' + orgProvidedNotFound: + summary: The org or orgID passed doesn't own the token passed in the header + value: + code: invalid + message: 'failed to decode request body: organization not found' + schema: + $ref: '#/components/schemas/Error' + description: | + Bad request. + The response body contains detail about the error. + + #### InfluxDB OSS + + - Returns this error if an incorrect value is passed in the `org` parameter or `orgID` parameter. + '401': + $ref: '#/components/responses/AuthorizationError' + '500': + $ref: '#/components/responses/InternalServerError' + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: List installed stacks + tags: + - Templates + post: + description: | + Creates or initializes a stack. + + Use this endpoint to _manually_ initialize a new stack with the following + optional information: + + - Stack name + - Stack description + - URLs for template manifest files + + To automatically create a stack when applying templates, + use the [/api/v2/templates/apply endpoint](#operation/ApplyTemplate). + + #### Required permissions + + - `write` permission for the organization + + + operationId: CreateStack + requestBody: + content: + application/json: + schema: + properties: + description: + type: string + name: + type: string + orgID: + type: string + urls: + items: + type: string + type: array + title: PostStackRequest + type: object + description: The stack to create. + required: true + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/Stack' + description: Success. Returns the newly created stack. + '401': + $ref: '#/components/responses/AuthorizationError' + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: | + Unprocessable entity. + + The error may indicate one of the following problems: + + - The request body isn't valid--the request is well-formed, but InfluxDB can't process it due to semantic errors. + - You passed a parameter combination that InfluxDB doesn't support. + '500': + $ref: '#/components/responses/InternalServerError' + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Create a stack + tags: + - Templates + /api/v2/stacks/{stack_id}: + delete: + operationId: DeleteStack + parameters: + - description: The identifier of the stack. + in: path + name: stack_id + required: true + schema: + type: string + - description: The identifier of the organization. + in: query + name: orgID + required: true + schema: + type: string + responses: + '204': + description: The stack and its associated resources were deleted. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Delete a stack and associated resources + tags: + - Templates + get: + operationId: ReadStack + parameters: + - description: The identifier of the stack. + in: path + name: stack_id + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Stack' + description: Returns the stack. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Retrieve a stack + tags: + - Templates + patch: + operationId: UpdateStack + parameters: + - description: The identifier of the stack. + in: path + name: stack_id + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + additionalResources: + items: + properties: + kind: + type: string + resourceID: + type: string + templateMetaName: + type: string + required: + - kind + - resourceID + type: object + type: array + description: + nullable: true + type: string + name: + nullable: true + type: string + templateURLs: + items: + type: string + nullable: true + type: array + title: PatchStackRequest + type: object + description: The stack to update. + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Stack' + description: Returns the updated stack. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Update a stack + tags: + - Templates + /api/v2/stacks/{stack_id}/uninstall: + post: + operationId: UninstallStack + parameters: + - description: The identifier of the stack. + in: path + name: stack_id + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Stack' + description: Returns the uninstalled stack. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Uninstall a stack + tags: + - Templates + /api/v2/tasks: + get: + description: | + Retrieves a list of [tasks](/influxdb/cloud-serverless/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`. + operationId: GetTasks + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: | + A [task](/influxdb/cloud-serverless/reference/glossary/#task) name. + Only returns tasks with the specified name. + Different tasks may have the same name. + in: query + name: name + schema: + type: string + - description: | + A [task](/influxdb/cloud-serverless/reference/glossary/#task) ID. + Only returns tasks created after the specified task. + in: query + name: after + schema: + type: string + - description: | + A [user](/influxdb/cloud-serverless/reference/glossary/#user) ID. + Only returns tasks owned by the specified user. + in: query + name: user + schema: + type: string + - description: | + An [organization](/influxdb/cloud-serverless/reference/glossary/#organization) name. + Only returns tasks owned by the specified organization. + in: query + name: org + schema: + type: string + - description: | + An [organization](/influxdb/cloud-serverless/reference/glossary/#organization) ID. + Only returns tasks owned by the specified organization. + in: query + name: orgID + schema: + type: string + - description: | + A [task](/influxdb/cloud-serverless/reference/glossary/#task) status. + Only returns tasks that have the specified status (`active` or `inactive`). + in: query + name: status + schema: + enum: + - active + - inactive + type: string + - description: | + The maximum number of [tasks](/influxdb/cloud-serverless/reference/glossary/#task) to return. + Default is `100`. + The minimum is `1` and the maximum is `500`. + + To reduce the payload size, combine _`type=basic`_ and _`limit`_ (see _Request samples_). + For more information about the `basic` response, see the _`type`_ parameter. + examples: + all: + summary: Return all tasks, without pagination. + value: '-1' + minPaginated: + summary: Return a maximum of 50 tasks. + value: '50' + in: query + name: limit + schema: + default: 100 + maximum: 500 + minimum: -1 + type: integer + - description: The number of records to skip. + in: query + name: offset + required: false + schema: + default: 0 + minimum: 0 + type: integer + - description: | + The sort field. Only `name` is supported. + Specifies the field used to sort records in the list. + in: query + name: sortBy + required: false + schema: + enum: + - name + type: string + - description: | + A [task](/influxdb/cloud-serverless/reference/glossary/#task) type (`basic` or `system`). + Default is `system`. + Specifies the level of detail for tasks in the response. + 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`). + in: query + name: type + required: false + schema: + default: '' + enum: + - basic + - system + type: string + - description: | + A [script](#tag/Invokable-Scripts) ID. + Only returns tasks that use the specified invokable script. + in: query + name: scriptID + schema: + type: string + responses: + '200': + content: + application/json: + examples: + basicTypeTaskOutput: + description: | + A sample response body for the `?type=basic` parameter. + `type=basic` omits some task fields (`createdAt` and `updatedAt`) + and field values (`org`, `flux`) in the response. + summary: Basic output + value: + links: + self: /api/v2/tasks?limit=100 + tasks: + - every: 30m + flux: '' + id: 09956cbb6d378000 + labels: [] + lastRunStatus: success + latestCompleted: '2022-06-30T15:00:00Z' + links: + labels: /api/v2/tasks/09956cbb6d378000/labels + logs: /api/v2/tasks/09956cbb6d378000/logs + members: /api/v2/tasks/09956cbb6d378000/members + owners: /api/v2/tasks/09956cbb6d378000/owners + runs: /api/v2/tasks/09956cbb6d378000/runs + self: /api/v2/tasks/09956cbb6d378000 + name: task1 + org: '' + orgID: 48c88459ee424a04 + ownerID: 0772396d1f411000 + status: active + systemTypeTaskOutput: + description: | + A sample response body for the `?type=system` parameter. + `type=system` returns all task fields. + summary: System output + value: + links: + self: /api/v2/tasks?limit=100 + tasks: + - createdAt: '2022-06-27T15:09:06Z' + description: IoT Center 90-day environment average. + every: 30m + flux: |- + option task = {name: "task1", every: 30m} + + from(bucket: "iot_center") + |> range(start: -90d) + |> filter(fn: (r) => r._measurement == "environment") + |> aggregateWindow(every: 1h, fn: mean) + id: 09956cbb6d378000 + labels: [] + lastRunStatus: success + latestCompleted: '2022-06-30T15:00:00Z' + links: + labels: /api/v2/tasks/09956cbb6d378000/labels + logs: /api/v2/tasks/09956cbb6d378000/logs + members: /api/v2/tasks/09956cbb6d378000/members + owners: /api/v2/tasks/09956cbb6d378000/owners + runs: /api/v2/tasks/09956cbb6d378000/runs + self: /api/v2/tasks/09956cbb6d378000 + name: task1 + org: my-iot-center + orgID: 48c88459ee424a04 + ownerID: 0772396d1f411000 + status: active + updatedAt: '2022-06-28T18:10:15Z' + schema: + $ref: '#/components/schemas/Tasks' + description: | + Success. + The response body contains the list of tasks. + '401': + $ref: '#/components/responses/AuthorizationError' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/GeneralServerError' + summary: List all tasks + tags: + - Tasks + x-codeSamples: + - label: 'cURL: all tasks, basic output' + lang: Shell + source: | + curl INFLUX_URL/api/v2/tasks/?limit=-1&type=basic \ + --header 'Content-Type: application/json' \ + --header 'Authorization: Token INFLUX_API_TOKEN' + post: + description: | + Creates a [task](/influxdb/cloud-serverless/reference/glossary/#task) and returns the task. + + Use this endpoint to create a scheduled task that runs a Flux script. + + #### InfluxDB Cloud + + - You can use either `flux` or `scriptID` to provide the task script. + + - `flux`: a string of "raw" Flux that contains task options and the script--for example: + + ```json + { + "flux": "option task = {name: \"CPU Total 1 Hour New\", every: 1h}\ + from(bucket: \"telegraf\") + |> range(start: -1h) + |> filter(fn: (r) => (r._measurement == \"cpu\")) + |> filter(fn: (r) =>\n\t\t(r._field == \"usage_system\")) + |> filter(fn: (r) => (r.cpu == \"cpu-total\")) + |> aggregateWindow(every: 1h, fn: max) + |> to(bucket: \"cpu_usage_user_total_1h\", org: \"INFLUX_ORG\")", + "status": "active", + "description": "This task downsamples CPU data every hour" + } + ``` + + - `scriptID`: the ID of an [invokable script](#tag/Invokable-Scripts) + for the task to run. + To pass task options when using `scriptID`, pass the options as + properties in the request body--for example: + + ```json + { + "name": "CPU Total 1 Hour New", + "description": "This task downsamples CPU data every hour", + "every": "1h", + "scriptID": "SCRIPT_ID", + "scriptParameters": + { + "rangeStart": "-1h", + "bucket": "telegraf", + "filterField": "cpu-total" + } + } + ``` + + #### Limitations: + + - You can't use `flux` and `scriptID` for the same task. + + + operationId: PostTasks + parameters: + - $ref: '#/components/parameters/TraceSpan' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TaskCreateRequest' + description: The task to create + required: true + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/Task' + description: Success. The response body contains a `tasks` list with the new task. + '400': + content: + application/json: + examples: + fluxAndScriptError: + summary: The request body can't contain both flux and scriptID + value: + code: invalid + message: 'failed to decode request: can not provide both scriptID and flux' + missingFluxError: + summary: The request body requires either a flux parameter or scriptID parameter + value: + code: invalid + message: 'failed to decode request: flux required' + schema: + $ref: '#/components/schemas/Error' + description: | + Bad request. + The response body contains detail about the error. + + #### InfluxDB Cloud + + - Returns this error if the task doesn't contain one of _`flux`_ or _`scriptID`_. + - Returns this error if the task contains _`flux`_ _and_ _`scriptID`_. + '401': + $ref: '#/components/responses/AuthorizationError' + '500': + $ref: '#/components/responses/InternalServerError' + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Create a task + tags: + - Tasks + x-codeSamples: + - label: 'cURL: create a Flux script task' + lang: Shell + source: | + curl INFLUX_URL/api/v2/tasks \ + --header "Content-type: application/json" \ + --header "Authorization: Token INFLUX_API_TOKEN" \ + --data-binary @- << EOF + { + "orgID": "INFLUX_ORG_ID", + "description": "IoT Center 30d environment average.", + "flux": "option task = {name: \"iot-center-task-1\", every: 30m}\ + from(bucket: \"iot_center\")\ + |> range(start: -30d)\ + |> filter(fn: (r) => r._measurement == \"environment\")\ + |> aggregateWindow(every: 1h, fn: mean)" + } + EOF + - label: 'cURL: create a Flux script reference task' + lang: Shell + source: | + curl INFLUX_URL/api/v2/tasks \ + --header "Content-type: application/json" \ + --header "Authorization: Token INFLUX_API_TOKEN" \ + --data-binary @- << EOF + { + "orgID": "INFLUX_ORG_ID", + "description": "IoT Center 30d environment average.", + "scriptID": "085138a111448000", + "scriptParameters": + { + "rangeStart": "-30d", + "bucket": "air_sensor", + "filterField": "temperature", + "groupColumn": "_time" + } + } + EOF + /api/v2/tasks/{taskID}: + delete: + description: | + Deletes a [task](/influxdb/cloud-serverless/reference/glossary/#task) and associated records. + + Use this endpoint to delete a task and all associated records (task runs, logs, and labels). + Once the task is deleted, InfluxDB cancels all scheduled runs of the task. + + If you want to disable a task instead of delete it, [update the task status to `inactive`](#operation/PatchTasksID). + operationId: DeleteTasksID + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: A [task](/influxdb/cloud-serverless/reference/glossary/#task) ID. Specifies the task to delete. + in: path + name: taskID + required: true + schema: + type: string + responses: + '204': + description: Success. The task and task runs are deleted. Scheduled runs are canceled. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/AuthorizationError' + '404': + $ref: '#/components/responses/ResourceNotFoundError' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/GeneralServerError' + summary: Delete a task + tags: + - Tasks + get: + description: | + Retrieves a [task](/influxdb/cloud-serverless/reference/glossary/#task). + operationId: GetTasksID + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: | + A [task](/influxdb/cloud-serverless/reference/glossary/#task) ID. + Specifies the task to retrieve. + in: path + name: taskID + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Task' + description: Success. The response body contains the task. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/AuthorizationError' + '404': + $ref: '#/components/responses/ResourceNotFoundError' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/GeneralServerError' + summary: Retrieve a task + tags: + - Tasks + patch: + description: | + Updates a [task](/influxdb/cloud-serverless/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`. + Once InfluxDB applies the update, it cancels all previously scheduled runs of the task. + + To update a task, pass an object that contains the updated key-value pairs. + To activate or inactivate a task, set the `status` property. + _`"status": "inactive"`_ cancels scheduled runs and prevents manual runs of the task. + + #### InfluxDB Cloud + + - Use either `flux` or `scriptID` to provide the task script. + + - `flux`: a string of "raw" Flux that contains task options and the script--for example: + + ```json + { + "flux": "option task = {name: \"CPU Total 1 Hour New\", every: 1h}\ + from(bucket: \"telegraf\") + |> range(start: -1h) + |> filter(fn: (r) => (r._measurement == \"cpu\")) + |> filter(fn: (r) =>\n\t\t(r._field == \"usage_system\")) + |> filter(fn: (r) => (r.cpu == \"cpu-total\")) + |> aggregateWindow(every: 1h, fn: max) + |> to(bucket: \"cpu_usage_user_total_1h\", org: \"INFLUX_ORG\")", + "status": "active", + "description": "This task downsamples CPU data every hour" + } + ``` + + - `scriptID`: the ID of an [invokable script](#tag/Invokable-Scripts) + for the task to run. + To pass task options when using `scriptID`, pass the options as + properties in the request body--for example: + + ```json + { + "name": "CPU Total 1 Hour New", + "description": "This task downsamples CPU data every hour", + "every": "1h", + "scriptID": "SCRIPT_ID", + "scriptParameters": + { + "rangeStart": "-1h", + "bucket": "telegraf", + "filterField": "cpu-total" + } + } + ``` + + #### Limitations: + + - You can't use `flux` and `scriptID` for the same task. + operationId: PatchTasksID + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: | + A [task](/influxdb/cloud-serverless/reference/glossary/#task) ID. + Specifies the task to update. + in: path + name: taskID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TaskUpdateRequest' + description: An task update to apply. + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Task' + description: Success. The response body contains the updated task. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/AuthorizationError' + '404': + $ref: '#/components/responses/ResourceNotFoundError' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/GeneralServerError' + summary: Update a task + tags: + - Tasks + /api/v2/tasks/{taskID}/labels: + get: + description: | + Retrieves a list of all labels for a task. + + Labels may be used for grouping and filtering tasks. + operationId: GetTasksIDLabels + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The ID of the task to retrieve labels for. + in: path + name: taskID + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/LabelsResponse' + description: Success. The response body contains a list of all labels for the task. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/AuthorizationError' + '404': + $ref: '#/components/responses/ResourceNotFoundError' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/GeneralServerError' + summary: List labels for a task + tags: + - Tasks + post: + description: | + Adds a label to a task. + + Use this endpoint to add a label that you can use to filter tasks in the InfluxDB UI. + operationId: PostTasksIDLabels + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The ID of the task to label. + in: path + name: taskID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LabelMapping' + description: An object that contains a _`labelID`_ to add to the task. + required: true + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/LabelResponse' + description: Success. The response body contains a list of all labels for the task. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/AuthorizationError' + '404': + $ref: '#/components/responses/ResourceNotFoundError' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/GeneralServerError' + summary: Add a label to a task + tags: + - Tasks + /api/v2/tasks/{taskID}/labels/{labelID}: + delete: + description: | + Deletes a label from a task. + operationId: DeleteTasksIDLabelsID + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The ID of the task to delete the label from. + in: path + name: taskID + required: true + schema: + type: string + - description: The ID of the label to delete. + in: path + name: labelID + required: true + schema: + type: string + responses: + '204': + description: Success. The label is deleted. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/AuthorizationError' + '404': + $ref: '#/components/responses/ResourceNotFoundError' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/GeneralServerError' + summary: Delete a label from a task + tags: + - Tasks + /api/v2/tasks/{taskID}/logs: + get: + description: | + Retrieves a list of all logs for a [task](/influxdb/cloud-serverless/reference/glossary/#task). + + When an InfluxDB task runs, a “run” record is created in the task’s history. + Logs associated with each run provide relevant log messages, timestamps, and the exit status of the run attempt. + + Use this endpoint to retrieve only the log events for a task, + without additional task metadata. + operationId: GetTasksIDLogs + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The task ID. + in: path + name: taskID + required: true + schema: + type: string + responses: + '200': + content: + application/json: + examples: + taskFailure: + summary: Events for a failed task run. + value: + events: + - message: 'Started task from script: "option task = {name: \"test task\", every: 3d, offset: 0s}"' + runID: 09a946fc3167d000 + time: '2022-07-13T07:06:54.198167Z' + - message: Completed(failed) + runID: 09a946fc3167d000 + time: '2022-07-13T07:07:13.104037Z' + - message: 'error exhausting result iterator: error in query specification while starting program: this Flux script returns no streaming data. Consider adding a "yield" or invoking streaming functions directly, without performing an assignment' + runID: 09a946fc3167d000 + time: '2022-07-13T08:24:37.115323Z' + taskSuccess: + summary: Events for a successful task run. + value: + events: + - message: 'Started task from script: "option task = {name: \"task1\", every: 30m} from(bucket: \"iot_center\") |> range(start: -90d) |> filter(fn: (r) => r._measurement == \"environment\") |> aggregateWindow(every: 1h, fn: mean)"' + runID: 09b070dadaa7d000 + time: '2022-07-18T14:46:07.101231Z' + - message: Completed(success) + runID: 09b070dadaa7d000 + time: '2022-07-18T14:46:07.242859Z' + schema: + $ref: '#/components/schemas/Logs' + description: | + Success. The response body contains an `events` list with logs for the task. + Each log event `message` contains detail about the event. + If a task run fails, InfluxDB logs an event with the reason for the failure. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/AuthorizationError' + '404': + $ref: '#/components/responses/ResourceNotFoundError' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/GeneralServerError' + summary: Retrieve all logs for a task + tags: + - Tasks + /api/v2/tasks/{taskID}/members: + get: + deprecated: true + description: | + **Deprecated**: Tasks don't use `owner` and `member` roles. + Use [`/api/v2/authorizations`](#tag/Authorizations-(API-tokens)) to assign user permissions. + + Lists all users that have the `member` role for the specified [task](/influxdb/cloud-serverless/reference/glossary/#task). + operationId: GetTasksIDMembers + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The task ID. + in: path + name: taskID + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ResourceMembers' + description: | + Success. The response body contains a list of `users` that have + the `member` role for a task. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: List all task members + tags: + - Tasks + post: + deprecated: true + description: | + **Deprecated**: Tasks don't use `owner` and `member` roles. + Use [`/api/v2/authorizations`](#tag/Authorizations-(API-tokens)) to assign user permissions. + + Adds a user to members of a task and returns the member. + operationId: PostTasksIDMembers + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The task ID. + in: path + name: taskID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AddResourceMemberRequestBody' + description: A user to add as a member of the task. + required: true + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/ResourceMember' + description: Created. The user is added to task members. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Add a member to a task + tags: + - Tasks + /api/v2/tasks/{taskID}/members/{userID}: + delete: + deprecated: true + description: | + **Deprecated**: Tasks don't use `owner` and `member` roles. + Use [`/api/v2/authorizations`](#tag/Authorizations-(API-tokens)) to assign user permissions. + + Removes a member from a [task](/influxdb/cloud-serverless/reference/glossary/#task). + operationId: DeleteTasksIDMembersID + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The ID of the member to remove. + in: path + name: userID + required: true + schema: + type: string + - description: The task ID. + in: path + name: taskID + required: true + schema: + type: string + responses: + '204': + description: Member removed + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Remove a member from a task + tags: + - Tasks + /api/v2/tasks/{taskID}/owners: + get: + deprecated: true + description: | + **Deprecated**: Tasks don't use `owner` and `member` roles. + Use [`/api/v2/authorizations`](#tag/Authorizations-(API-tokens)) to assign user permissions. + + Retrieves all users that have owner permission for a task. + operationId: GetTasksIDOwners + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The ID of the task to retrieve owners for. + in: path + name: taskID + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ResourceOwners' + description: | + Success. + The response contains a list of `users` that have the `owner` role for the task. + + If the task has no owners, the response contains an empty `users` array. + '401': + $ref: '#/components/responses/AuthorizationError' + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: | + Unprocessable entity. + + The error may indicate one of the following problems: + + - The request body isn't valid--the request is well-formed, but InfluxDB can't process it due to semantic errors. + - You passed a parameter combination that InfluxDB doesn't support. + '500': + $ref: '#/components/responses/InternalServerError' + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: List all owners of a task + tags: + - Tasks + post: + deprecated: true + description: | + **Deprecated**: Tasks don't use `owner` and `member` roles. + Use [`/api/v2/authorizations`](#tag/Authorizations-(API-tokens)) to assign user permissions. + + Assigns a task `owner` role to a user. + + Use this endpoint to create a _resource owner_ for the task. + A _resource owner_ is a user with `role: owner` for a specific resource. + operationId: PostTasksIDOwners + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The task ID. + in: path + name: taskID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AddResourceMemberRequestBody' + description: A user to add as an owner of the task. + required: true + responses: + '201': + content: + application/json: + examples: + createdOwner: + summary: User has the owner role for the resource + value: + id: 0772396d1f411000 + links: + logs: /api/v2/users/0772396d1f411000/logs + self: /api/v2/users/0772396d1f411000 + name: USER_NAME + role: owner + status: active + schema: + $ref: '#/components/schemas/ResourceOwner' + description: | + Created. The task `owner` role is assigned to the user. + The response body contains the resource owner with + role and user detail. + '401': + $ref: '#/components/responses/AuthorizationError' + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: | + Unprocessable entity. + + The error may indicate one of the following problems: + + - The request body isn't valid--the request is well-formed, but InfluxDB can't process it due to semantic errors. + - You passed a parameter combination that InfluxDB doesn't support. + '500': + $ref: '#/components/responses/InternalServerError' + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Add an owner for a task + tags: + - Tasks + /api/v2/tasks/{taskID}/owners/{userID}: + delete: + deprecated: true + description: | + **Deprecated**: Tasks don't use `owner` and `member` roles. + Use [`/api/v2/authorizations`](#tag/Authorizations-(API-tokens)) to assign user permissions. + operationId: DeleteTasksIDOwnersID + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The ID of the owner to remove. + in: path + name: userID + required: true + schema: + type: string + - description: The task ID. + in: path + name: taskID + required: true + schema: + type: string + responses: + '204': + description: Owner removed + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Remove an owner from a task + tags: + - Tasks + /api/v2/tasks/{taskID}/runs: + get: + description: | + Retrieves a list of runs for a task. + + To limit which task runs are returned, pass query parameters in your request. + If no query parameters are passed, InfluxDB returns all task runs up to the default `limit`. + + operationId: GetTasksIDRuns + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: | + The ID of the task to get runs for. + Only returns runs for this task. + in: path + name: taskID + required: true + schema: + type: string + - description: A task run ID. Only returns runs created after this run. + in: query + name: after + schema: + type: string + - description: | + Limits the number of task runs returned. Default is `100`. + in: query + name: limit + schema: + default: 100 + maximum: 500 + minimum: 1 + type: integer + - description: | + A timestamp ([RFC3339 date/time format](/influxdb/cloud-serverless/reference/glossary/#rfc3339-timestamp)). + Only returns runs scheduled after this time. + in: query + name: afterTime + schema: + format: date-time + type: string + - description: | + A timestamp ([RFC3339 date/time format](/influxdb/cloud-serverless/reference/glossary/#rfc3339-timestamp)). + Only returns runs scheduled before this time. + in: query + name: beforeTime + schema: + format: date-time + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Runs' + description: Success. The response body contains the list of task runs. + '401': + $ref: '#/components/responses/AuthorizationError' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/GeneralServerError' + summary: List runs for a task + tags: + - Tasks + post: + description: | + Schedules a task run to start immediately, ignoring scheduled runs. + + Use this endpoint to manually start a task run. + Scheduled runs will continue to run as scheduled. + This may result in concurrently running tasks. + + To _retry_ a previous run (and avoid creating a new run), + use the [`POST /api/v2/tasks/{taskID}/runs/{runID}/retry` endpoint](#operation/PostTasksIDRunsIDRetry). + + operationId: PostTasksIDRuns + parameters: + - $ref: '#/components/parameters/TraceSpan' + - in: path + name: taskID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RunManually' + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/Run' + description: Success. The run is scheduled to start. + '401': + $ref: '#/components/responses/AuthorizationError' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/GeneralServerError' + summary: Start a task run, overriding the schedule + tags: + - Tasks + /api/v2/tasks/{taskID}/runs/{runID}: + delete: + description: | + Cancels a running [task](/influxdb/cloud-serverless/reference/glossary/#task). + + Use this endpoint with InfluxDB OSS to cancel a running task. + + #### InfluxDB Cloud + + - Doesn't support this operation. + + operationId: DeleteTasksIDRunsID + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The ID of the task to cancel. + in: path + name: taskID + required: true + schema: + type: string + - description: The ID of the task run to cancel. + in: path + name: runID + required: true + schema: + type: string + responses: + '204': + description: | + Success. The `DELETE` is accepted and the run will be cancelled. + + #### InfluxDB Cloud + + - Doesn't support this operation. + - Doesn't return this status. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/AuthorizationError' + '404': + $ref: '#/components/responses/ResourceNotFoundError' + '405': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: | + Method not allowed. + + #### InfluxDB Cloud + + - Always returns this error; doesn't support cancelling tasks. + + #### InfluxDB OSS + + - Doesn't return this error. + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/GeneralServerError' + summary: Cancel a running task + tags: + - Tasks + get: + description: | + Retrieves a specific run for a task. + + Use this endpoint to retrieve detail and logs for a specific task run. + + operationId: GetTasksIDRunsID + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The ID of the task to retrieve runs for. + in: path + name: taskID + required: true + schema: + type: string + - description: The ID of the run to retrieve. + in: path + name: runID + required: true + schema: + type: string + responses: + '200': + content: + application/json: + examples: + runSuccess: + summary: A successful task run. + value: + finishedAt: '2022-07-18T14:46:07.308254Z' + id: 09b070dadaa7d000 + links: + logs: /api/v2/tasks/0996e56b2f378000/runs/09b070dadaa7d000/logs + retry: /api/v2/tasks/0996e56b2f378000/runs/09b070dadaa7d000/retry + self: /api/v2/tasks/0996e56b2f378000/runs/09b070dadaa7d000 + task: /api/v2/tasks/0996e56b2f378000 + log: + - message: 'Started task from script: "option task = {name: \"task1\", every: 30m} from(bucket: \"iot_center\") |> range(start: -90d) |> filter(fn: (r) => r._measurement == \"environment\") |> aggregateWindow(every: 1h, fn: mean)"' + runID: 09b070dadaa7d000 + time: '2022-07-18T14:46:07.101231Z' + - message: Completed(success) + runID: 09b070dadaa7d000 + time: '2022-07-18T14:46:07.242859Z' + requestedAt: '2022-07-18T14:46:06Z' + scheduledFor: '2022-07-18T14:46:06Z' + startedAt: '2022-07-18T14:46:07.16222Z' + status: success + taskID: 0996e56b2f378000 + schema: + $ref: '#/components/schemas/Run' + description: Success. The response body contains the task run. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/AuthorizationError' + '404': + $ref: '#/components/responses/ResourceNotFoundError' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/GeneralServerError' + summary: Retrieve a run for a task. + tags: + - Tasks + /api/v2/tasks/{taskID}/runs/{runID}/logs: + get: + description: | + Retrieves 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 performance and troubleshoot failed task runs. + + operationId: GetTasksIDRunsIDLogs + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The ID of the task to get logs for. + in: path + name: taskID + required: true + schema: + type: string + - description: The ID of the run to get logs for. + in: path + name: runID + required: true + schema: + type: string + responses: + '200': + content: + application/json: + examples: + taskFailure: + summary: Events for a failed task. + value: + events: + - message: 'Started task from script: "option task = {name: \"test task\", every: 3d, offset: 0s}"' + runID: 09a946fc3167d000 + time: '2022-07-13T07:06:54.198167Z' + - message: Completed(failed) + runID: 09a946fc3167d000 + time: '2022-07-13T07:07:13.104037Z' + - message: 'error exhausting result iterator: error in query specification while starting program: this Flux script returns no streaming data. Consider adding a "yield" or invoking streaming functions directly, without performing an assignment' + runID: 09a946fc3167d000 + time: '2022-07-13T08:24:37.115323Z' + taskSuccess: + summary: Events for a successful task run. + value: + events: + - message: 'Started task from script: "option task = {name: \"task1\", every: 30m} from(bucket: \"iot_center\") |> range(start: -90d) |> filter(fn: (r) => r._measurement == \"environment\") |> aggregateWindow(every: 1h, fn: mean)"' + runID: 09b070dadaa7d000 + time: '2022-07-18T14:46:07.101231Z' + - message: Completed(success) + runID: 09b070dadaa7d000 + time: '2022-07-18T14:46:07.242859Z' + schema: + $ref: '#/components/schemas/Logs' + description: | + Success. The response body contains an `events` list with logs for the task run. + Each log event `message` contains detail about the event. + If a run fails, InfluxDB logs an event with the reason for the failure. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/AuthorizationError' + '404': + $ref: '#/components/responses/ResourceNotFoundError' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/GeneralServerError' + summary: Retrieve all logs for a run + tags: + - Tasks + /api/v2/tasks/{taskID}/runs/{runID}/retry: + post: + description: | + Queues a task run to + retry and returns the scheduled run. + + To manually start a _new_ task run, use the + [`POST /api/v2/tasks/{taskID}/runs` endpoint](#operation/PostTasksIDRuns). + + #### Limitations + + - The task must be _active_ (`status: "active"`). + operationId: PostTasksIDRunsIDRetry + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: | + A [task](/influxdb/cloud-serverless/reference/glossary/#task) ID. + Specifies the task to retry. + in: path + name: taskID + required: true + schema: + type: string + - description: | + A [task](/influxdb/cloud-serverless/reference/glossary/#task) run ID. + Specifies the task run to retry. + + To find a task run ID, use the + [`GET /api/v2/tasks/{taskID}/runs` endpoint](#operation/GetTasksIDRuns) + to list task runs. + in: path + name: runID + required: true + schema: + type: string + requestBody: + content: + application/json; charset=utf-8: + schema: + type: object + responses: + '200': + content: + application/json: + examples: + retryTaskRun: + summary: A task run scheduled to retry + value: + id: 09d60ffe08738000 + links: + logs: /api/v2/tasks/09a776832f381000/runs/09d60ffe08738000/logs + retry: /api/v2/tasks/09a776832f381000/runs/09d60ffe08738000/retry + self: /api/v2/tasks/09a776832f381000/runs/09d60ffe08738000 + task: /api/v2/tasks/09a776832f381000 + requestedAt: '2022-08-16T20:05:11.84145Z' + scheduledFor: '2022-08-15T00:00:00Z' + status: scheduled + taskID: 09a776832f381000 + schema: + $ref: '#/components/schemas/Run' + description: Success. The response body contains the queued run. + '400': + content: + application/json: + examples: + inactiveTask: + summary: Can't retry an inactive task + value: + code: invalid + message: 'failed to retry run: inactive task' + schema: + $ref: '#/components/schemas/Error' + description: | + Bad request. + The response body contains detail about the error. + + InfluxDB may return this error for the following reasons: + + - The task has `status: inactive`. + '401': + $ref: '#/components/responses/AuthorizationError' + '404': + $ref: '#/components/responses/ResourceNotFoundError' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/GeneralServerError' + summary: Retry a task run + tags: + - Tasks + /api/v2/telegraf/plugins: {} + /api/v2/telegrafs: + get: + operationId: GetTelegrafs + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The organization ID the Telegraf config belongs to. + in: query + name: orgID + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Telegrafs' + description: A list of Telegraf configurations + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: List all Telegraf configurations + tags: + - Telegrafs + post: + operationId: PostTelegrafs + parameters: + - $ref: '#/components/parameters/TraceSpan' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TelegrafPluginRequest' + description: Telegraf configuration to create + required: true + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/Telegraf' + description: Telegraf configuration created + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Create a Telegraf configuration + tags: + - Telegrafs + /api/v2/telegrafs/{telegrafID}: + delete: + operationId: DeleteTelegrafsID + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The Telegraf configuration ID. + in: path + name: telegrafID + required: true + schema: + type: string + responses: + '204': + description: Delete has been accepted + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Delete a Telegraf configuration + tags: + - Telegrafs + get: + operationId: GetTelegrafsID + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The Telegraf configuration ID. + in: path + name: telegrafID + required: true + schema: + type: string + - in: header + name: Accept + required: false + schema: + default: application/toml + enum: + - application/toml + - application/json + - application/octet-stream + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Telegraf' + application/octet-stream: + example: |- + [agent] + interval = "10s" + schema: + type: string + application/toml: + example: |- + [agent] + interval = "10s" + schema: + type: string + description: Telegraf configuration details + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Retrieve a Telegraf configuration + tags: + - Telegrafs + put: + operationId: PutTelegrafsID + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The Telegraf config ID. + in: path + name: telegrafID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TelegrafPluginRequest' + description: Telegraf configuration update to apply + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Telegraf' + description: An updated Telegraf configurations + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Update a Telegraf configuration + tags: + - Telegrafs + /api/v2/telegrafs/{telegrafID}/labels: + get: + operationId: GetTelegrafsIDLabels + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The Telegraf config ID. + in: path + name: telegrafID + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/LabelsResponse' + description: A list of all labels for a Telegraf config + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: List all labels for a Telegraf config + tags: + - Telegrafs + post: + operationId: PostTelegrafsIDLabels + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The Telegraf config ID. + in: path + name: telegrafID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LabelMapping' + description: Label to add + required: true + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/LabelResponse' + description: The label added to the Telegraf config + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Add a label to a Telegraf config + tags: + - Telegrafs + /api/v2/telegrafs/{telegrafID}/labels/{labelID}: + delete: + operationId: DeleteTelegrafsIDLabelsID + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The Telegraf config ID. + in: path + name: telegrafID + required: true + schema: + type: string + - description: The label ID. + in: path + name: labelID + required: true + schema: + type: string + responses: + '204': + description: Delete has been accepted + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Telegraf config not found + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Delete a label from a Telegraf config + tags: + - Telegrafs + /api/v2/telegrafs/{telegrafID}/members: + get: + operationId: GetTelegrafsIDMembers + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The Telegraf config ID. + in: path + name: telegrafID + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ResourceMembers' + description: A list of Telegraf config members + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: List all users with member privileges for a Telegraf config + tags: + - Telegrafs + post: + operationId: PostTelegrafsIDMembers + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The Telegraf config ID. + in: path + name: telegrafID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AddResourceMemberRequestBody' + description: User to add as member + required: true + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/ResourceMember' + description: Member added to Telegraf config + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Add a member to a Telegraf config + tags: + - Telegrafs + /api/v2/telegrafs/{telegrafID}/members/{userID}: + delete: + operationId: DeleteTelegrafsIDMembersID + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The ID of the member to remove. + in: path + name: userID + required: true + schema: + type: string + - description: The Telegraf config ID. + in: path + name: telegrafID + required: true + schema: + type: string + responses: + '204': + description: Member removed + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Remove a member from a Telegraf config + tags: + - Telegrafs + /api/v2/telegrafs/{telegrafID}/owners: + get: + operationId: GetTelegrafsIDOwners + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The Telegraf configuration ID. + in: path + name: telegrafID + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ResourceOwners' + description: Returns Telegraf configuration owners as a ResourceOwners list + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: List all owners of a Telegraf configuration + tags: + - Telegrafs + post: + operationId: PostTelegrafsIDOwners + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The Telegraf configuration ID. + in: path + name: telegrafID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AddResourceMemberRequestBody' + description: User to add as owner + required: true + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/ResourceOwner' + description: Telegraf configuration owner was added. Returns a ResourceOwner that references the User. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Add an owner to a Telegraf configuration + tags: + - Telegrafs + /api/v2/telegrafs/{telegrafID}/owners/{userID}: + delete: + operationId: DeleteTelegrafsIDOwnersID + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The ID of the owner to remove. + in: path + name: userID + required: true + schema: + type: string + - description: The Telegraf config ID. + in: path + name: telegrafID + required: true + schema: + type: string + responses: + '204': + description: Owner removed + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Remove an owner from a Telegraf config + tags: + - Telegrafs + /api/v2/templates/apply: + post: + description: | + Applies a template to + create or update a stack of InfluxDB + resources. + The response contains the diff of changes and the stack ID. + + Use this endpoint to install an InfluxDB template to an organization. + Provide template URLs or template objects in your request. + To customize which template resources are installed, use the `actions` + parameter. + + By default, when you apply a template, InfluxDB installs the template to + create and update stack resources and then generates a diff of the changes. + If you pass `dryRun: true` in the request body, InfluxDB validates the + template and generates the resource diff, but doesn’t make any + changes to your instance. + + #### Custom values for templates + + - Some templates may contain environment references for custom metadata. + To provide custom values for environment references, pass the _`envRefs`_ + property in the request body. + + - Some templates may contain queries that use + [secrets](/influxdb/cloud-serverless/reference/glossary/#secret). + To provide custom secret values, pass the _`secrets`_ property + in the request body. + Don't expose secret values in templates. + + #### Required permissions + + - `write` permissions for resource types in the template. + + #### Rate limits (with InfluxDB Cloud) + + - Adjustable service quotas apply. + For more information, see [limits and adjustable quotas](/influxdb/cloud-serverless/account-management/limits/). + + + operationId: ApplyTemplate + requestBody: + content: + application/json: + examples: + skipKindAction: + summary: Skip all bucket and task resources in the provided templates + value: + actions: + - action: skipKind + properties: + kind: Bucket + - action: skipKind + properties: + kind: Task + orgID: INFLUX_ORG_ID + templates: + - contents: + - '[object Object]': null + skipResourceAction: + summary: Skip specific resources in the provided templates + value: + actions: + - action: skipResource + properties: + kind: Label + resourceTemplateName: foo-001 + - action: skipResource + properties: + kind: Bucket + resourceTemplateName: bar-020 + - action: skipResource + properties: + kind: Bucket + resourceTemplateName: baz-500 + orgID: INFLUX_ORG_ID + templates: + - contents: + - apiVersion: influxdata.com/v2alpha1 + kind: Bucket + metadata: + name: baz-500 + templateObjectEnvRefs: + summary: envRefs for template objects + value: + envRefs: + docker-bucket: MY_DOCKER_BUCKET + docker-spec-1: MY_DOCKER_SPEC + linux-cpu-label: MY_CPU_LABEL + orgID: INFLUX_ORG_ID + templates: + - contents: + - apiVersion: influxdata.com/v2alpha1 + kind: Label + metadata: + name: + envRef: + key: linux-cpu-label + spec: + color: '#326BBA' + name: inputs.cpu + - contents: + - apiVersion: influxdata.com/v2alpha1 + kind: Bucket + metadata: + name: + envRef: + key: docker-bucket + schema: + $ref: '#/components/schemas/TemplateApply' + application/x-jsonnet: + schema: + $ref: '#/components/schemas/TemplateApply' + text/yml: + schema: + $ref: '#/components/schemas/TemplateApply' + description: | + Parameters for applying templates. + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TemplateSummary' + description: | + Success. + The template dry run succeeded. + The response body contains a resource diff of changes that the + template would have made if installed. + No resources were created or updated. + The diff and summary won't contain IDs for resources + that didn't exist at the time of the dry run. + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/TemplateSummary' + description: | + Success. + The template applied successfully. + The response body contains the stack ID, a diff, and a summary. + The diff compares the initial state to the state after the template installation. + The summary contains newly created resources. + '422': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/TemplateSummary' + - properties: + code: + type: string + message: + type: string + required: + - message + - code + type: object + description: | + Unprocessable entity. + + + The error may indicate one of the following problems: + + - The template failed validation. + - You passed a parameter combination that InfluxDB doesn't support. + '500': + content: + application/json: + examples: + createExceedsQuota: + summary: 'InfluxDB Cloud: Creating resource would exceed quota.' + value: + code: internal error + message: "resource_type=\"tasks\" err=\"failed to apply resource\"\n\tmetadata_name=\"alerting-gates-b84003\" err_msg=\"failed to create tasks[\\\"alerting-gates-b84003\\\"]: creating task would exceed quota\"" + schema: + $ref: '#/components/schemas/Error' + description: | + Internal server error. + + #### InfluxDB Cloud + + - Returns this error if creating one of the template + resources (bucket, dashboard, task, user) exceeds your plan’s + adjustable service quotas. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Apply or dry-run a template + tags: + - Templates + x-codeSamples: + - label: 'cURL: Dry run with a remote template' + lang: Shell + source: | + curl --request POST "http://localhost:8086/api/v2/templates/apply" \ + --header "Authorization: Token INFLUX_API_TOKEN" \ + --data @- << EOF + { + "dryRun": true, + "orgID": "INFLUX_ORG_ID", + "remotes": [ + { + "url": "https://raw.githubusercontent.com/influxdata/community-templates/master/linux_system/linux_system.yml" + } + ] + } + EOF + - label: 'cURL: Apply with secret values' + lang: Shell + source: | + curl "http://localhost:8086/api/v2/templates/apply" \ + --header "Authorization: Token INFLUX_API_TOKEN" \ + --data @- << EOF | jq . + { + "orgID": "INFLUX_ORG_ID", + "secrets": { + "SLACK_WEBHOOK": "YOUR_SECRET_WEBHOOK_URL" + }, + "remotes": [ + { + "url": "https://raw.githubusercontent.com/influxdata/community-templates/master/fortnite/fn-template.yml" + } + ] + } + EOF + - label: 'cURL: Apply template objects with environment references' + lang: Shell + source: | + curl --request POST "http://localhost:8086/api/v2/templates/apply" \ + --header "Authorization: Token INFLUX_API_TOKEN" \ + --data @- << EOF + { "orgID": "INFLUX_ORG_ID", + "envRefs": { + "linux-cpu-label": "MY_CPU_LABEL", + "docker-bucket": "MY_DOCKER_BUCKET", + "docker-spec-1": "MY_DOCKER_SPEC" + }, + "templates": [ + { "contents": [{ + "apiVersion": "influxdata.com/v2alpha1", + "kind": "Label", + "metadata": { + "name": { + "envRef": { + "key": "linux-cpu-label" + } + } + }, + "spec": { + "color": "#326BBA", + "name": "inputs.cpu" + } + }] + }, + "templates": [ + { "contents": [{ + "apiVersion": "influxdata.com/v2alpha1", + "kind": "Label", + "metadata": { + "name": { + "envRef": { + "key": "linux-cpu-label" + } + } + }, + "spec": { + "color": "#326BBA", + "name": "inputs.cpu" + } + }] + }, + { "contents": [{ + "apiVersion": "influxdata.com/v2alpha1", + "kind": "Bucket", + "metadata": { + "name": { + "envRef": { + "key": "docker-bucket" + } + } + } + }] + } + ] + } + EOF + /api/v2/templates/export: + post: + operationId: ExportTemplate + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/TemplateExportByID' + - $ref: '#/components/schemas/TemplateExportByName' + description: Export resources as an InfluxDB template. + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Template' + application/x-yaml: + schema: + $ref: '#/components/schemas/Template' + description: The template was created successfully. Returns the newly created template. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Export a new template + tags: + - Templates + /api/v2/users: {} + /api/v2/users/{userID}: {} + /api/v2/users/{userID}/password: {} + /api/v2/variables: + get: + operationId: GetVariables + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The name of the organization. + in: query + name: org + schema: + type: string + - description: The organization ID. + in: query + name: orgID + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Variables' + description: A list of variables for an organization. + '400': + $ref: '#/components/responses/GeneralServerError' + description: Invalid request + default: + $ref: '#/components/responses/GeneralServerError' + description: Internal server error + summary: List all variables + tags: + - Variables + post: + operationId: PostVariables + parameters: + - $ref: '#/components/parameters/TraceSpan' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Variable' + description: Variable to create + required: true + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/Variable' + description: Variable created + default: + $ref: '#/components/responses/GeneralServerError' + description: Internal server error + summary: Create a variable + tags: + - Variables + /api/v2/variables/{variableID}: + delete: + operationId: DeleteVariablesID + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The variable ID. + in: path + name: variableID + required: true + schema: + type: string + responses: + '204': + description: Variable deleted + default: + $ref: '#/components/responses/GeneralServerError' + description: Internal server error + summary: Delete a variable + tags: + - Variables + get: + operationId: GetVariablesID + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The variable ID. + in: path + name: variableID + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Variable' + description: Variable found + '404': + $ref: '#/components/responses/GeneralServerError' + description: Variable not found + default: + $ref: '#/components/responses/GeneralServerError' + description: Internal server error + summary: Retrieve a variable + tags: + - Variables + patch: + operationId: PatchVariablesID + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The variable ID. + in: path + name: variableID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Variable' + description: Variable update to apply + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Variable' + description: Variable updated + default: + $ref: '#/components/responses/GeneralServerError' + description: Internal server error + summary: Update a variable + tags: + - Variables + put: + operationId: PutVariablesID + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The variable ID. + in: path + name: variableID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Variable' + description: Variable to replace + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Variable' + description: Variable updated + default: + $ref: '#/components/responses/GeneralServerError' + description: Internal server error + summary: Replace a variable + tags: + - Variables + /api/v2/variables/{variableID}/labels: + get: + operationId: GetVariablesIDLabels + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The variable ID. + in: path + name: variableID + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/LabelsResponse' + description: A list of all labels for a variable + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: List all labels for a variable + tags: + - Variables + post: + operationId: PostVariablesIDLabels + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The variable ID. + in: path + name: variableID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LabelMapping' + description: Label to add + required: true + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/LabelResponse' + description: The newly added label + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Add a label to a variable + tags: + - Variables + /api/v2/variables/{variableID}/labels/{labelID}: + delete: + operationId: DeleteVariablesIDLabelsID + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The variable ID. + in: path + name: variableID + required: true + schema: + type: string + - description: The label ID to delete. + in: path + name: labelID + required: true + schema: + type: string + responses: + '204': + description: Delete has been accepted + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Variable not found + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Delete a label from a variable + tags: + - Variables + /api/v2/write: + post: + description: | + Writes data to a bucket. + + Use this endpoint to send data in [line protocol](/influxdb/cloud-serverless/reference/syntax/line-protocol/) format to InfluxDB. + + InfluxDB Cloud Serverless does the following when you send a write request: + + 1. Validates the request. + 2. If successful, attempts to [ingest data](/influxdb/cloud-serverless/reference/internals/durability/#data-ingest) from the request body; otherwise, responds with an [error status](/influxdb/cloud-serverless/write-data/troubleshoot/#review-http-status-codes). + 3. Ingests or rejects data in the batch and returns one of the following HTTP status codes: + + - `204 No Content`: All data in the batch is ingested. + - `400 Bad Request`: Data from the batch was rejected and not written. The response body indicates if a partial write occurred. + + The response body contains error details about [rejected points](/influxdb/cloud-serverless/write-data/troubleshoot/#troubleshoot-rejected-points), up to 100 points. + + Writes are synchronous--the response status indicates the final status of the write and all ingested data is queryable. + + To ensure that InfluxDB handles writes in the order you request them, + wait for the response before you send the next request. + + #### Write endpoints + + The [`/write`](#operation/PostLegacyWrite) and [`/api/v2/write`](#operation/PostWrite) endpoints are functionally equivalent for writing data to InfluxDB Cloud Serverless. + + - Use the [`/write` endpoint](#operation/PostLegacyWrite) for [InfluxDB v1 parameter compatibility](/influxdb/cloud-serverless/guides/api-compatibility/v1/). + - Use [`/api/v2/write` endpoint](#operation/PostWrite) for [InfluxDB v2 parameter compatibility](/influxdb/cloud-serverless/guides/api-compatibility/v2/). + + #### Rate limits + + _Write_ rate limits apply. + For more information, see [limits and adjustable quotas](/influxdb/cloud-serverless/admin/billing/limits/). + + #### Related guides + + - [Get started writing data](/influxdb/cloud-serverless/get-started/write/) + - [Write data with the InfluxDB API](/influxdb/cloud-serverless/get-started/write/) + - [Best practices for writing data](/influxdb/cloud-serverless/write-data/best-practices/) + - [Troubleshoot issues writing data](/influxdb/cloud-serverless/write-data/troubleshoot/) + operationId: PostWrite + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: | + The compression applied to the line protocol in the request payload. + To send a gzip payload, pass `Content-Encoding: gzip` header. + in: header + name: Content-Encoding + schema: + default: identity + description: | + Content coding. + Use `gzip` for compressed data or `identity` for unmodified, uncompressed data. + enum: + - gzip + - identity + type: string + - description: | + The format of the data in the request body. + To send a line protocol payload, pass `Content-Type: text/plain; charset=utf-8`. + in: header + name: Content-Type + schema: + default: text/plain; charset=utf-8 + description: | + `text/plain` is the content type for line protocol. `UTF-8` is the default character set. + enum: + - text/plain + - text/plain; charset=utf-8 + type: string + - description: | + The size of the entity-body, in bytes, sent to InfluxDB. + If the length is greater than the `max body` configuration option, + the server responds with status code `413`. + in: header + name: Content-Length + schema: + description: The length in decimal number of octets. + type: integer + - description: | + The content type that the client can understand. + Writes only return a response body if they fail--for example, + due to a formatting problem or quota limit. + + #### InfluxDB Cloud Serverless + + - Returns only `application/json` for format and limit errors. + - Returns only `text/html` for some quota limit errors. + + #### Related guides + + - [Troubleshoot issues writing data](/influxdb/cloud-serverless/write-data/troubleshoot/) + in: header + name: Accept + schema: + default: application/json + description: Error content type. + enum: + - application/json + type: string + - description: | + An organization name or ID. + + InfluxDB Cloud Serverless writes data to the bucket in the organization associated with the authorization (API token); + doesn't use the `org` parameter or `orgID` parameter. + in: query + name: org + required: true + schema: + description: The organization name or ID. + type: string + - description: | + An organization ID. + + InfluxDB Cloud Serverless writes data to the bucket in the organization associated with the authorization (API token); + doesn't use the `org` parameter or `orgID` parameter. + in: query + name: orgID + schema: + type: string + - description: | + A bucket name or ID. + InfluxDB writes all points in the batch to the specified bucket. + in: query + name: bucket + required: true + schema: + description: The bucket name or ID. + type: string + - description: The precision for unix timestamps in the line protocol batch. + in: query + name: precision + schema: + $ref: '#/components/schemas/WritePrecision' + requestBody: + content: + text/plain: + examples: + plain-utf8: + value: | + airSensors,sensor_id=TLM0201 temperature=73.97038159354763,humidity=35.23103248356096,co=0.48445310567793615 1630424257000000000 + airSensors,sensor_id=TLM0202 temperature=75.30007505999716,humidity=35.651929918691714,co=0.5141876544505826 1630424257000000000 + schema: + format: byte + type: string + description: | + In the request body, provide data in [line protocol format](/influxdb/cloud-serverless/reference/syntax/line-protocol/). + + To send compressed data, do the following: + + 1. Use [gzip](https://www.gzip.org/) to compress the line protocol data. + 2. In your request, send the compressed data and the + `Content-Encoding: gzip` header. + + #### Related guides + + - [Best practices for optimizing writes](/influxdb/cloud-serverless/write-data/best-practices/optimize-writes/) + required: true + responses: + '204': + description: Success ("No Content"). All data in the batch is written and queryable. + '400': + description: | + Data from the batch was rejected and not written. The response body indicates if a partial write occurred or all data was rejected. + If a partial write occurred, then some points from the batch are written and queryable. + + The response body contains details about the [rejected points](/influxdb/cloud-serverless/write-data/troubleshoot/#troubleshoot-rejected-points), up to 100 points. + content: + application/json: + examples: + rejectedAllPoints: + summary: Rejected all points + value: + code: invalid + line: 2 + message: 'no data written, errors encountered on line(s): error message for first rejected point error message for second rejected point error message for Nth rejected point (up to 100 rejected points)' + partialWriteErrorWithRejectedPoints: + summary: Partial write rejects some points + value: + code: invalid + line: 2 + message: 'partial write has occurred, errors encountered on line(s): error message for first rejected point error message for second rejected point error message for Nth rejected point (up to 100 rejected points)' + schema: + $ref: '#/components/schemas/LineProtocolError' + '401': + $ref: '#/components/responses/AuthorizationError' + '404': + $ref: '#/components/responses/ResourceNotFoundError' + '413': + content: + application/json: + examples: + dataExceedsSizeLimitOSS: + summary: InfluxDB OSS response + value: | + {"code":"request too large","message":"unable to read data: points batch is too large"} + schema: + $ref: '#/components/schemas/LineProtocolLengthError' + text/html: + examples: + dataExceedsSizeLimit: + summary: InfluxDB Cloud response + value: | + + 413 Request Entity Too Large + +

413 Request Entity Too Large

+
+
nginx
+ + + schema: + type: string + description: | + The request payload is too large. + InfluxDB rejected the batch and did not write any data. + + InfluxDB returns this error if the payload exceeds the 50MB size limit or all data is outside the retention window. + '429': + description: | + Too many requests. + + #### InfluxDB Cloud + + - Returns this error if a **read** or **write** request exceeds your plan's [adjustable service quotas](/influxdb/cloud-serverless/account-management/limits/#adjustable-service-quotas) + or if a **delete** request exceeds the maximum [global limit](/influxdb/cloud-serverless/account-management/limits/#global-limits). + - For rate limits that reset automatically, returns a `Retry-After` header that describes when to try the write again. + - For limits that can't reset (for example, **cardinality limit**), doesn't return a `Retry-After` header. + + Rates (data-in (writes), queries (reads), and deletes) accrue within a fixed five-minute window. + Once a rate limit is exceeded, InfluxDB returns an error response until the current five-minute window resets. + headers: + Retry-After: + description: Non-negative decimal integer indicating seconds to wait before retrying the request. + schema: + format: int32 + type: integer + '500': + $ref: '#/components/responses/InternalServerError' + '503': + description: | + Service unavailable. + + - Returns this error if + the server is temporarily unavailable to accept writes. + - Returns a `Retry-After` header that describes when to try the write again. + headers: + Retry-After: + description: Non-negative decimal integer indicating seconds to wait before retrying the request. + schema: + format: int32 + type: integer + default: + $ref: '#/components/responses/GeneralServerError' + summary: Write data + tags: + - Data I/O endpoints + - Write + /legacy/authorizations: + servers: + - url: /private + /legacy/authorizations/{authID}: + servers: + - url: /private + /legacy/authorizations/{authID}/password: + servers: + - url: /private + /query: + get: + description: | + Queries InfluxDB using InfluxQL with InfluxDB v1 request and response formats. + + #### Related guides + + - [Use the InfluxDB v1 HTTP API](/influxdb/cloud-serverless/guides/api-compatibility/v1/) + - [Query data](/influxdb/cloud-serverless/query-data/) + operationId: GetLegacyQuery + parameters: + - $ref: '#/components/parameters/TraceSpan' + - in: header + name: Accept + schema: + default: application/json + description: | + Media type that the client can understand. + + **Note**: With `application/csv`, query results include [**unix timestamps**](/influxdb/cloud-serverless/reference/glossary/#unix-timestamp) instead of [RFC3339 timestamps](/influxdb/cloud-serverless/reference/glossary/#rfc3339-timestamp). + enum: + - application/json + - application/csv + - text/csv + - application/x-msgpack + type: string + - description: The content encoding (usually a compression algorithm) that the client can understand. + in: header + name: Accept-Encoding + schema: + default: identity + description: The content coding. Use `gzip` for compressed data or `identity` for unmodified, uncompressed data. + enum: + - gzip + - identity + type: string + - in: header + name: Content-Type + schema: + enum: + - application/json + type: string + - description: The InfluxDB 1.x username to authenticate the request. + in: query + name: u + schema: + type: string + - description: The InfluxDB 1.x password to authenticate the request. + in: query + name: p + schema: + type: string + - description: | + The database to query data from. + This is mapped to an InfluxDB [bucket](/influxdb/cloud-serverless/reference/glossary/#bucket). + For more information, see [Database and retention policy mapping](/influxdb/cloud/reference/api/influxdb-1x/dbrp/). + in: query + name: db + required: true + schema: + type: string + - description: | + The retention policy to query data from. + This is mapped to an InfluxDB [bucket](/influxdb/cloud-serverless/reference/glossary/#bucket). + For more information, see [Database and retention policy mapping](/influxdb/cloud/reference/api/influxdb-1x/dbrp/). + in: query + name: rp + schema: + type: string + - description: The InfluxQL query to execute. To execute multiple queries, delimit queries with a semicolon (`;`). + in: query + name: q + required: true + schema: + type: string + - description: | + A unix timestamp precision. + Formats timestamps as [unix (epoch) timestamps](/influxdb/cloud-serverless/reference/glossary/#unix-timestamp) the specified precision + instead of [RFC3339 timestamps](/influxdb/cloud-serverless/reference/glossary/#rfc3339-timestamp) with nanosecond precision. + in: query + name: epoch + schema: + enum: + - ns + - u + - µ + - ms + - s + - m + - h + type: string + responses: + '200': + content: + application/csv: + schema: + $ref: '#/components/schemas/InfluxqlCsvResponse' + application/json: + schema: + $ref: '#/components/schemas/InfluxqlJsonResponse' + examples: + influxql-chunk_size_2: + value: | + {"results":[{"statement_id":0,"series":[{"name":"mymeas","columns":["time","myfield","mytag"],"values":[["2016-05-19T18:37:55Z",90,"1"],["2016-05-19T18:37:56Z",90,"1"]],"partial":true}],"partial":true}]} + {"results":[{"statement_id":0,"series":[{"name":"mymeas","columns":["time","myfield","mytag"],"values":[["2016-05-19T18:37:57Z",90,"1"],["2016-05-19T18:37:58Z",90,"1"]]}]}]} + application/x-msgpack: + schema: + format: binary + type: string + text/csv: + schema: + $ref: '#/components/schemas/InfluxqlCsvResponse' + description: | + Query results. + + If a DBRP doesn't exist for the `db=DATABASE_NAME` and `rp=RETENTION_POLICY_NAME` combination in the query request, the response body contains an error message, for example `"database not found:..."`. + headers: + Content-Encoding: + description: Lists encodings (usually compression algorithms) that have been applied to the response payload. + schema: + default: identity + description: | + The content coding: + - `gzip`: compressed data + - `identity`: unmodified, uncompressed data. + enum: + - gzip + - identity + type: string + Trace-Id: + description: The trace ID, if generated, of the request. + schema: + description: Trace ID of a request. + type: string + '429': + description: | + #### InfluxDB Cloud: + - returns this error if a **read** or **write** request exceeds your + plan's [adjustable service quotas](/influxdb/cloud-serverless/account-management/limits/#adjustable-service-quotas) + or if a **delete** request exceeds the maximum + [global limit](/influxdb/cloud-serverless/account-management/limits/#global-limits) + - returns `Retry-After` header that describes when to try the write again. + headers: + Retry-After: + description: A non-negative decimal integer indicating the seconds to delay after the response is received. + schema: + format: int32 + type: integer + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Error processing query + summary: Query using the InfluxDB v1 HTTP API + tags: + - Data I/O endpoints + - Query + /write: + post: + operationId: PostLegacyWrite + description: | + Writes data to a bucket. + + Use this endpoint for [InfluxDB v1 parameter compatibility](/influxdb/cloud-serverless/guides/api-compatibility/v1/) when sending data in [line protocol](/influxdb/cloud-serverless/reference/syntax/line-protocol/) format to InfluxDB. + + InfluxDB Cloud Serverless does the following when you send a write request: + + 1. Validates the request. + 2. If successful, attempts to [ingest data](/influxdb/cloud-serverless/reference/internals/durability/#data-ingest) from the request body; otherwise, responds with an [error status](/influxdb/cloud-serverless/write-data/troubleshoot/#review-http-status-codes). + 3. Ingests or rejects data in the batch and returns one of the following HTTP status codes: + + - `204 No Content`: all data in the batch is ingested + - `201 Created`: some points in the batch are ingested and queryable, and some points are rejected + - `400 Bad Request`: all data is rejected + + The response body contains error details about [rejected points](/influxdb/cloud-serverless/write-data/troubleshoot/#troubleshoot-rejected-points), up to 100 points. + + Writes are synchronous--the response status indicates the final status of the write and all ingested data is queryable. + + To ensure that InfluxDB handles writes in the order you request them, + wait for the response before you send the next request. + + #### Write endpoints + + The [`/write`](#operation/PostLegacyWrite) and [`/api/v2/write`](#operation/PostWrite) endpoints are functionally equivalent for writing data to InfluxDB Cloud Serverless. + + - Use the [`/write` endpoint](#operation/PostLegacyWrite) for [InfluxDB v1 parameter compatibility](/influxdb/cloud-serverless/guides/api-compatibility/v1/). + - Use [`/api/v2/write` endpoint](#operation/PostWrite) for [InfluxDB v2 parameter compatibility](/influxdb/cloud-serverless/guides/api-compatibility/v2/). + + #### Rate limits + + _Write_ rate limits apply. + For more information, see [limits and adjustable quotas](/influxdb/cloud-serverless/admin/billing/limits/). + + #### Related guides + + - [Write data with the InfluxDB API](/influxdb/cloud-serverless/get-started/write/) + - [Optimize writes to InfluxDB](/influxdb/cloud-serverless/write-data/best-practices/optimize-writes/) + - [Troubleshoot issues writing data](/influxdb/cloud-serverless/write-data/troubleshoot/) + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The InfluxDB 1.x username to authenticate the request. + in: query + name: u + schema: + type: string + - description: The InfluxDB 1.x password to authenticate the request. + in: query + name: p + schema: + type: string + - description: Bucket to write to. If none exists, InfluxDB creates a bucket with a default 3-day retention policy. + in: query + name: db + required: true + schema: + type: string + - description: Retention policy name. + in: query + name: rp + schema: + type: string + - description: Write precision. + in: query + name: precision + schema: + type: string + - description: When present, indicates that compression is applied to the line protocol body. + in: header + name: Content-Encoding + schema: + default: identity + description: Specifies that the line protocol in the body is encoded with gzip or not encoded with identity. + enum: + - gzip + - identity + type: string + requestBody: + content: + text/plain: + schema: + type: string + description: Line protocol body + required: true + responses: + '201': + description: | + Success ("Created"). Some points in the batch are written and queryable, and some points are rejected. The response body contains details about the [rejected points](/influxdb/cloud-serverless/write-data/troubleshoot/#troubleshoot-rejected-points), up to 100 points. + content: + application/json: + examples: + partialWriteErrorWithRejectedPoints: + summary: Partial write rejects points with syntax errors + value: + code: invalid + line: 2 + message: 'failed to parse line protocol: errors encountered on line(s): error message for first rejected point error message for second rejected point error message for Nth rejected point (up to 100 rejected points)' + schema: + $ref: '#/components/schemas/LineProtocolError' + '204': + description: Success ("No Content"). All data in the batch is written and queryable. + '400': + description: | + All data in the batch is rejected and not written. + + The response body contains details about the [rejected points](/influxdb/cloud-serverless/write-data/troubleshoot/#troubleshoot-rejected-points). + content: + application/json: + examples: + rejectsAllPoints: + summary: Rejected all points + value: + code: invalid + line: 2 + message: 'failed to parse line protocol: errors encountered on line(s): error message for first rejected point error message for second rejected point error message for Nth rejected point (up to 100 rejected points)' + schema: + $ref: '#/components/schemas/LineProtocolError' + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Token doesn't have sufficient permissions to write to this organization and bucket or the organization and bucket do not exist. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: No token was sent and they are required. + '413': + content: + application/json: + schema: + $ref: '#/components/schemas/LineProtocolLengthError' + description: Write has been rejected because the payload is too large. Error message returns max size supported. All data in body was rejected and not written. + '429': + description: Token is temporarily over quota. The Retry-After header describes when to try the write again. + headers: + Retry-After: + description: A non-negative decimal integer indicating the seconds to delay after the response is received. + schema: + format: int32 + type: integer + '503': + description: Server is temporarily unavailable to accept writes. The Retry-After header describes when to try the write again. + headers: + Retry-After: + description: A non-negative decimal integer indicating the seconds to delay after the response is received. + schema: + format: int32 + type: integer + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Internal server error + summary: Write data using the InfluxDB v1 HTTP API + tags: + - Data I/O endpoints + - Write +components: + examples: + AuthorizationPostRequest: + description: Creates an authorization. + summary: An authorization for a resource type + value: + description: iot_users read buckets + orgID: INFLUX_ORG_ID + permissions: + - action: read + resource: + type: buckets + AuthorizationWithResourcePostRequest: + description: Creates an authorization for access to a specific resource. + summary: An authorization for a resource + value: + description: iot_users read buckets + orgID: INFLUX_ORG_ID + permissions: + - action: read + resource: + id: INFLUX_BUCKET_ID + type: buckets + AuthorizationWithUserPostRequest: + description: Creates an authorization scoped to a specific user. + summary: An authorization scoped to a user + value: + description: iot_user write to bucket + orgID: INFLUX_ORG_ID + permissions: + - action: write + resource: + id: INFLUX_BUCKET_ID + type: buckets + userID: INFLUX_USER_ID + TaskWithFluxRequest: + description: Sets the `flux` property with Flux task options and a query. + summary: A task with Flux + value: + description: This task contains Flux that configures the task schedule and downsamples CPU data every hour. + flux: "option task = {name: \"CPU Total 1 Hour New\", every: 1h}from(bucket: \"telegraf\") |> range(start: -1h) |> filter(fn: (r) => (r._measurement == \"cpu\")) |> filter(fn: (r) =>\n\t\t(r._field == \"usage_system\")) |> filter(fn: (r) => (r.cpu == \"cpu-total\")) |> aggregateWindow(every: 1h, fn: max) |> to(bucket: \"cpu_usage_user_total_1h\", org: \"INFLUX_ORG\")" + status: active + TaskWithScriptRequest: + description: | + Sets properties for a task that runs an _invokable script_. + summary: A task with an invokable script + value: + description: This task runs an invokable script every hour with the defined parameters. + every: 1h + name: CPU Total 1 Hour New + scriptID: SCRIPT_ID + scriptParameters: + bucket: telegraf + filterField: cpu-total + rangeStart: '-1h' + status: active + parameters: + After: + description: | + A resource ID to seek from. + Returns records created after the specified record; + results don't include the specified record. + + Use `after` instead of the `offset` parameter. + For more information about pagination parameters, see [Pagination](/influxdb/cloud-serverless/api/#tag/Pagination). + in: query + name: after + required: false + schema: + type: string + Descending: + in: query + name: descending + required: false + schema: + default: false + type: boolean + Limit: + description: | + Limits the number of records returned. Default is `20`. + in: query + name: limit + required: false + schema: + default: 20 + maximum: 100 + minimum: 1 + type: integer + Offset: + description: | + The offset for pagination. + The number of records to skip. + + For more information about pagination parameters, see [Pagination](/influxdb/cloud-serverless/api/#tag/Pagination). + in: query + name: offset + required: false + schema: + minimum: 0 + type: integer + SortBy: + in: query + name: sortBy + required: false + schema: + type: string + TraceSpan: + description: OpenTracing span context + example: + baggage: + key: value + span_id: '1' + trace_id: '1' + in: header + name: Zap-Trace-Span + required: false + schema: + type: string + responses: + AuthorizationError: + content: + application/json: + examples: + tokenNotAuthorized: + summary: Token is not authorized to access a resource + value: + code: unauthorized + message: unauthorized access + schema: + properties: + code: + description: | + The HTTP status code description. Default is `unauthorized`. + enum: + - unauthorized + readOnly: true + type: string + message: + description: A human-readable message that may contain detail about the error. + readOnly: true + type: string + description: | + Unauthorized. The error may indicate one of the following: + + * The `Authorization: Token` header is missing or malformed. + * The API token value is missing from the header. + * The token doesn't have sufficient permissions to write to this organization and bucket. + BadRequestError: + content: + application/json: + examples: + orgProvidedNotFound: + summary: The org or orgID passed doesn't own the token passed in the header + value: + code: invalid + message: 'failed to decode request body: organization not found' + schema: + $ref: '#/components/schemas/Error' + description: | + Bad request. + The response body contains detail about the error. + + #### InfluxDB OSS + + - Returns this error if an incorrect value is passed in the `org` parameter or `orgID` parameter. + GeneralServerError: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Non 2XX error response from server. + InternalServerError: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: | + Internal server error. + The server encountered an unexpected situation. + ResourceNotFoundError: + content: + application/json: + examples: + bucket-not-found: + summary: Bucket name not found + value: + code: not found + message: bucket "air_sensor" not found + org-not-found: + summary: Organization name not found + value: + code: not found + message: organization name "my-org" not found + orgID-not-found: + summary: Organization ID not found + value: + code: not found + message: organization not found + schema: + $ref: '#/components/schemas/Error' + description: | + Not found. + A requested resource was not found. + The response body contains the requested resource type and the name value + (if you passed it)--for example: + + - `"organization name \"my-org\" not found"` + - `"organization not found"`: indicates you passed an ID that did not match + an organization. + ServerError: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Non 2XX error response from server. + schemas: + ASTResponse: + description: Contains the AST for the supplied Flux query + properties: + ast: + $ref: '#/components/schemas/Package' + type: object + AddResourceMemberRequestBody: + properties: + id: + description: | + The ID of the user to add to the resource. + type: string + name: + description: | + The name of the user to add to the resource. + type: string + required: + - id + type: object + AnalyzeQueryResponse: + properties: + errors: + items: + properties: + character: + type: integer + column: + type: integer + line: + type: integer + message: + type: string + type: object + type: array + type: object + ArrayExpression: + description: Used to create and directly specify the elements of an array object + properties: + elements: + description: Elements of the array + items: + $ref: '#/components/schemas/Expression' + type: array + type: + $ref: '#/components/schemas/NodeType' + type: object + Authorization: + allOf: + - $ref: '#/components/schemas/AuthorizationUpdateRequest' + - properties: + createdAt: + format: date-time + readOnly: true + type: string + id: + description: The authorization ID. + readOnly: true + type: string + links: + example: + self: /api/v2/authorizations/1 + user: /api/v2/users/12 + properties: + self: + $ref: '#/components/schemas/Link' + readOnly: true + user: + $ref: '#/components/schemas/Link' + readOnly: true + readOnly: true + type: object + org: + description: | + The organization name. + Specifies the [organization](/influxdb/cloud-serverless/reference/glossary/#organization) + that the token is scoped to. + readOnly: true + type: string + orgID: + description: | + The organization ID. + Specifies the [organization](/influxdb/cloud-serverless/reference/glossary/#organization) that the authorization is scoped to. + type: string + permissions: + description: | + The list of permissions. + An authorization must have at least one permission. + items: + $ref: '#/components/schemas/Permission' + minItems: 1 + type: array + token: + description: | + The API token. + The token value is unique to the authorization. + [API tokens](/influxdb/cloud-serverless/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). + readOnly: true + type: string + updatedAt: + format: date-time + readOnly: true + type: string + user: + description: | + The user name. + Specifies the [user](/influxdb/cloud-serverless/reference/glossary/#user) that owns the authorization. + If the authorization is _scoped_ to a user, the user; + otherwise, the creator of the authorization. + readOnly: true + type: string + userID: + description: The user ID. Specifies the [user](/influxdb/cloud-serverless/reference/glossary/#user) that owns the authorization. If _scoped_, the user that the authorization is scoped to; otherwise, the creator of the authorization. + readOnly: true + type: string + type: object + required: + - orgID + - permissions + AuthorizationPostRequest: + allOf: + - $ref: '#/components/schemas/AuthorizationUpdateRequest' + - properties: + orgID: + description: | + An organization ID. + Specifies the organization that owns the authorization. + type: string + permissions: + description: | + A list of permissions for an authorization. + In the list, provide at least one `permission` object. + + In a `permission`, the `resource.type` property grants access to all + resources of the specified type. + To grant access to only a specific resource, specify the + `resource.id` property. + items: + $ref: '#/components/schemas/Permission' + minItems: 1 + type: array + userID: + description: | + A user ID. + Specifies the user that the authorization is scoped to. + + When a user authenticates with username and password, + InfluxDB generates a _user session_ with all the permissions + specified by all the user's authorizations. + type: string + type: object + required: + - orgID + - permissions + AuthorizationUpdateRequest: + properties: + description: + description: A description of the token. + type: string + status: + default: active + description: Status of the token. If `inactive`, InfluxDB rejects requests that use the token. + enum: + - active + - inactive + type: string + Authorizations: + properties: + authorizations: + items: + $ref: '#/components/schemas/Authorization' + type: array + links: + $ref: '#/components/schemas/Links' + readOnly: true + type: object + Axes: + description: The viewport for a View's visualizations + properties: + x: + $ref: '#/components/schemas/Axis' + 'y': + $ref: '#/components/schemas/Axis' + required: + - x + - 'y' + type: object + Axis: + description: Axis used in a visualization. + properties: + base: + description: Radix for formatting axis values. + enum: + - '' + - '2' + - '10' + type: string + bounds: + description: The extents of the axis in the form [lower, upper]. Clients determine whether bounds are inclusive or exclusive of their limits. + items: + type: string + maxItems: 2 + minItems: 0 + type: array + label: + description: Description of the axis. + type: string + prefix: + description: Label prefix for formatting axis values. + type: string + scale: + $ref: '#/components/schemas/AxisScale' + suffix: + description: Label suffix for formatting axis values. + type: string + type: object + AxisScale: + description: 'Scale is the axis formatting scale. Supported: "log", "linear"' + enum: + - log + - linear + type: string + BadStatement: + description: A placeholder for statements for which no correct statement nodes can be created + properties: + text: + description: Raw source text + type: string + type: + $ref: '#/components/schemas/NodeType' + type: object + BandViewProperties: + properties: + adaptiveZoomHide: + type: boolean + axes: + $ref: '#/components/schemas/Axes' + colors: + description: Colors define color encoding of data into a visualization + items: + $ref: '#/components/schemas/DashboardColor' + type: array + generateXAxisTicks: + items: + type: string + type: array + generateYAxisTicks: + items: + type: string + type: array + geom: + $ref: '#/components/schemas/XYGeom' + hoverDimension: + enum: + - auto + - x + - 'y' + - xy + type: string + legendColorizeRows: + type: boolean + legendHide: + type: boolean + legendOpacity: + format: float + type: number + legendOrientationThreshold: + type: integer + lowerColumn: + type: string + mainColumn: + type: string + note: + type: string + queries: + items: + $ref: '#/components/schemas/DashboardQuery' + type: array + shape: + enum: + - chronograf-v2 + type: string + showNoteWhenEmpty: + description: If true, will display note when empty + type: boolean + staticLegend: + $ref: '#/components/schemas/StaticLegend' + timeFormat: + type: string + type: + enum: + - band + type: string + upperColumn: + type: string + xColumn: + type: string + xTickStart: + format: float + type: number + xTickStep: + format: float + type: number + xTotalTicks: + type: integer + yColumn: + type: string + yTickStart: + format: float + type: number + yTickStep: + format: float + type: number + yTotalTicks: + type: integer + required: + - type + - geom + - queries + - shape + - axes + - colors + - note + - showNoteWhenEmpty + type: object + BinaryExpression: + description: uses binary operators to act on two operands in an expression + properties: + left: + $ref: '#/components/schemas/Expression' + operator: + type: string + right: + $ref: '#/components/schemas/Expression' + type: + $ref: '#/components/schemas/NodeType' + type: object + Block: + description: A set of statements + properties: + body: + description: Block body + items: + $ref: '#/components/schemas/Statement' + type: array + type: + $ref: '#/components/schemas/NodeType' + type: object + BooleanLiteral: + description: Represents boolean values + properties: + type: + $ref: '#/components/schemas/NodeType' + value: + type: boolean + type: object + Bucket: + properties: + createdAt: + format: date-time + readOnly: true + type: string + description: + type: string + id: + readOnly: true + type: string + labels: + $ref: '#/components/schemas/Labels' + links: + example: + labels: /api/v2/buckets/1/labels + members: /api/v2/buckets/1/members + org: /api/v2/orgs/2 + owners: /api/v2/buckets/1/owners + self: /api/v2/buckets/1 + write: /api/v2/write?org=2&bucket=1 + properties: + labels: + $ref: '#/components/schemas/Link' + description: The URL to retrieve labels for this bucket. + members: + $ref: '#/components/schemas/Link' + description: The URL to retrieve members that can read this bucket. + org: + $ref: '#/components/schemas/Link' + description: The URL to retrieve parent organization for this bucket. + owners: + $ref: '#/components/schemas/Link' + description: The URL to retrieve owners that can read and write to this bucket. + self: + $ref: '#/components/schemas/Link' + description: The URL for this bucket. + write: + $ref: '#/components/schemas/Link' + description: The URL to write line protocol to this bucket. + readOnly: true + type: object + name: + type: string + orgID: + type: string + retentionRules: + $ref: '#/components/schemas/RetentionRules' + rp: + type: string + schemaType: + $ref: '#/components/schemas/SchemaType' + default: implicit + type: + default: user + enum: + - user + - system + readOnly: true + type: string + updatedAt: + format: date-time + readOnly: true + type: string + required: + - name + - retentionRules + Buckets: + properties: + buckets: + items: + $ref: '#/components/schemas/Bucket' + type: array + links: + $ref: '#/components/schemas/Links' + readOnly: true + type: object + BuilderAggregateFunctionType: + enum: + - filter + - group + type: string + BuilderConfig: + properties: + aggregateWindow: + properties: + fillValues: + type: boolean + period: + type: string + type: object + buckets: + items: + type: string + type: array + functions: + items: + $ref: '#/components/schemas/BuilderFunctionsType' + type: array + tags: + items: + $ref: '#/components/schemas/BuilderTagsType' + type: array + type: object + BuilderFunctionsType: + properties: + name: + type: string + type: object + BuilderTagsType: + properties: + aggregateFunctionType: + $ref: '#/components/schemas/BuilderAggregateFunctionType' + key: + type: string + values: + items: + type: string + type: array + type: object + BuiltinStatement: + description: Declares a builtin identifier and its type + properties: + id: + $ref: '#/components/schemas/Identifier' + type: + $ref: '#/components/schemas/NodeType' + type: object + CallExpression: + description: Represents a function call + properties: + arguments: + description: Function arguments + items: + $ref: '#/components/schemas/Expression' + type: array + callee: + $ref: '#/components/schemas/Expression' + type: + $ref: '#/components/schemas/NodeType' + type: object + Cell: + properties: + h: + format: int32 + type: integer + id: + type: string + links: + properties: + self: + type: string + view: + type: string + type: object + viewID: + description: The reference to a view from the views API. + type: string + w: + format: int32 + type: integer + x: + format: int32 + type: integer + 'y': + format: int32 + type: integer + type: object + CellUpdate: + properties: + h: + format: int32 + type: integer + w: + format: int32 + type: integer + x: + format: int32 + type: integer + 'y': + format: int32 + type: integer + type: object + CellWithViewProperties: + allOf: + - $ref: '#/components/schemas/Cell' + - properties: + name: + type: string + properties: + $ref: '#/components/schemas/ViewProperties' + type: object + type: object + Cells: + items: + $ref: '#/components/schemas/Cell' + type: array + CellsWithViewProperties: + items: + $ref: '#/components/schemas/CellWithViewProperties' + type: array + Check: + allOf: + - $ref: '#/components/schemas/CheckDiscriminator' + CheckBase: + properties: + createdAt: + format: date-time + readOnly: true + type: string + description: + description: An optional description of the check. + type: string + id: + readOnly: true + type: string + labels: + $ref: '#/components/schemas/Labels' + lastRunError: + readOnly: true + type: string + lastRunStatus: + enum: + - failed + - success + - canceled + readOnly: true + type: string + latestCompleted: + description: A timestamp ([RFC3339 date/time format](/influxdb/cloud-serverless/reference/glossary/#rfc3339-timestamp)) of the latest scheduled and completed run. + format: date-time + readOnly: true + type: string + links: + example: + labels: /api/v2/checks/1/labels + members: /api/v2/checks/1/members + owners: /api/v2/checks/1/owners + query: /api/v2/checks/1/query + self: /api/v2/checks/1 + properties: + labels: + $ref: '#/components/schemas/Link' + description: The URL to retrieve labels for this check. + members: + $ref: '#/components/schemas/Link' + description: The URL to retrieve members for this check. + owners: + $ref: '#/components/schemas/Link' + description: The URL to retrieve owners for this check. + query: + $ref: '#/components/schemas/Link' + description: The URL to retrieve the Flux script for this check. + self: + $ref: '#/components/schemas/Link' + description: The URL for this check. + readOnly: true + type: object + name: + type: string + orgID: + description: The ID of the organization that owns this check. + type: string + ownerID: + description: The ID of creator used to create this check. + readOnly: true + type: string + query: + $ref: '#/components/schemas/DashboardQuery' + status: + $ref: '#/components/schemas/TaskStatusType' + taskID: + description: The ID of the task associated with this check. + type: string + updatedAt: + format: date-time + readOnly: true + type: string + required: + - name + - orgID + - query + CheckDiscriminator: + discriminator: + mapping: + custom: '#/components/schemas/CustomCheck' + deadman: '#/components/schemas/DeadmanCheck' + threshold: '#/components/schemas/ThresholdCheck' + propertyName: type + oneOf: + - $ref: '#/components/schemas/DeadmanCheck' + - $ref: '#/components/schemas/ThresholdCheck' + - $ref: '#/components/schemas/CustomCheck' + CheckPatch: + properties: + description: + type: string + name: + type: string + status: + enum: + - active + - inactive + type: string + type: object + CheckStatusLevel: + description: The state to record if check matches a criteria. + enum: + - UNKNOWN + - OK + - INFO + - CRIT + - WARN + type: string + CheckViewProperties: + properties: + adaptiveZoomHide: + type: boolean + check: + $ref: '#/components/schemas/Check' + checkID: + type: string + colors: + description: Colors define color encoding of data into a visualization + items: + $ref: '#/components/schemas/DashboardColor' + type: array + legendColorizeRows: + type: boolean + legendHide: + type: boolean + legendOpacity: + format: float + type: number + legendOrientationThreshold: + type: integer + queries: + items: + $ref: '#/components/schemas/DashboardQuery' + type: array + shape: + enum: + - chronograf-v2 + type: string + type: + enum: + - check + type: string + required: + - type + - shape + - checkID + - queries + - colors + type: object + Checks: + properties: + checks: + items: + $ref: '#/components/schemas/Check' + type: array + links: + $ref: '#/components/schemas/Links' + ColorMapping: + additionalProperties: + type: string + description: A color mapping is an object that maps time series data to a UI color scheme to allow the UI to render graphs consistent colors across reloads. + example: + configcat_deployments-autopromotionblocker: '#663cd0' + measurement_birdmigration_europe: '#663cd0' + series_id_1: '#edf529' + series_id_2: '#edf529' + type: object + ColumnDataType: + enum: + - integer + - float + - boolean + - string + - unsigned + type: string + ColumnSemanticType: + enum: + - timestamp + - tag + - field + nullable: false + type: string + ConditionalExpression: + description: Selects one of two expressions, `Alternate` or `Consequent`, depending on a third boolean expression, `Test` + properties: + alternate: + $ref: '#/components/schemas/Expression' + consequent: + $ref: '#/components/schemas/Expression' + test: + $ref: '#/components/schemas/Expression' + type: + $ref: '#/components/schemas/NodeType' + type: object + ConstantVariableProperties: + properties: + type: + enum: + - constant + type: string + values: + items: + type: string + type: array + CreateCell: + properties: + h: + format: int32 + type: integer + name: + type: string + usingView: + description: Makes a copy of the provided view. + type: string + w: + format: int32 + type: integer + x: + format: int32 + type: integer + 'y': + format: int32 + type: integer + type: object + CreateDashboardRequest: + properties: + description: + description: The user-facing description of the dashboard. + type: string + name: + description: The user-facing name of the dashboard. + type: string + orgID: + description: The ID of the organization that owns the dashboard. + type: string + required: + - orgID + - name + CustomCheck: + allOf: + - $ref: '#/components/schemas/CheckBase' + - properties: + type: + enum: + - custom + type: string + required: + - type + type: object + DBRP: + properties: + bucketID: + description: | + A bucket ID. + Identifies the bucket used as the target for the translation. + type: string + database: + description: | + A database name. + Identifies the InfluxDB v1 database. + type: string + default: + description: | + If set to `true`, this DBRP mapping is the default retention policy + for the database (specified by the `database` property's value). + type: boolean + id: + description: | + The resource ID that InfluxDB uses to uniquely identify the database retention policy (DBRP) mapping. + readOnly: true + type: string + links: + $ref: '#/components/schemas/Links' + orgID: + description: | + An organization ID. + Identifies the [organization](/influxdb/cloud-serverless/reference/glossary/#organization) that owns the mapping. + type: string + retention_policy: + description: | + A [retention policy](/influxdb/v1.8/concepts/glossary/#retention-policy-rp) name. + Identifies the InfluxDB v1 retention policy mapping. + type: string + virtual: + description: Indicates an autogenerated, virtual mapping based on the bucket name. Currently only available in OSS. + type: boolean + required: + - id + - orgID + - bucketID + - database + - retention_policy + - default + type: object + DBRPCreate: + properties: + bucketID: + description: | + A bucket ID. + Identifies the bucket used as the target for the translation. + type: string + database: + description: | + A database name. + Identifies the InfluxDB v1 database. + type: string + default: + description: | + Set to `true` to use this DBRP mapping as the default retention policy + for the database (specified by the `database` property's value). + type: boolean + org: + description: | + An organization name. + Identifies the [organization](/influxdb/cloud-serverless/reference/glossary/#organization) that owns the mapping. + type: string + orgID: + description: | + An organization ID. + Identifies the [organization](/influxdb/cloud-serverless/reference/glossary/#organization) that owns the mapping. + type: string + retention_policy: + description: | + A [retention policy](/influxdb/v1.8/concepts/glossary/#retention-policy-rp) name. + Identifies the InfluxDB v1 retention policy mapping. + type: string + required: + - bucketID + - database + - retention_policy + type: object + DBRPGet: + properties: + content: + $ref: '#/components/schemas/DBRP' + required: true + type: object + DBRPUpdate: + properties: + default: + description: | + Set to `true` to use this DBRP mapping as the default retention policy + for the database (specified by the `database` property's value). + To remove the default mapping, set to `false`. + type: boolean + retention_policy: + description: | + A [retention policy](/influxdb/v1.8/concepts/glossary/#retention-policy-rp) name. + Identifies the InfluxDB v1 retention policy mapping. + type: string + DBRPs: + properties: + content: + items: + $ref: '#/components/schemas/DBRP' + type: array + Dashboard: + allOf: + - $ref: '#/components/schemas/CreateDashboardRequest' + - properties: + cells: + $ref: '#/components/schemas/Cells' + id: + readOnly: true + type: string + labels: + $ref: '#/components/schemas/Labels' + links: + example: + cells: /api/v2/dashboards/1/cells + labels: /api/v2/dashboards/1/labels + members: /api/v2/dashboards/1/members + org: /api/v2/labels/1 + owners: /api/v2/dashboards/1/owners + self: /api/v2/dashboards/1 + properties: + cells: + $ref: '#/components/schemas/Link' + labels: + $ref: '#/components/schemas/Link' + members: + $ref: '#/components/schemas/Link' + org: + $ref: '#/components/schemas/Link' + owners: + $ref: '#/components/schemas/Link' + self: + $ref: '#/components/schemas/Link' + type: object + meta: + properties: + createdAt: + format: date-time + type: string + updatedAt: + format: date-time + type: string + type: object + type: object + type: object + DashboardColor: + description: Defines an encoding of data value into color space. + properties: + hex: + description: The hex number of the color + maxLength: 7 + minLength: 7 + type: string + id: + description: The unique ID of the view color. + type: string + name: + description: The user-facing name of the hex color. + type: string + type: + description: Type is how the color is used. + enum: + - min + - max + - threshold + - scale + - text + - background + type: string + value: + description: The data value mapped to this color. + format: float + type: number + required: + - id + - type + - hex + - name + - value + type: object + DashboardQuery: + properties: + builderConfig: + $ref: '#/components/schemas/BuilderConfig' + editMode: + $ref: '#/components/schemas/QueryEditMode' + name: + type: string + text: + description: The text of the Flux query. + type: string + type: object + DashboardWithViewProperties: + allOf: + - $ref: '#/components/schemas/CreateDashboardRequest' + - properties: + cells: + $ref: '#/components/schemas/CellsWithViewProperties' + id: + readOnly: true + type: string + labels: + $ref: '#/components/schemas/Labels' + links: + example: + cells: /api/v2/dashboards/1/cells + labels: /api/v2/dashboards/1/labels + members: /api/v2/dashboards/1/members + org: /api/v2/labels/1 + owners: /api/v2/dashboards/1/owners + self: /api/v2/dashboards/1 + properties: + cells: + $ref: '#/components/schemas/Link' + labels: + $ref: '#/components/schemas/Link' + members: + $ref: '#/components/schemas/Link' + org: + $ref: '#/components/schemas/Link' + owners: + $ref: '#/components/schemas/Link' + self: + $ref: '#/components/schemas/Link' + type: object + meta: + properties: + createdAt: + format: date-time + type: string + updatedAt: + format: date-time + type: string + type: object + type: object + type: object + Dashboards: + properties: + dashboards: + items: + $ref: '#/components/schemas/Dashboard' + type: array + links: + $ref: '#/components/schemas/Links' + type: object + DateTimeLiteral: + description: Represents an instant in time with nanosecond precision in [RFC3339Nano date/time format](/influxdb/cloud-serverless/reference/glossary/#rfc3339nano-timestamp). + properties: + type: + $ref: '#/components/schemas/NodeType' + value: + format: date-time + type: string + type: object + DeadmanCheck: + allOf: + - $ref: '#/components/schemas/CheckBase' + - properties: + every: + description: Check repetition interval. + type: string + level: + $ref: '#/components/schemas/CheckStatusLevel' + offset: + description: Duration to delay after the schedule, before executing check. + type: string + reportZero: + description: If only zero values reported since time, trigger an alert + type: boolean + staleTime: + description: String duration for time that a series is considered stale and should not trigger deadman. + type: string + statusMessageTemplate: + description: The template used to generate and write a status message. + type: string + tags: + description: List of tags to write to each status. + items: + properties: + key: + type: string + value: + type: string + type: object + type: array + timeSince: + description: String duration before deadman triggers. + type: string + type: + enum: + - deadman + type: string + required: + - type + type: object + DecimalPlaces: + description: Indicates whether decimal places should be enforced, and how many digits it should show. + properties: + digits: + description: The number of digits after decimal to display + format: int32 + type: integer + isEnforced: + description: Indicates whether decimal point setting should be enforced + type: boolean + type: object + DeletePredicateRequest: + description: The delete predicate request. + properties: + predicate: + description: | + An expression in [delete predicate syntax](/influxdb/cloud-serverless/reference/syntax/delete-predicate/). + example: tag1="value1" and (tag2="value2" and tag3!="value3") + type: string + start: + description: | + A timestamp ([RFC3339 date/time format](/influxdb/cloud-serverless/reference/glossary/#rfc3339-timestamp)). + The earliest time to delete from. + format: date-time + type: string + stop: + description: | + A timestamp ([RFC3339 date/time format](/influxdb/cloud-serverless/reference/glossary/#rfc3339-timestamp)). + The latest time to delete from. + format: date-time + type: string + required: + - start + - stop + type: object + Dialect: + description: | + Options for tabular data output. + Default output is [annotated CSV](/influxdb/cloud-serverless/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). + properties: + annotations: + description: | + Annotation rows to include in the results. + An _annotation_ is metadata associated with an object (column) in the data model. + + #### Related guides + + - See [Annotated CSV annotations](/influxdb/cloud-serverless/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). + items: + enum: + - group + - datatype + - default + type: string + type: array + uniqueItems: true + commentPrefix: + default: '#' + description: The character prefixed to comment strings. Default is a number sign (`#`). + maxLength: 1 + minLength: 0 + type: string + dateTimeFormat: + default: RFC3339 + description: | + The format for timestamps in results. + Default is [`RFC3339` date/time format](/influxdb/cloud-serverless/reference/glossary/#rfc3339-timestamp). + To include nanoseconds in timestamps, use `RFC3339Nano`. + + #### Example formatted date/time values + + | Format | Value | + |:------------|:----------------------------| + | `RFC3339` | `"2006-01-02T15:04:05Z07:00"` | + | `RFC3339Nano` | `"2006-01-02T15:04:05.999999999Z07:00"` | + enum: + - RFC3339 + - RFC3339Nano + type: string + delimiter: + default: ',' + description: The separator used between cells. Default is a comma (`,`). + maxLength: 1 + minLength: 1 + type: string + header: + default: true + description: If true, the results contain a header row. + type: boolean + type: object + DictExpression: + description: Used to create and directly specify the elements of a dictionary + properties: + elements: + description: Elements of the dictionary + items: + $ref: '#/components/schemas/DictItem' + type: array + type: + $ref: '#/components/schemas/NodeType' + type: object + DictItem: + description: A key-value pair in a dictionary. + properties: + key: + $ref: '#/components/schemas/Expression' + type: + $ref: '#/components/schemas/NodeType' + val: + $ref: '#/components/schemas/Expression' + type: object + Duration: + description: A pair consisting of length of time and the unit of time measured. It is the atomic unit from which all duration literals are composed. + properties: + magnitude: + type: integer + type: + $ref: '#/components/schemas/NodeType' + unit: + type: string + type: object + DurationLiteral: + description: Represents the elapsed time between two instants as an int64 nanosecond count with syntax of golang's time.Duration + properties: + type: + $ref: '#/components/schemas/NodeType' + values: + description: Duration values + items: + $ref: '#/components/schemas/Duration' + type: array + type: object + Error: + properties: + code: + $ref: '#/components/schemas/ErrorCode' + description: code is the machine-readable error code. + enum: + - internal error + - not implemented + - not found + - conflict + - invalid + - unprocessable entity + - empty value + - unavailable + - forbidden + - too many requests + - unauthorized + - method not allowed + - request too large + - unsupported media type + readOnly: true + type: string + err: + description: Stack of errors that occurred during processing of the request. Useful for debugging. + readOnly: true + type: string + message: + description: Human-readable message. + readOnly: true + type: string + op: + description: Describes the logical code operation when the error occurred. Useful for debugging. + readOnly: true + type: string + required: + - code + ErrorCode: + description: code is the machine-readable error code. + enum: + - internal error + - not implemented + - not found + - conflict + - invalid + - unprocessable entity + - empty value + - unavailable + - forbidden + - too many requests + - unauthorized + - method not allowed + - request too large + - unsupported media type + readOnly: true + type: string + Expression: + oneOf: + - $ref: '#/components/schemas/ArrayExpression' + - $ref: '#/components/schemas/DictExpression' + - $ref: '#/components/schemas/FunctionExpression' + - $ref: '#/components/schemas/BinaryExpression' + - $ref: '#/components/schemas/CallExpression' + - $ref: '#/components/schemas/ConditionalExpression' + - $ref: '#/components/schemas/LogicalExpression' + - $ref: '#/components/schemas/MemberExpression' + - $ref: '#/components/schemas/IndexExpression' + - $ref: '#/components/schemas/ObjectExpression' + - $ref: '#/components/schemas/ParenExpression' + - $ref: '#/components/schemas/PipeExpression' + - $ref: '#/components/schemas/UnaryExpression' + - $ref: '#/components/schemas/BooleanLiteral' + - $ref: '#/components/schemas/DateTimeLiteral' + - $ref: '#/components/schemas/DurationLiteral' + - $ref: '#/components/schemas/FloatLiteral' + - $ref: '#/components/schemas/IntegerLiteral' + - $ref: '#/components/schemas/PipeLiteral' + - $ref: '#/components/schemas/RegexpLiteral' + - $ref: '#/components/schemas/StringLiteral' + - $ref: '#/components/schemas/UnsignedIntegerLiteral' + - $ref: '#/components/schemas/Identifier' + ExpressionStatement: + description: May consist of an expression that doesn't return a value and is executed solely for its side-effects + properties: + expression: + $ref: '#/components/schemas/Expression' + type: + $ref: '#/components/schemas/NodeType' + type: object + Field: + properties: + alias: + description: Alias overrides the field name in the returned response. Applies only if type is `func` + type: string + args: + description: Args are the arguments to the function + items: + $ref: '#/components/schemas/Field' + type: array + type: + description: '`type` describes the field type. `func` is a function. `field` is a field reference.' + enum: + - func + - field + - integer + - number + - regex + - wildcard + type: string + value: + description: value is the value of the field. Meaning of the value is implied by the `type` key + type: string + type: object + File: + description: Represents a source from a single file + properties: + body: + description: List of Flux statements + items: + $ref: '#/components/schemas/Statement' + type: array + imports: + description: A list of package imports + items: + $ref: '#/components/schemas/ImportDeclaration' + type: array + name: + description: The name of the file. + type: string + package: + $ref: '#/components/schemas/PackageClause' + type: + $ref: '#/components/schemas/NodeType' + type: object + Flags: + additionalProperties: true + type: object + FloatLiteral: + description: Represents floating point numbers according to the double representations defined by the IEEE-754-1985 + properties: + type: + $ref: '#/components/schemas/NodeType' + value: + type: number + type: object + FluxResponse: + description: Rendered flux that backs the check or notification. + properties: + flux: + type: string + FluxSuggestion: + properties: + name: + type: string + params: + additionalProperties: + type: string + type: object + type: object + FluxSuggestions: + properties: + funcs: + items: + $ref: '#/components/schemas/FluxSuggestion' + type: array + type: object + FunctionExpression: + description: Function expression + properties: + body: + $ref: '#/components/schemas/Node' + params: + description: Function parameters + items: + $ref: '#/components/schemas/Property' + type: array + type: + $ref: '#/components/schemas/NodeType' + type: object + GaugeViewProperties: + properties: + colors: + description: Colors define color encoding of data into a visualization + items: + $ref: '#/components/schemas/DashboardColor' + type: array + decimalPlaces: + $ref: '#/components/schemas/DecimalPlaces' + note: + type: string + prefix: + type: string + queries: + items: + $ref: '#/components/schemas/DashboardQuery' + type: array + shape: + enum: + - chronograf-v2 + type: string + showNoteWhenEmpty: + description: If true, will display note when empty + type: boolean + suffix: + type: string + tickPrefix: + type: string + tickSuffix: + type: string + type: + enum: + - gauge + type: string + required: + - type + - queries + - colors + - shape + - note + - showNoteWhenEmpty + - prefix + - tickPrefix + - suffix + - tickSuffix + - decimalPlaces + type: object + GeoCircleViewLayer: + allOf: + - $ref: '#/components/schemas/GeoViewLayerProperties' + - properties: + colorDimension: + $ref: '#/components/schemas/Axis' + colorField: + description: Circle color field + type: string + colors: + description: Colors define color encoding of data into a visualization + items: + $ref: '#/components/schemas/DashboardColor' + type: array + interpolateColors: + description: Interpolate circle color based on displayed value + type: boolean + radius: + description: Maximum radius size in pixels + type: integer + radiusDimension: + $ref: '#/components/schemas/Axis' + radiusField: + description: Radius field + type: string + required: + - radiusField + - radiusDimension + - colorField + - colorDimension + - colors + type: object + GeoHeatMapViewLayer: + allOf: + - $ref: '#/components/schemas/GeoViewLayerProperties' + - properties: + blur: + description: Blur for heatmap points + type: integer + colors: + description: Colors define color encoding of data into a visualization + items: + $ref: '#/components/schemas/DashboardColor' + type: array + intensityDimension: + $ref: '#/components/schemas/Axis' + intensityField: + description: Intensity field + type: string + radius: + description: Radius size in pixels + type: integer + required: + - intensityField + - intensityDimension + - radius + - blur + - colors + type: object + GeoPointMapViewLayer: + allOf: + - $ref: '#/components/schemas/GeoViewLayerProperties' + - properties: + colorDimension: + $ref: '#/components/schemas/Axis' + colorField: + description: Marker color field + type: string + colors: + description: Colors define color encoding of data into a visualization + items: + $ref: '#/components/schemas/DashboardColor' + type: array + isClustered: + description: Cluster close markers together + type: boolean + tooltipColumns: + description: An array for which columns to display in tooltip + items: + type: string + type: array + required: + - colorField + - colorDimension + - colors + type: object + GeoTrackMapViewLayer: + allOf: + - $ref: '#/components/schemas/GeoViewLayerProperties' + - required: + - trackWidth + - speed + - randomColors + - trackPointVisualization + type: object + properties: + colors: + description: Colors define color encoding of data into a visualization + items: + $ref: '#/components/schemas/DashboardColor' + type: array + randomColors: + description: Assign different colors to different tracks + type: boolean + speed: + description: Speed of the track animation + type: integer + trackWidth: + description: Width of the track + type: integer + GeoViewLayer: + oneOf: + - $ref: '#/components/schemas/GeoCircleViewLayer' + - $ref: '#/components/schemas/GeoHeatMapViewLayer' + - $ref: '#/components/schemas/GeoPointMapViewLayer' + - $ref: '#/components/schemas/GeoTrackMapViewLayer' + type: object + GeoViewLayerProperties: + properties: + type: + enum: + - heatmap + - circleMap + - pointMap + - trackMap + type: string + required: + - type + type: object + GeoViewProperties: + properties: + allowPanAndZoom: + default: true + description: If true, map zoom and pan controls are enabled on the dashboard view + type: boolean + center: + description: Coordinates of the center of the map + properties: + lat: + description: Latitude of the center of the map + format: double + type: number + lon: + description: Longitude of the center of the map + format: double + type: number + required: + - lat + - lon + type: object + colors: + description: Colors define color encoding of data into a visualization + items: + $ref: '#/components/schemas/DashboardColor' + type: array + detectCoordinateFields: + default: true + description: If true, search results get automatically regroupped so that lon,lat and value are treated as columns + type: boolean + latLonColumns: + $ref: '#/components/schemas/LatLonColumns' + layers: + description: List of individual layers shown in the map + items: + $ref: '#/components/schemas/GeoViewLayer' + type: array + mapStyle: + description: Define map type - regular, satellite etc. + type: string + note: + type: string + queries: + items: + $ref: '#/components/schemas/DashboardQuery' + type: array + s2Column: + description: String to define the column + type: string + shape: + enum: + - chronograf-v2 + type: string + showNoteWhenEmpty: + description: If true, will display note when empty + type: boolean + type: + enum: + - geo + type: string + useS2CellID: + description: If true, S2 column is used to calculate lat/lon + type: boolean + zoom: + description: Zoom level used for initial display of the map + format: double + maximum: 28 + minimum: 1 + type: number + required: + - type + - shape + - queries + - note + - showNoteWhenEmpty + - center + - zoom + - allowPanAndZoom + - detectCoordinateFields + - layers + type: object + GreaterThreshold: + allOf: + - $ref: '#/components/schemas/ThresholdBase' + - properties: + type: + enum: + - greater + type: string + value: + format: float + type: number + required: + - type + - value + type: object + HTTPNotificationEndpoint: + allOf: + - $ref: '#/components/schemas/NotificationEndpointBase' + - properties: + authMethod: + enum: + - none + - basic + - bearer + type: string + contentTemplate: + type: string + headers: + additionalProperties: + type: string + description: Customized headers. + type: object + method: + enum: + - POST + - GET + - PUT + type: string + password: + type: string + token: + type: string + url: + type: string + username: + type: string + required: + - url + - authMethod + - method + type: object + type: object + HTTPNotificationRule: + allOf: + - $ref: '#/components/schemas/NotificationRuleBase' + - $ref: '#/components/schemas/HTTPNotificationRuleBase' + HTTPNotificationRuleBase: + properties: + type: + enum: + - http + type: string + url: + type: string + required: + - type + type: object + HealthCheck: + properties: + checks: + items: + $ref: '#/components/schemas/HealthCheck' + type: array + commit: + type: string + message: + type: string + name: + type: string + status: + enum: + - pass + - fail + type: string + version: + type: string + required: + - name + - status + type: object + HeatmapViewProperties: + properties: + adaptiveZoomHide: + type: boolean + binSize: + type: number + colors: + description: Colors define color encoding of data into a visualization + items: + type: string + type: array + generateXAxisTicks: + items: + type: string + type: array + generateYAxisTicks: + items: + type: string + type: array + legendColorizeRows: + type: boolean + legendHide: + type: boolean + legendOpacity: + format: float + type: number + legendOrientationThreshold: + type: integer + note: + type: string + queries: + items: + $ref: '#/components/schemas/DashboardQuery' + type: array + shape: + enum: + - chronograf-v2 + type: string + showNoteWhenEmpty: + description: If true, will display note when empty + type: boolean + timeFormat: + type: string + type: + enum: + - heatmap + type: string + xAxisLabel: + type: string + xColumn: + type: string + xDomain: + items: + type: number + maxItems: 2 + type: array + xPrefix: + type: string + xSuffix: + type: string + xTickStart: + format: float + type: number + xTickStep: + format: float + type: number + xTotalTicks: + type: integer + yAxisLabel: + type: string + yColumn: + type: string + yDomain: + items: + type: number + maxItems: 2 + type: array + yPrefix: + type: string + ySuffix: + type: string + yTickStart: + format: float + type: number + yTickStep: + format: float + type: number + yTotalTicks: + type: integer + required: + - type + - queries + - colors + - shape + - note + - showNoteWhenEmpty + - xColumn + - yColumn + - xDomain + - yDomain + - xAxisLabel + - yAxisLabel + - xPrefix + - yPrefix + - xSuffix + - ySuffix + - binSize + type: object + HistogramViewProperties: + properties: + binCount: + type: integer + colors: + description: Colors define color encoding of data into a visualization + items: + $ref: '#/components/schemas/DashboardColor' + type: array + fillColumns: + items: + type: string + type: array + legendColorizeRows: + type: boolean + legendHide: + type: boolean + legendOpacity: + format: float + type: number + legendOrientationThreshold: + type: integer + note: + type: string + position: + enum: + - overlaid + - stacked + type: string + queries: + items: + $ref: '#/components/schemas/DashboardQuery' + type: array + shape: + enum: + - chronograf-v2 + type: string + showNoteWhenEmpty: + description: If true, will display note when empty + type: boolean + type: + enum: + - histogram + type: string + xAxisLabel: + type: string + xColumn: + type: string + xDomain: + items: + format: float + type: number + type: array + required: + - type + - queries + - colors + - shape + - note + - showNoteWhenEmpty + - xColumn + - fillColumns + - xDomain + - xAxisLabel + - position + - binCount + type: object + Identifier: + description: A valid Flux identifier + properties: + name: + type: string + type: + $ref: '#/components/schemas/NodeType' + type: object + ImportDeclaration: + description: Declares a package import + properties: + as: + $ref: '#/components/schemas/Identifier' + path: + $ref: '#/components/schemas/StringLiteral' + type: + $ref: '#/components/schemas/NodeType' + type: object + IndexExpression: + description: Represents indexing into an array + properties: + array: + $ref: '#/components/schemas/Expression' + index: + $ref: '#/components/schemas/Expression' + type: + $ref: '#/components/schemas/NodeType' + type: object + InfluxqlCsvResponse: + description: CSV Response to InfluxQL Query + example: | + name,tags,time,test_field,test_tag test_measurement,,1603740794286107366,1,tag_value test_measurement,,1603740870053205649,2,tag_value test_measurement,,1603741221085428881,3,tag_value + type: string + InfluxqlJsonResponse: + description: | + The JSON response for an InfluxQL query. + + A response contains the collection of results for a query. + `results` is an array of resultset objects. + + If the response is chunked, the `transfer-encoding` response header is set to `chunked` and each resultset object is sent in a separate JSON object. + properties: + results: + description: | + A resultset object that contains the `statement_id` and the `series` array. + + Except for `statement_id`, all properties are optional and omitted if empty. If a property is not present, it is assumed to be `null`. + items: + properties: + error: + type: string + partial: + description: | + True if the resultset is not complete--the response data is chunked; otherwise, false or omitted. + type: boolean + series: + description: | + An array of series objects--the results of the query. A series of rows shares the same group key returned from the execution of a statement. + + If a property is not present, it is assumed to be `null`. + items: + properties: + columns: + description: An array of column names + items: + type: string + type: array + name: + description: The name of the series + type: string + partial: + description: | + True if the series is not complete--the response data is chunked; otherwise, false or omitted. + type: boolean + tags: + additionalProperties: + type: string + description: | + A map of tag key-value pairs. If a tag key is not present, it is assumed to be `null`. + type: object + values: + description: | + An array of rows, where each row is an array of values. + items: + items: {} + type: array + type: array + type: object + type: array + statement_id: + description: | + An integer that represents the statement's position in the query. If statement results are buffered in memory, `statement_id` is used to combine statement results. + type: integer + type: object + oneOf: + - required: + - statement_id + - error + - required: + - statement_id + - series + type: array + type: object + IntegerLiteral: + description: Represents integer numbers + properties: + type: + $ref: '#/components/schemas/NodeType' + value: + type: string + type: object + IsOnboarding: + properties: + allowed: + description: | + If `true`, the InfluxDB instance hasn't had initial setup; + `false` otherwise. + type: boolean + type: object + Label: + properties: + id: + readOnly: true + type: string + name: + type: string + orgID: + readOnly: true + type: string + properties: + additionalProperties: + type: string + description: | + Key-value pairs associated with this label. + To remove a property, send an update with an empty value (`""`) for the key. + example: + color: ffb3b3 + description: this is a description + type: object + type: object + LabelCreateRequest: + properties: + name: + type: string + orgID: + type: string + properties: + additionalProperties: + type: string + description: | + Key-value pairs associated with this label. + + To remove a property, send an update with an empty value (`""`) for the key. + example: + color: ffb3b3 + description: this is a description + type: object + required: + - orgID + - name + type: object + LabelMapping: + description: A _label mapping_ contains a `label` ID to attach to a resource. + properties: + labelID: + description: | + A label ID. + Specifies the label to attach. + type: string + required: + - labelID + type: object + LabelResponse: + properties: + label: + $ref: '#/components/schemas/Label' + links: + $ref: '#/components/schemas/Links' + type: object + LabelUpdate: + properties: + name: + type: string + properties: + additionalProperties: + description: | + Key-value pairs associated with this label. + + To remove a property, send an update with an empty value (`""`) for the key. + type: string + example: + color: ffb3b3 + description: this is a description + type: object + type: object + Labels: + items: + $ref: '#/components/schemas/Label' + type: array + LabelsResponse: + properties: + labels: + $ref: '#/components/schemas/Labels' + links: + $ref: '#/components/schemas/Links' + type: object + LanguageRequest: + description: Flux query to be analyzed. + properties: + query: + description: | + The Flux query script to be analyzed. + type: string + required: + - query + type: object + LatLonColumn: + description: Object type for key and column definitions + properties: + column: + description: Column to look up Lat/Lon + type: string + key: + description: Key to determine whether the column is tag/field + type: string + required: + - key + - column + type: object + LatLonColumns: + description: Object type to define lat/lon columns + properties: + lat: + $ref: '#/components/schemas/LatLonColumn' + lon: + $ref: '#/components/schemas/LatLonColumn' + required: + - lat + - lon + type: object + LegacyAuthorizationPostRequest: + allOf: + - $ref: '#/components/schemas/AuthorizationUpdateRequest' + - properties: + orgID: + description: The organization ID. Identifies the organization that the authorization is scoped to. + type: string + permissions: + description: | + The list of permissions that provide `read` and `write` access to organization resources. + An authorization must contain at least one permission. + items: + $ref: '#/components/schemas/Permission' + minItems: 1 + type: array + token: + description: The name that you provide for the authorization. + type: string + userID: + description: The user ID. Identifies the user that the authorization is scoped to. + type: string + type: object + required: + - orgID + - permissions + LesserThreshold: + allOf: + - $ref: '#/components/schemas/ThresholdBase' + - properties: + type: + enum: + - lesser + type: string + value: + format: float + type: number + required: + - type + - value + type: object + Limit: + description: These are org limits similar to those configured in/by quartz. + properties: + bucket: + properties: + maxBuckets: + type: integer + maxRetentionDuration: + description: Max bucket retention duration in nanoseconds. 0 is unlimited. + type: integer + required: + - maxBuckets + - maxRetentionDuration + type: object + check: + properties: + maxChecks: + type: integer + required: + - maxChecks + type: object + dashboard: + properties: + maxDashboards: + type: integer + required: + - maxDashboards + type: object + features: + properties: + allowDelete: + description: allow delete predicate endpoint + type: boolean + type: object + notificationEndpoint: + properties: + blockedNotificationEndpoints: + description: comma separated list of notification endpoints + example: http,pagerduty + type: string + required: + - blockNotificationEndpoints + type: object + notificationRule: + properties: + blockedNotificationRules: + description: comma separated list of notification rules + example: http,pagerduty + type: string + maxNotifications: + type: integer + required: + - maxNotifications + - blockNotificationRules + type: object + orgID: + type: string + rate: + properties: + cardinality: + description: Allowed organization total cardinality. 0 is unlimited. + type: integer + concurrentDeleteRequests: + description: Allowed organization concurrent outstanding delete requests. + type: integer + concurrentReadRequests: + description: Allowed concurrent queries. 0 is unlimited. + type: integer + concurrentWriteRequests: + description: Allowed concurrent writes. 0 is unlimited. + type: integer + deleteRequestsPerSecond: + description: Allowed organization delete request rate. + type: integer + queryTime: + description: Query Time in nanoseconds + type: integer + readKBs: + description: Query limit in kb/sec. 0 is unlimited. + type: integer + writeKBs: + description: Write limit in kb/sec. 0 is unlimited. + type: integer + required: + - readKBs + - queryTime + - concurrentReadRequests + - writeKBs + - concurrentWriteRequests + - cardinality + type: object + stack: + properties: + enabled: + type: boolean + required: + - enabled + type: object + task: + properties: + maxTasks: + type: integer + required: + - maxTasks + type: object + timeout: + properties: + queryUnconditionalTimeoutSeconds: + type: integer + queryidleWriteTimeoutSeconds: + type: integer + required: + - queryUnconditionalTimeoutSeconds + - queryidleWriteTimeoutSeconds + type: object + required: + - rate + - bucket + - task + - dashboard + - check + - notificationRule + - notificationEndpoint + type: object + LinePlusSingleStatProperties: + properties: + adaptiveZoomHide: + type: boolean + axes: + $ref: '#/components/schemas/Axes' + colors: + description: Colors define color encoding of data into a visualization + items: + $ref: '#/components/schemas/DashboardColor' + type: array + decimalPlaces: + $ref: '#/components/schemas/DecimalPlaces' + generateXAxisTicks: + items: + type: string + type: array + generateYAxisTicks: + items: + type: string + type: array + hoverDimension: + enum: + - auto + - x + - 'y' + - xy + type: string + legendColorizeRows: + type: boolean + legendHide: + type: boolean + legendOpacity: + format: float + type: number + legendOrientationThreshold: + type: integer + note: + type: string + position: + enum: + - overlaid + - stacked + type: string + prefix: + type: string + queries: + items: + $ref: '#/components/schemas/DashboardQuery' + type: array + shadeBelow: + type: boolean + shape: + enum: + - chronograf-v2 + type: string + showNoteWhenEmpty: + description: If true, will display note when empty + type: boolean + staticLegend: + $ref: '#/components/schemas/StaticLegend' + suffix: + type: string + timeFormat: + type: string + type: + enum: + - line-plus-single-stat + type: string + xColumn: + type: string + xTickStart: + format: float + type: number + xTickStep: + format: float + type: number + xTotalTicks: + type: integer + yColumn: + type: string + yTickStart: + format: float + type: number + yTickStep: + format: float + type: number + yTotalTicks: + type: integer + required: + - type + - queries + - shape + - axes + - colors + - note + - showNoteWhenEmpty + - prefix + - suffix + - decimalPlaces + - position + type: object + LineProtocolError: + properties: + code: + description: Code is the machine-readable error code. + enum: + - internal error + - not found + - conflict + - invalid + - empty value + - unavailable + readOnly: true + type: string + err: + description: Stack of errors that occurred during processing of the request. Useful for debugging. + readOnly: true + type: string + line: + description: First line in the request body that contains malformed data. + format: int32 + readOnly: true + type: integer + message: + description: Human-readable message. + readOnly: true + type: string + op: + description: Describes the logical code operation when the error occurred. Useful for debugging. + readOnly: true + type: string + required: + - code + LineProtocolLengthError: + properties: + code: + description: Code is the machine-readable error code. + enum: + - invalid + readOnly: true + type: string + message: + description: Human-readable message. + readOnly: true + type: string + required: + - code + - message + Link: + description: URI of resource. + format: uri + readOnly: true + type: string + Links: + description: | + URI pointers for additional paged results. + properties: + next: + $ref: '#/components/schemas/Link' + prev: + $ref: '#/components/schemas/Link' + self: + $ref: '#/components/schemas/Link' + required: + - self + type: object + LogEvent: + properties: + message: + description: A description of the event that occurred. + example: Halt and catch fire + readOnly: true + type: string + runID: + description: The ID of the task run that generated the event. + readOnly: true + type: string + time: + description: The time ([RFC3339Nano date/time format](/influxdb/cloud-serverless/reference/glossary/#rfc3339nano-timestamp)) that the event occurred. + example: 2006-01-02T15:04:05.999999999Z07:00 + format: date-time + readOnly: true + type: string + type: object + LogicalExpression: + description: Represents the rule conditions that collectively evaluate to either true or false + properties: + left: + $ref: '#/components/schemas/Expression' + operator: + type: string + right: + $ref: '#/components/schemas/Expression' + type: + $ref: '#/components/schemas/NodeType' + type: object + Logs: + properties: + events: + items: + $ref: '#/components/schemas/LogEvent' + readOnly: true + type: array + type: object + MapVariableProperties: + properties: + type: + enum: + - map + type: string + values: + additionalProperties: + type: string + type: object + MarkdownViewProperties: + properties: + note: + type: string + shape: + enum: + - chronograf-v2 + type: string + type: + enum: + - markdown + type: string + required: + - type + - shape + - note + type: object + MeasurementSchema: + description: Definition of a measurement schema. + example: + bucketID: ba3c5e7f9b0a0010 + columns: + - format: unix timestamp + name: time + type: integer + - name: host + type: tag + - name: region + type: tag + - dataType: float + name: usage_user + type: field + - dataType: float + name: usage_user + type: field + createdAt: '2021-01-21T00:48:40.993Z' + id: 1a3c5e7f9b0a8642 + name: cpu + orgID: 0a3c5e7f9b0a0001 + updatedAt: '2021-01-21T00:48:40.993Z' + properties: + bucketID: + description: The ID of the bucket that the measurement schema is associated with. + type: string + columns: + description: Ordered collection of column definitions. + items: + $ref: '#/components/schemas/MeasurementSchemaColumn' + type: array + createdAt: + format: date-time + readOnly: true + type: string + id: + readOnly: true + type: string + name: + nullable: false + type: string + orgID: + description: The ID of the organization. + type: string + updatedAt: + format: date-time + readOnly: true + type: string + required: + - id + - name + - columns + - createdAt + - updatedAt + type: object + MeasurementSchemaColumn: + description: Definition of a measurement schema column. + example: + format: unix timestamp + name: time + type: integer + properties: + dataType: + $ref: '#/components/schemas/ColumnDataType' + name: + type: string + type: + $ref: '#/components/schemas/ColumnSemanticType' + required: + - name + - type + type: object + MeasurementSchemaCreateRequest: + description: Create a new measurement schema. + example: + columns: + - format: unix timestamp + name: time + type: integer + - name: host + type: tag + - name: region + type: tag + - dataType: float + name: usage_user + type: field + - dataType: float + name: usage_user + type: field + name: cpu + properties: + columns: + description: Ordered collection of column definitions. + items: + $ref: '#/components/schemas/MeasurementSchemaColumn' + type: array + name: + description: | + The [measurement](/influxdb/cloud-serverless/reference/glossary/#measurement) + name. + type: string + required: + - name + - columns + type: object + MeasurementSchemaList: + description: A list of measurement schemas returning summary information + example: + measurementSchemas: + - bucketID: ba3c5e7f9b0a0010 + createdAt: '2021-01-21T00:48:40.993Z' + id: 1a3c5e7f9b0a8642 + name: cpu + orgID: 0a3c5e7f9b0a0001 + updatedAt: '2021-01-21T00:48:40.993Z' + - bucketID: ba3c5e7f9b0a0010 + createdAt: '2021-01-21T00:48:40.993Z' + id: 1a3c5e7f9b0a8643 + name: memory + orgID: 0a3c5e7f9b0a0001 + updatedAt: '2021-01-21T00:48:40.993Z' + - bucketID: ba3c5e7f9b0a0010 + createdAt: '2021-01-21T00:48:40.993Z' + id: 1a3c5e7f9b0a8644 + name: disk + orgID: 0a3c5e7f9b0a0001 + updatedAt: '2021-01-21T00:48:40.993Z' + properties: + measurementSchemas: + items: + $ref: '#/components/schemas/MeasurementSchema' + type: array + required: + - measurementSchemas + type: object + MeasurementSchemaUpdateRequest: + description: Update an existing measurement schema + example: + columns: + - format: unix timestamp + name: time + type: integer + - name: host + type: tag + - name: region + type: tag + - dataType: float + name: usage_user + type: field + - dataType: float + name: usage_user + type: field + properties: + columns: + description: An ordered collection of column definitions + items: + $ref: '#/components/schemas/MeasurementSchemaColumn' + type: array + required: + - columns + type: object + MemberAssignment: + description: Object property assignment + properties: + init: + $ref: '#/components/schemas/Expression' + member: + $ref: '#/components/schemas/MemberExpression' + type: + $ref: '#/components/schemas/NodeType' + type: object + MemberExpression: + description: Represents accessing a property of an object + properties: + object: + $ref: '#/components/schemas/Expression' + property: + $ref: '#/components/schemas/PropertyKey' + type: + $ref: '#/components/schemas/NodeType' + type: object + MosaicViewProperties: + properties: + colors: + description: Colors define color encoding of data into a visualization + items: + type: string + type: array + fillColumns: + items: + type: string + type: array + generateXAxisTicks: + items: + type: string + type: array + hoverDimension: + enum: + - auto + - x + - 'y' + - xy + type: string + legendColorizeRows: + type: boolean + legendHide: + type: boolean + legendOpacity: + format: float + type: number + legendOrientationThreshold: + type: integer + note: + type: string + queries: + items: + $ref: '#/components/schemas/DashboardQuery' + type: array + shape: + enum: + - chronograf-v2 + type: string + showNoteWhenEmpty: + description: If true, will display note when empty + type: boolean + timeFormat: + type: string + type: + enum: + - mosaic + type: string + xAxisLabel: + type: string + xColumn: + type: string + xDomain: + items: + type: number + maxItems: 2 + type: array + xPrefix: + type: string + xSuffix: + type: string + xTickStart: + format: float + type: number + xTickStep: + format: float + type: number + xTotalTicks: + type: integer + yAxisLabel: + type: string + yDomain: + items: + type: number + maxItems: 2 + type: array + yLabelColumnSeparator: + type: string + yLabelColumns: + items: + type: string + type: array + yPrefix: + type: string + ySeriesColumns: + items: + type: string + type: array + ySuffix: + type: string + required: + - type + - queries + - colors + - shape + - note + - showNoteWhenEmpty + - xColumn + - ySeriesColumns + - fillColumns + - xDomain + - yDomain + - xAxisLabel + - yAxisLabel + - xPrefix + - yPrefix + - xSuffix + - ySuffix + type: object + Node: + oneOf: + - $ref: '#/components/schemas/Expression' + - $ref: '#/components/schemas/Block' + NodeType: + description: Type of AST node + type: string + NotificationEndpoint: + allOf: + - $ref: '#/components/schemas/NotificationEndpointDiscriminator' + NotificationEndpointBase: + properties: + createdAt: + format: date-time + readOnly: true + type: string + description: + description: An optional description of the notification endpoint. + type: string + id: + type: string + labels: + $ref: '#/components/schemas/Labels' + links: + example: + labels: /api/v2/notificationEndpoints/1/labels + members: /api/v2/notificationEndpoints/1/members + owners: /api/v2/notificationEndpoints/1/owners + self: /api/v2/notificationEndpoints/1 + properties: + labels: + $ref: '#/components/schemas/Link' + description: The URL to retrieve labels for this endpoint. + members: + $ref: '#/components/schemas/Link' + description: The URL to retrieve members for this endpoint. + owners: + $ref: '#/components/schemas/Link' + description: The URL to retrieve owners for this endpoint. + self: + $ref: '#/components/schemas/Link' + description: The URL for this endpoint. + readOnly: true + type: object + name: + type: string + orgID: + type: string + status: + default: active + description: The status of the endpoint. + enum: + - active + - inactive + type: string + type: + $ref: '#/components/schemas/NotificationEndpointType' + updatedAt: + format: date-time + readOnly: true + type: string + userID: + type: string + required: + - type + - name + type: object + NotificationEndpointDiscriminator: + discriminator: + mapping: + http: '#/components/schemas/HTTPNotificationEndpoint' + pagerduty: '#/components/schemas/PagerDutyNotificationEndpoint' + slack: '#/components/schemas/SlackNotificationEndpoint' + telegram: '#/components/schemas/TelegramNotificationEndpoint' + propertyName: type + oneOf: + - $ref: '#/components/schemas/SlackNotificationEndpoint' + - $ref: '#/components/schemas/PagerDutyNotificationEndpoint' + - $ref: '#/components/schemas/HTTPNotificationEndpoint' + - $ref: '#/components/schemas/TelegramNotificationEndpoint' + NotificationEndpointType: + enum: + - slack + - pagerduty + - http + - telegram + type: string + NotificationEndpointUpdate: + properties: + description: + type: string + name: + type: string + status: + enum: + - active + - inactive + type: string + type: object + NotificationEndpoints: + properties: + links: + $ref: '#/components/schemas/Links' + notificationEndpoints: + items: + $ref: '#/components/schemas/NotificationEndpoint' + type: array + NotificationRule: + allOf: + - $ref: '#/components/schemas/NotificationRuleDiscriminator' + NotificationRuleBase: + properties: + createdAt: + format: date-time + readOnly: true + type: string + description: + description: An optional description of the notification rule. + type: string + endpointID: + type: string + every: + description: The notification repetition interval. + type: string + id: + readOnly: true + type: string + labels: + $ref: '#/components/schemas/Labels' + lastRunError: + readOnly: true + type: string + lastRunStatus: + enum: + - failed + - success + - canceled + readOnly: true + type: string + latestCompleted: + description: A timestamp ([RFC3339 date/time format](/influxdb/cloud-serverless/reference/glossary/#rfc3339-timestamp)) of the latest scheduled and completed run. + format: date-time + readOnly: true + type: string + limit: + description: Don't notify me more than times every seconds. If set, limitEvery cannot be empty. + type: integer + limitEvery: + description: Don't notify me more than times every seconds. If set, limit cannot be empty. + type: integer + links: + example: + labels: /api/v2/notificationRules/1/labels + members: /api/v2/notificationRules/1/members + owners: /api/v2/notificationRules/1/owners + query: /api/v2/notificationRules/1/query + self: /api/v2/notificationRules/1 + properties: + labels: + $ref: '#/components/schemas/Link' + description: The URL to retrieve labels for this notification rule. + members: + $ref: '#/components/schemas/Link' + description: The URL to retrieve members for this notification rule. + owners: + $ref: '#/components/schemas/Link' + description: The URL to retrieve owners for this notification rule. + query: + $ref: '#/components/schemas/Link' + description: The URL to retrieve the Flux script for this notification rule. + self: + $ref: '#/components/schemas/Link' + description: The URL for this endpoint. + readOnly: true + type: object + name: + description: Human-readable name describing the notification rule. + type: string + offset: + description: Duration to delay after the schedule, before executing check. + type: string + orgID: + description: The ID of the organization that owns this notification rule. + type: string + ownerID: + description: The ID of creator used to create this notification rule. + readOnly: true + type: string + runbookLink: + type: string + sleepUntil: + type: string + status: + $ref: '#/components/schemas/TaskStatusType' + statusRules: + description: List of status rules the notification rule attempts to match. + items: + $ref: '#/components/schemas/StatusRule' + minItems: 1 + type: array + tagRules: + description: List of tag rules the notification rule attempts to match. + items: + $ref: '#/components/schemas/TagRule' + type: array + taskID: + description: The ID of the task associated with this notification rule. + type: string + updatedAt: + format: date-time + readOnly: true + type: string + required: + - orgID + - status + - name + - statusRules + - endpointID + type: object + NotificationRuleDiscriminator: + discriminator: + mapping: + http: '#/components/schemas/HTTPNotificationRule' + pagerduty: '#/components/schemas/PagerDutyNotificationRule' + slack: '#/components/schemas/SlackNotificationRule' + smtp: '#/components/schemas/SMTPNotificationRule' + telegram: '#/components/schemas/TelegramNotificationRule' + propertyName: type + oneOf: + - $ref: '#/components/schemas/SlackNotificationRule' + - $ref: '#/components/schemas/SMTPNotificationRule' + - $ref: '#/components/schemas/PagerDutyNotificationRule' + - $ref: '#/components/schemas/HTTPNotificationRule' + - $ref: '#/components/schemas/TelegramNotificationRule' + NotificationRuleUpdate: + properties: + description: + type: string + name: + type: string + status: + enum: + - active + - inactive + type: string + type: object + NotificationRules: + properties: + links: + $ref: '#/components/schemas/Links' + notificationRules: + items: + $ref: '#/components/schemas/NotificationRule' + type: array + ObjectExpression: + description: Allows the declaration of an anonymous object within a declaration + properties: + properties: + description: Object properties + items: + $ref: '#/components/schemas/Property' + type: array + type: + $ref: '#/components/schemas/NodeType' + type: object + OnboardingRequest: + properties: + bucket: + type: string + limit: + $ref: '#/components/schemas/Limit' + org: + type: string + password: + type: string + retentionPeriodHrs: + deprecated: true + type: integer + retentionPeriodSeconds: + type: integer + username: + type: string + required: + - username + - org + - bucket + type: object + OnboardingResponse: + properties: + auth: + $ref: '#/components/schemas/Authorization' + bucket: + $ref: '#/components/schemas/Bucket' + org: + $ref: '#/components/schemas/Organization' + user: + $ref: '#/components/schemas/UserResponse' + type: object + OptionStatement: + description: A single variable declaration + properties: + assignment: + oneOf: + - $ref: '#/components/schemas/VariableAssignment' + - $ref: '#/components/schemas/MemberAssignment' + type: + $ref: '#/components/schemas/NodeType' + type: object + Organization: + properties: + createdAt: + format: date-time + readOnly: true + type: string + defaultStorageType: + description: Discloses whether the organization uses TSM or IOx. + enum: + - tsm + - iox + type: string + description: + type: string + id: + readOnly: true + type: string + links: + example: + buckets: /api/v2/buckets?org=myorg + dashboards: /api/v2/dashboards?org=myorg + labels: /api/v2/orgs/1/labels + members: /api/v2/orgs/1/members + owners: /api/v2/orgs/1/owners + secrets: /api/v2/orgs/1/secrets + self: /api/v2/orgs/1 + tasks: /api/v2/tasks?org=myorg + properties: + buckets: + $ref: '#/components/schemas/Link' + dashboards: + $ref: '#/components/schemas/Link' + labels: + $ref: '#/components/schemas/Link' + members: + $ref: '#/components/schemas/Link' + owners: + $ref: '#/components/schemas/Link' + secrets: + $ref: '#/components/schemas/Link' + self: + $ref: '#/components/schemas/Link' + tasks: + $ref: '#/components/schemas/Link' + readOnly: true + type: object + name: + type: string + status: + default: active + description: If inactive, the organization is inactive. + enum: + - active + - inactive + type: string + updatedAt: + format: date-time + readOnly: true + type: string + required: + - name + Organizations: + properties: + links: + $ref: '#/components/schemas/Links' + orgs: + items: + $ref: '#/components/schemas/Organization' + type: array + type: object + Package: + description: Represents a complete package source tree. + properties: + files: + description: Package files + items: + $ref: '#/components/schemas/File' + type: array + package: + description: Package name + type: string + path: + description: Package import path + type: string + type: + $ref: '#/components/schemas/NodeType' + type: object + PackageClause: + description: Defines a package identifier + properties: + name: + $ref: '#/components/schemas/Identifier' + type: + $ref: '#/components/schemas/NodeType' + type: object + PagerDutyNotificationEndpoint: + allOf: + - $ref: '#/components/schemas/NotificationEndpointBase' + - properties: + clientURL: + type: string + routingKey: + type: string + required: + - routingKey + type: object + type: object + PagerDutyNotificationRule: + allOf: + - $ref: '#/components/schemas/NotificationRuleBase' + - $ref: '#/components/schemas/PagerDutyNotificationRuleBase' + PagerDutyNotificationRuleBase: + properties: + messageTemplate: + type: string + type: + enum: + - pagerduty + type: string + required: + - type + - messageTemplate + type: object + Params: + properties: + params: + additionalProperties: + enum: + - any + - bool + - duration + - float + - int + - string + - time + - uint + type: string + description: | + The `params` keys and value type defined in the script. + type: object + type: object + ParenExpression: + description: Represents an expression wrapped in parenthesis + properties: + expression: + $ref: '#/components/schemas/Expression' + type: + $ref: '#/components/schemas/NodeType' + type: object + PasswordResetBody: + properties: + password: + type: string + required: + - password + PatchBucketRequest: + description: | + An object that contains updated bucket properties to apply. + properties: + description: + description: | + A description of the bucket. + type: string + name: + description: | + The name of the bucket. + type: string + retentionRules: + $ref: '#/components/schemas/PatchRetentionRules' + type: object + PatchOrganizationRequest: + description: | + An object that contains updated organization properties to apply. + properties: + description: + description: | + The description of the organization. + type: string + name: + description: | + The name of the organization. + type: string + type: object + PatchRetentionRule: + properties: + everySeconds: + default: 2592000 + description: | + The number of seconds to keep data. + Default duration is `2592000` (30 days). + `0` represents infinite retention. + example: 86400 + format: int64 + minimum: 0 + type: integer + shardGroupDurationSeconds: + description: | + The [shard group duration](/influxdb/cloud-serverless/reference/glossary/#shard). + The number of seconds that each shard group covers. + + #### InfluxDB Cloud Serverless + + - Doesn't use `shardGroupDurationsSeconds`. + + #### InfluxDB OSS + + - Default value depends on the [bucket retention period](/influxdb/cloud-serverless/reference/internals/shards/#shard-group-duration). + + #### Related guides + + - InfluxDB [shards and shard groups](/influxdb/cloud-serverless/reference/internals/shards/) + format: int64 + type: integer + type: + default: expire + enum: + - expire + type: string + required: + - everySeconds + type: object + PatchRetentionRules: + description: Updates to rules to expire or retain data. No rules means no updates. + items: + $ref: '#/components/schemas/PatchRetentionRule' + type: array + Permission: + properties: + action: + enum: + - read + - write + type: string + resource: + $ref: '#/components/schemas/Resource' + properties: + id: + description: | + A resource ID. + Identifies a specific resource. + type: string + name: + description: | + The name of the resource. + _Note: not all resource types have a `name` property_. + type: string + org: + description: | + An organization name. + The organization that owns the resource. + type: string + orgID: + description: | + An organization ID. + Identifies the organization that owns the resource. + type: string + type: + description: | + A resource type. + Identifies the API resource's type (or _kind_). + enum: + - authorizations + - buckets + - dashboards + - orgs + - tasks + - telegrafs + - users + - variables + - secrets + - labels + - views + - documents + - notificationRules + - notificationEndpoints + - checks + - dbrp + - annotations + - sources + - scrapers + - notebooks + - remotes + - replications + - instance + - flows + - functions + - subscriptions + type: string + required: + - type + type: object + required: + - action + - resource + PipeExpression: + description: Call expression with pipe argument + properties: + argument: + $ref: '#/components/schemas/Expression' + call: + $ref: '#/components/schemas/CallExpression' + type: + $ref: '#/components/schemas/NodeType' + type: object + PipeLiteral: + description: Represents a specialized literal value, indicating the left hand value of a pipe expression + properties: + type: + $ref: '#/components/schemas/NodeType' + type: object + PostBucketRequest: + properties: + description: + description: | + A description of the bucket. + type: string + name: + description: | + The bucket name. + type: string + orgID: + description: | + The organization ID. + Specifies the organization that owns the bucket. + type: string + retentionRules: + $ref: '#/components/schemas/RetentionRules' + rp: + default: '0' + description: | + The retention policy for the bucket. + For InfluxDB 1.x, specifies the duration of time that each data point + in the retention policy persists. + + If you need compatibility with InfluxDB 1.x, specify a value for the `rp` property; + otherwise, see the `retentionRules` property. + + [Retention policy](/influxdb/v1.8/concepts/glossary/#retention-policy-rp) + is an InfluxDB 1.x concept. + The InfluxDB 2.x and Cloud equivalent is + [retention period](/influxdb/cloud-serverless/reference/glossary/#retention-period). + The InfluxDB `/api/v2` API uses `RetentionRules` to configure the retention period. + type: string + schemaType: + $ref: '#/components/schemas/SchemaType' + default: implicit + description: | + The schema Type. Default is `implicit`. + required: + - orgID + - name + PostCheck: + allOf: + - $ref: '#/components/schemas/CheckDiscriminator' + PostNotificationEndpoint: + allOf: + - $ref: '#/components/schemas/NotificationEndpointDiscriminator' + PostNotificationRule: + allOf: + - $ref: '#/components/schemas/NotificationRuleDiscriminator' + PostOrganizationRequest: + properties: + description: + description: | + The description of the organization. + type: string + name: + description: | + The name of the organization. + type: string + required: + - name + type: object + Property: + description: The value associated with a key + properties: + key: + $ref: '#/components/schemas/PropertyKey' + type: + $ref: '#/components/schemas/NodeType' + value: + $ref: '#/components/schemas/Expression' + type: object + PropertyKey: + oneOf: + - $ref: '#/components/schemas/Identifier' + - $ref: '#/components/schemas/StringLiteral' + Query: + description: Query InfluxDB with the Flux language + properties: + dialect: + $ref: '#/components/schemas/Dialect' + extern: + $ref: '#/components/schemas/File' + now: + description: | + Specifies the time that should be reported as `now` in the query. + Default is the server `now` time. + format: date-time + type: string + params: + additionalProperties: true + description: | + Key-value pairs passed as parameters during query execution. + + To use parameters in your query, pass a _`query`_ with `params` references (in dot notation)--for example: + + ```json + query: "from(bucket: params.mybucket)\ + |> range(start: params.rangeStart) |> limit(n:1)" + ``` + + and pass _`params`_ with the key-value pairs--for example: + + ```json + params: { + "mybucket": "environment", + "rangeStart": "-30d" + } + ``` + + During query execution, InfluxDB passes _`params`_ to your script and substitutes the values. + + #### Limitations + + - If you use _`params`_, you can't use _`extern`_. + type: object + query: + description: The query script to execute. + type: string + type: + description: The type of query. Must be "flux". + enum: + - flux + type: string + required: + - query + type: object + QueryEditMode: + enum: + - builder + - advanced + type: string + QueryVariableProperties: + properties: + type: + enum: + - query + type: string + values: + properties: + language: + type: string + query: + type: string + type: object + RangeThreshold: + allOf: + - $ref: '#/components/schemas/ThresholdBase' + - properties: + max: + format: float + type: number + min: + format: float + type: number + type: + enum: + - range + type: string + within: + type: boolean + required: + - type + - min + - max + - within + type: object + Ready: + properties: + started: + example: '2019-03-13T10:09:33.891196-04:00' + format: date-time + type: string + status: + enum: + - ready + type: string + up: + example: 14m45.911966424s + type: string + type: object + RegexpLiteral: + description: Expressions begin and end with `/` and are regular expressions with syntax accepted by RE2 + properties: + type: + $ref: '#/components/schemas/NodeType' + value: + type: string + type: object + RenamableField: + description: Describes a field that can be renamed and made visible or invisible. + properties: + displayName: + description: The name that a field is renamed to by the user. + type: string + internalName: + description: The calculated name of a field. + readOnly: true + type: string + visible: + description: Indicates whether this field should be visible on the table. + type: boolean + type: object + Resource: + properties: + id: + description: | + A resource ID. + Identifies a specific resource. + type: string + name: + description: | + The name of the resource. + _Note: not all resource types have a `name` property_. + type: string + org: + description: | + An organization name. + The organization that owns the resource. + type: string + orgID: + description: | + An organization ID. + Identifies the organization that owns the resource. + type: string + type: + description: | + A resource type. + Identifies the API resource's type (or _kind_). + enum: + - authorizations + - buckets + - dashboards + - orgs + - tasks + - telegrafs + - users + - variables + - secrets + - labels + - views + - documents + - notificationRules + - notificationEndpoints + - checks + - dbrp + - annotations + - sources + - scrapers + - notebooks + - remotes + - replications + - instance + - flows + - functions + - subscriptions + type: string + required: + - type + type: object + ResourceMember: + allOf: + - $ref: '#/components/schemas/UserResponse' + - properties: + role: + default: member + enum: + - member + type: string + type: object + ResourceMembers: + properties: + links: + properties: + self: + format: uri + type: string + type: object + users: + items: + $ref: '#/components/schemas/ResourceMember' + type: array + type: object + ResourceOwner: + allOf: + - $ref: '#/components/schemas/UserResponse' + - properties: + role: + default: owner + enum: + - owner + type: string + type: object + ResourceOwners: + properties: + links: + properties: + self: + format: uri + type: string + type: object + users: + items: + $ref: '#/components/schemas/ResourceOwner' + type: array + type: object + RetentionRule: + properties: + everySeconds: + default: 2592000 + description: | + The duration in seconds for how long data will be kept in the database. + The default duration is 2592000 (30 days). + 0 represents infinite retention. + example: 86400 + format: int64 + minimum: 0 + type: integer + shardGroupDurationSeconds: + description: | + The shard group duration. + The duration or interval (in seconds) that each shard group covers. + + #### InfluxDB Cloud Serverless + + - Does not use `shardGroupDurationsSeconds`. + format: int64 + type: integer + type: + default: expire + enum: + - expire + type: string + required: + - everySeconds + type: object + RetentionRules: + description: | + Retention rules to expire or retain data. + The InfluxDB `/api/v2` API uses `RetentionRules` to configure the [retention period](/influxdb/cloud-serverless/reference/glossary/#retention-period). + + #### InfluxDB Cloud Serverless + + - `retentionRules` is required. + + #### InfluxDB OSS + + - `retentionRules` isn't required. + items: + $ref: '#/components/schemas/RetentionRule' + type: array + ReturnStatement: + description: Defines an expression to return + properties: + argument: + $ref: '#/components/schemas/Expression' + type: + $ref: '#/components/schemas/NodeType' + type: object + Routes: + properties: + authorizations: + format: uri + type: string + buckets: + format: uri + type: string + dashboards: + format: uri + type: string + external: + properties: + statusFeed: + format: uri + type: string + type: object + flags: + format: uri + type: string + me: + format: uri + type: string + orgs: + format: uri + type: string + query: + properties: + analyze: + format: uri + type: string + ast: + format: uri + type: string + self: + format: uri + type: string + suggestions: + format: uri + type: string + type: object + setup: + format: uri + type: string + signin: + format: uri + type: string + signout: + format: uri + type: string + sources: + format: uri + type: string + system: + properties: + debug: + format: uri + type: string + health: + format: uri + type: string + metrics: + format: uri + type: string + type: object + tasks: + format: uri + type: string + telegrafs: + format: uri + type: string + users: + format: uri + type: string + variables: + format: uri + type: string + write: + format: uri + type: string + RuleStatusLevel: + description: The state to record if check matches a criteria. + enum: + - UNKNOWN + - OK + - INFO + - CRIT + - WARN + - ANY + type: string + Run: + properties: + finishedAt: + description: The time ([RFC3339Nano date/time format](https://go.dev/src/time/format.go)) the run finished executing. + example: 2006-01-02T15:04:05.999999999Z07:00 + format: date-time + readOnly: true + type: string + flux: + description: Flux used for the task + readOnly: true + type: string + id: + readOnly: true + type: string + links: + example: + retry: /api/v2/tasks/1/runs/1/retry + self: /api/v2/tasks/1/runs/1 + task: /api/v2/tasks/1 + properties: + retry: + format: uri + type: string + self: + format: uri + type: string + task: + format: uri + type: string + readOnly: true + type: object + log: + description: An array of logs associated with the run. + items: + $ref: '#/components/schemas/LogEvent' + readOnly: true + type: array + requestedAt: + description: The time ([RFC3339Nano date/time format](/influxdb/cloud-serverless/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](/influxdb/cloud-serverless/reference/glossary/#rfc3339-timestamp) used for the run's `now` option. + format: date-time + type: string + startedAt: + description: The time ([RFC3339Nano date/time format](https://go.dev/src/time/format.go)) the run started executing. + example: 2006-01-02T15:04:05.999999999Z07:00 + format: date-time + readOnly: true + type: string + status: + enum: + - scheduled + - started + - failed + - success + - canceled + readOnly: true + type: string + taskID: + readOnly: true + type: string + RunManually: + properties: + scheduledFor: + description: | + The time [RFC3339 date/time format](/influxdb/cloud-serverless/reference/glossary/#rfc3339-timestamp) + used for the run's `now` option. + Default is the server _now_ time. + format: date-time + nullable: true + type: string + Runs: + properties: + links: + $ref: '#/components/schemas/Links' + runs: + items: + $ref: '#/components/schemas/Run' + type: array + type: object + SMTPNotificationRule: + allOf: + - $ref: '#/components/schemas/NotificationRuleBase' + - $ref: '#/components/schemas/SMTPNotificationRuleBase' + SMTPNotificationRuleBase: + properties: + bodyTemplate: + type: string + subjectTemplate: + type: string + to: + type: string + type: + enum: + - smtp + type: string + required: + - type + - subjectTemplate + - to + type: object + ScatterViewProperties: + properties: + adaptiveZoomHide: + type: boolean + colors: + description: Colors define color encoding of data into a visualization + items: + type: string + type: array + fillColumns: + items: + type: string + type: array + generateXAxisTicks: + items: + type: string + type: array + generateYAxisTicks: + items: + type: string + type: array + legendColorizeRows: + type: boolean + legendHide: + type: boolean + legendOpacity: + format: float + type: number + legendOrientationThreshold: + type: integer + note: + type: string + queries: + items: + $ref: '#/components/schemas/DashboardQuery' + type: array + shape: + enum: + - chronograf-v2 + type: string + showNoteWhenEmpty: + description: If true, will display note when empty + type: boolean + symbolColumns: + items: + type: string + type: array + timeFormat: + type: string + type: + enum: + - scatter + type: string + xAxisLabel: + type: string + xColumn: + type: string + xDomain: + items: + type: number + maxItems: 2 + type: array + xPrefix: + type: string + xSuffix: + type: string + xTickStart: + format: float + type: number + xTickStep: + format: float + type: number + xTotalTicks: + type: integer + yAxisLabel: + type: string + yColumn: + type: string + yDomain: + items: + type: number + maxItems: 2 + type: array + yPrefix: + type: string + ySuffix: + type: string + yTickStart: + format: float + type: number + yTickStep: + format: float + type: number + yTotalTicks: + type: integer + required: + - type + - queries + - colors + - shape + - note + - showNoteWhenEmpty + - xColumn + - yColumn + - fillColumns + - symbolColumns + - xDomain + - yDomain + - xAxisLabel + - yAxisLabel + - xPrefix + - yPrefix + - xSuffix + - ySuffix + type: object + SchemaType: + enum: + - implicit + - explicit + type: string + Script: + properties: + createdAt: + format: date-time + readOnly: true + type: string + description: + type: string + id: + readOnly: true + type: string + language: + $ref: '#/components/schemas/ScriptLanguage' + name: + type: string + orgID: + type: string + script: + description: The script to execute. + type: string + updatedAt: + format: date-time + readOnly: true + type: string + url: + description: The invocation endpoint address. + type: string + required: + - name + - orgID + - script + ScriptCreateRequest: + properties: + description: + description: Script description. A description of the script. + type: string + language: + $ref: '#/components/schemas/ScriptLanguage' + name: + description: Script name. The name must be unique within the organization. + type: string + script: + description: The script to execute. + type: string + required: + - name + - script + - language + - description + type: object + ScriptHTTPResponseData: + description: | + The response body contains the results of the executed script. + The response is user-defined and dynamic. + format: binary + type: string + ScriptInvocationParams: + properties: + params: + additionalProperties: true + description: | + The script parameters. + `params` contains key-value pairs that map values to the **params.keys** + in a script. + When you invoke a script with `params`, InfluxDB passes the values as + invocation parameters to the script. + type: object + type: object + ScriptLanguage: + enum: + - flux + - sql + type: string + ScriptUpdateRequest: + properties: + description: + description: A description of the script. + type: string + script: + description: The script to execute. + type: string + type: object + Scripts: + properties: + scripts: + items: + $ref: '#/components/schemas/Script' + type: array + type: object + SecretKeys: + properties: + secrets: + items: + type: string + type: array + type: object + SecretKeysResponse: + allOf: + - $ref: '#/components/schemas/SecretKeys' + - properties: + links: + properties: + org: + type: string + self: + type: string + readOnly: true + type: object + type: object + Secrets: + additionalProperties: + type: string + example: + apikey: abc123xyz + SimpleTableViewProperties: + properties: + note: + type: string + queries: + items: + $ref: '#/components/schemas/DashboardQuery' + type: array + shape: + enum: + - chronograf-v2 + type: string + showAll: + type: boolean + showNoteWhenEmpty: + description: If true, will display note when empty + type: boolean + type: + enum: + - simple-table + type: string + required: + - type + - showAll + - queries + - shape + - note + - showNoteWhenEmpty + type: object + SingleStatViewProperties: + properties: + colors: + description: Colors define color encoding of data into a visualization + items: + $ref: '#/components/schemas/DashboardColor' + type: array + decimalPlaces: + $ref: '#/components/schemas/DecimalPlaces' + note: + type: string + prefix: + type: string + queries: + items: + $ref: '#/components/schemas/DashboardQuery' + type: array + shape: + enum: + - chronograf-v2 + type: string + showNoteWhenEmpty: + description: If true, will display note when empty + type: boolean + staticLegend: + $ref: '#/components/schemas/StaticLegend' + suffix: + type: string + tickPrefix: + type: string + tickSuffix: + type: string + type: + enum: + - single-stat + type: string + required: + - type + - queries + - colors + - shape + - note + - showNoteWhenEmpty + - prefix + - tickPrefix + - suffix + - tickSuffix + - decimalPlaces + type: object + SlackNotificationEndpoint: + allOf: + - $ref: '#/components/schemas/NotificationEndpointBase' + - properties: + token: + description: Specifies the API token string. Specify either `URL` or `Token`. + type: string + url: + description: Specifies the URL of the Slack endpoint. Specify either `URL` or `Token`. + type: string + type: object + type: object + SlackNotificationRule: + allOf: + - $ref: '#/components/schemas/NotificationRuleBase' + - $ref: '#/components/schemas/SlackNotificationRuleBase' + SlackNotificationRuleBase: + properties: + channel: + type: string + messageTemplate: + type: string + type: + enum: + - slack + type: string + required: + - type + - messageTemplate + type: object + Stack: + properties: + createdAt: + format: date-time + readOnly: true + type: string + events: + items: + properties: + description: + type: string + eventType: + type: string + name: + type: string + resources: + items: + properties: + apiVersion: + type: string + associations: + items: + properties: + kind: + $ref: '#/components/schemas/TemplateKind' + metaName: + type: string + type: object + type: array + kind: + $ref: '#/components/schemas/TemplateKind' + links: + properties: + self: + type: string + type: object + resourceID: + type: string + templateMetaName: + type: string + type: object + type: array + sources: + items: + type: string + type: array + updatedAt: + format: date-time + readOnly: true + type: string + urls: + items: + type: string + type: array + type: object + type: array + id: + type: string + orgID: + type: string + type: object + Statement: + oneOf: + - $ref: '#/components/schemas/BadStatement' + - $ref: '#/components/schemas/VariableAssignment' + - $ref: '#/components/schemas/MemberAssignment' + - $ref: '#/components/schemas/ExpressionStatement' + - $ref: '#/components/schemas/ReturnStatement' + - $ref: '#/components/schemas/OptionStatement' + - $ref: '#/components/schemas/BuiltinStatement' + - $ref: '#/components/schemas/TestStatement' + StaticLegend: + description: StaticLegend represents the options specific to the static legend + properties: + colorizeRows: + type: boolean + heightRatio: + format: float + type: number + opacity: + format: float + type: number + orientationThreshold: + type: integer + show: + type: boolean + valueAxis: + type: string + widthRatio: + format: float + type: number + type: object + StatusRule: + properties: + count: + type: integer + currentLevel: + $ref: '#/components/schemas/RuleStatusLevel' + period: + type: string + previousLevel: + $ref: '#/components/schemas/RuleStatusLevel' + type: object + StringLiteral: + description: Expressions begin and end with double quote marks + properties: + type: + $ref: '#/components/schemas/NodeType' + value: + type: string + type: object + TableViewProperties: + properties: + colors: + description: Colors define color encoding of data into a visualization + items: + $ref: '#/components/schemas/DashboardColor' + type: array + decimalPlaces: + $ref: '#/components/schemas/DecimalPlaces' + fieldOptions: + description: fieldOptions represent the fields retrieved by the query with customization options + items: + $ref: '#/components/schemas/RenamableField' + type: array + note: + type: string + queries: + items: + $ref: '#/components/schemas/DashboardQuery' + type: array + shape: + enum: + - chronograf-v2 + type: string + showNoteWhenEmpty: + description: If true, will display note when empty + type: boolean + tableOptions: + properties: + fixFirstColumn: + description: fixFirstColumn indicates whether the first column of the table should be locked + type: boolean + sortBy: + $ref: '#/components/schemas/RenamableField' + verticalTimeAxis: + description: verticalTimeAxis describes the orientation of the table by indicating whether the time axis will be displayed vertically + type: boolean + wrapping: + description: Wrapping describes the text wrapping style to be used in table views + enum: + - truncate + - wrap + - single-line + type: string + type: object + timeFormat: + description: timeFormat describes the display format for time values according to moment.js date formatting + type: string + type: + enum: + - table + type: string + required: + - type + - queries + - colors + - shape + - note + - showNoteWhenEmpty + - tableOptions + - fieldOptions + - timeFormat + - decimalPlaces + type: object + TagRule: + properties: + key: + type: string + operator: + enum: + - equal + - notequal + - equalregex + - notequalregex + type: string + value: + type: string + type: object + Task: + properties: + authorizationID: + description: | + An authorization ID. + Specifies the authorization used when the task communicates with the query engine. + + To find an authorization ID, use the + [`GET /api/v2/authorizations` endpoint](#operation/GetAuthorizations) to + list authorizations. + type: string + createdAt: + format: date-time + readOnly: true + type: string + cron: + description: A [Cron expression](https://en.wikipedia.org/wiki/Cron#Overview) that defines the schedule on which the task runs. InfluxDB uses the system time when evaluating Cron expressions. + type: string + description: + description: A description of the task. + type: string + every: + description: The interval ([duration literal](/influxdb/cloud-serverless/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 + flux: + description: | + The Flux script that the task executes. + + #### Limitations + - If you use the `flux` property, you can't use the `scriptID` and `scriptParameters` properties. + format: flux + type: string + id: + readOnly: true + type: string + labels: + $ref: '#/components/schemas/Labels' + lastRunError: + readOnly: true + type: string + lastRunStatus: + enum: + - failed + - success + - canceled + readOnly: true + type: string + latestCompleted: + description: A timestamp ([RFC3339 date/time format](/influxdb/cloud-serverless/reference/glossary/#rfc3339-timestamp)) of the latest scheduled and completed run. + format: date-time + readOnly: true + type: string + links: + example: + labels: /api/v2/tasks/1/labels + logs: /api/v2/tasks/1/logs + members: /api/v2/tasks/1/members + owners: /api/v2/tasks/1/owners + runs: /api/v2/tasks/1/runs + self: /api/v2/tasks/1 + properties: + labels: + $ref: '#/components/schemas/Link' + logs: + $ref: '#/components/schemas/Link' + members: + $ref: '#/components/schemas/Link' + owners: + $ref: '#/components/schemas/Link' + runs: + $ref: '#/components/schemas/Link' + self: + $ref: '#/components/schemas/Link' + readOnly: true + type: object + name: + description: The name of the task. + type: string + offset: + description: A [duration](https://docs.influxdata.com/flux/v0.x/spec/lexical-elements/#duration-literals) to delay execution of the task after the scheduled time has elapsed. `0` removes the offset. + format: duration + type: string + org: + description: | + An [organization](/influxdb/cloud-serverless/reference/glossary/#organization) name. + Specifies the organization that owns the task. + type: string + orgID: + description: | + An [organization](/influxdb/cloud-serverless/reference/glossary/#organization) ID. + Specifies the organization that owns the task. + type: string + ownerID: + description: | + A [user](/influxdb/cloud-serverless/reference/glossary/#user) ID. + Specifies the owner of the task. + + To find a user ID, you can use the + [`GET /api/v2/users` endpoint](#operation/GetUsers) to + list users. + type: string + scriptID: + description: | + A script ID. + Specifies the invokable script that the task executes. + + #### Limitations + + - If you use the `scriptID` property, you can't use the `flux` property. + + + type: string + scriptParameters: + description: | + Key-value pairs for `params` in the script. + Defines the invocation parameter values passed to the script specified by `scriptID`. + When running the task, InfluxDB executes the script with the parameters + you provide. + + #### Limitations + + - To use `scriptParameters`, you must provide a `scriptID`. + - If you use the `scriptID` and `scriptParameters` properties, you can't use the `flux` property. + type: object + status: + $ref: '#/components/schemas/TaskStatusType' + updatedAt: + format: date-time + readOnly: true + type: string + required: + - id + - name + - orgID + type: object + TaskCreateRequest: + properties: + cron: + description: A [Cron expression](https://en.wikipedia.org/wiki/Cron#Overview) that defines the schedule on which the task runs. InfluxDB bases cron runs on the system time. + type: string + description: + description: The description of the task. + type: string + every: + description: | + The interval ([duration literal](https://docs.influxdata.com/flux/v0.x/spec/lexical-elements/#duration-literals))) at which the task runs. + `every` also determines when the task first runs, depending on the specified time. + type: string + flux: + description: | + The Flux script that the task runs. + + #### Limitations + + - If you use the `flux` property, you can't use the `scriptID` and `scriptParameters` properties. + type: string + name: + description: The name of the task + type: string + offset: + description: A [duration](https://docs.influxdata.com/flux/v0.x/spec/lexical-elements/#duration-literals) to delay execution of the task after the scheduled time has elapsed. `0` removes the offset. + format: duration + type: string + org: + description: The name of the organization that owns the task. + type: string + orgID: + description: The ID of the organization that owns the task. + type: string + scriptID: + description: | + The ID of the script that the task runs. + + #### Limitations + + - If you use the `scriptID` property, you can't use the `flux` property. + type: string + scriptParameters: + description: | + The parameter key-value pairs passed to the script (referenced by `scriptID`) during the task run. + + #### Limitations + + - `scriptParameters` requires `scriptID`. + - If you use the `scriptID` and `scriptParameters` properties, you can't use the `flux` property. + type: object + status: + $ref: '#/components/schemas/TaskStatusType' + type: object + TaskStatusType: + description: | + `inactive` cancels scheduled runs and prevents manual runs of the task. + enum: + - active + - inactive + type: string + TaskUpdateRequest: + properties: + cron: + description: Update the 'cron' option in the flux script. + type: string + description: + description: Update the description of the task. + type: string + every: + description: Update the 'every' option in the flux script. + type: string + flux: + description: Update the Flux script that the task runs. + type: string + name: + description: Update the 'name' option in the flux script. + type: string + offset: + description: Update the 'offset' option in the flux script. + type: string + scriptID: + description: Update the 'scriptID' of the task. + type: string + scriptParameters: + description: Update the 'scriptParameters' of the task. + type: object + status: + $ref: '#/components/schemas/TaskStatusType' + type: object + Tasks: + properties: + links: + $ref: '#/components/schemas/Links' + readOnly: true + tasks: + items: + $ref: '#/components/schemas/Task' + type: array + type: object + Telegraf: + allOf: + - $ref: '#/components/schemas/TelegrafRequest' + - properties: + id: + readOnly: true + type: string + labels: + $ref: '#/components/schemas/Labels' + readOnly: true + links: + example: + labels: /api/v2/telegrafs/1/labels + members: /api/v2/telegrafs/1/members + owners: /api/v2/telegrafs/1/owners + self: /api/v2/telegrafs/1 + properties: + labels: + $ref: '#/components/schemas/Link' + members: + $ref: '#/components/schemas/Link' + owners: + $ref: '#/components/schemas/Link' + self: + $ref: '#/components/schemas/Link' + readOnly: true + type: object + type: object + type: object + TelegrafPlugin: + properties: + config: + type: string + description: + type: string + name: + type: string + type: + type: string + type: object + TelegrafPluginRequest: + properties: + config: + type: string + description: + type: string + metadata: + properties: + buckets: + items: + type: string + type: array + type: object + name: + type: string + orgID: + type: string + plugins: + items: + properties: + alias: + type: string + config: + type: string + description: + type: string + name: + type: string + type: + type: string + type: object + type: array + type: object + TelegrafPlugins: + properties: + os: + type: string + plugins: + items: + $ref: '#/components/schemas/TelegrafPlugin' + type: array + version: + type: string + type: object + TelegrafRequest: + properties: + config: + type: string + description: + type: string + metadata: + properties: + buckets: + items: + type: string + type: array + type: object + name: + type: string + orgID: + type: string + type: object + Telegrafs: + properties: + configurations: + items: + $ref: '#/components/schemas/Telegraf' + type: array + type: object + TelegramNotificationEndpoint: + allOf: + - $ref: '#/components/schemas/NotificationEndpointBase' + - properties: + channel: + description: The ID of the telegram channel; a chat_id in https://core.telegram.org/bots/api#sendmessage . + type: string + token: + description: Specifies the Telegram bot token. See https://core.telegram.org/bots#creating-a-new-bot . + type: string + required: + - token + - channel + type: object + type: object + TelegramNotificationRule: + allOf: + - $ref: '#/components/schemas/NotificationRuleBase' + - $ref: '#/components/schemas/TelegramNotificationRuleBase' + TelegramNotificationRuleBase: + properties: + disableWebPagePreview: + description: Disables preview of web links in the sent messages when "true". Defaults to "false". + type: boolean + messageTemplate: + description: The message template as a flux interpolated string. + type: string + parseMode: + description: Parse mode of the message text per https://core.telegram.org/bots/api#formatting-options. Defaults to "MarkdownV2". + enum: + - MarkdownV2 + - HTML + - Markdown + type: string + type: + description: The discriminator between other types of notification rules is "telegram". + enum: + - telegram + type: string + required: + - type + - messageTemplate + - channel + type: object + Template: + items: + description: | + A template entry. + Defines an InfluxDB resource in a template. + properties: + apiVersion: + example: influxdata.com/v2alpha1 + type: string + kind: + $ref: '#/components/schemas/TemplateKind' + metadata: + description: | + Metadata properties used for the resource when the template is applied. + properties: + name: + type: string + type: object + spec: + description: | + Configuration properties used for the resource when the template is applied. + Key-value pairs map to the specification for the resource. + + The following code samples show `spec` configurations for template resources: + + - A bucket: + + ```json + { "spec": { + "name": "iot_center", + "retentionRules": [{ + "everySeconds": 2.592e+06, + "type": "expire" + }] + } + } + ``` + + - A variable: + + ```json + { "spec": { + "language": "flux", + "name": "Node_Service", + "query": "import \"influxdata/influxdb/v1\"\r\nv1.tagValues(bucket: \"iot_center\", + tag: \"service\")", + "type": "query" + } + } + ``` + type: object + type: object + type: array + TemplateApply: + properties: + actions: + description: | + A list of `action` objects. + Actions let you customize how InfluxDB applies templates in the request. + + You can use the following actions to prevent creating or updating resources: + + - A `skipKind` action skips template resources of a specified `kind`. + - A `skipResource` action skips template resources with a specified `metadata.name` + and `kind`. + items: + oneOf: + - properties: + action: + enum: + - skipKind + type: string + properties: + properties: + kind: + $ref: '#/components/schemas/TemplateKind' + required: + - kind + type: object + type: object + - properties: + action: + enum: + - skipResource + type: string + properties: + properties: + kind: + $ref: '#/components/schemas/TemplateKind' + resourceTemplateName: + type: string + required: + - kind + - resourceTemplateName + type: object + type: object + type: array + dryRun: + description: | + Only applies a dry run of the templates passed in the request. + + - Validates the template and generates a resource diff and summary. + - Doesn't install templates or make changes to the InfluxDB instance. + type: boolean + envRefs: + additionalProperties: + oneOf: + - type: string + - type: integer + - type: number + - type: boolean + description: | + An object with key-value pairs that map to **environment references** in templates. + + Environment references in templates are `envRef` objects with an `envRef.key` + property. + To substitute a custom environment reference value when applying templates, + pass `envRefs` with the `envRef.key` and the value. + + When you apply a template, InfluxDB replaces `envRef` objects in the template + with the values that you provide in the `envRefs` parameter. + + The following template fields may use environment references: + + - `metadata.name` + - `spec.endpointName` + - `spec.associations.name` + + + type: object + orgID: + description: | + Organization ID. + InfluxDB applies templates to this organization. + The organization owns all resources created by the template. + + To find your organization, see how to + [view organizations](/influxdb/cloud-serverless/organizations/view-orgs/). + type: string + remotes: + description: | + A list of URLs for template files. + + To apply a template manifest file located at a URL, pass `remotes` + with an array that contains the URL. + items: + properties: + contentType: + type: string + url: + type: string + required: + - url + type: object + type: array + secrets: + additionalProperties: + type: string + description: | + An object with key-value pairs that map to **secrets** in queries. + + Queries may reference secrets stored in InfluxDB--for example, + the following Flux script retrieves `POSTGRES_USERNAME` and `POSTGRES_PASSWORD` + secrets and then uses them to connect to a PostgreSQL database: + + ```js + import "sql" + import "influxdata/influxdb/secrets" + + username = secrets.get(key: "POSTGRES_USERNAME") + password = secrets.get(key: "POSTGRES_PASSWORD") + + sql.from( + driverName: "postgres", + dataSourceName: "postgresql://${username}:${password}@localhost:5432", + query: "SELECT * FROM example_table", + ) + ``` + + To define secret values in your `/api/v2/templates/apply` request, + pass the `secrets` parameter with key-value pairs--for example: + + ```json + { + ... + "secrets": { + "POSTGRES_USERNAME": "pguser", + "POSTGRES_PASSWORD": "foo" + } + ... + } + ``` + + InfluxDB stores the key-value pairs as secrets that you can access with `secrets.get()`. + Once stored, you can't view secret values in InfluxDB. + + + type: object + stackID: + description: | + ID of the stack to update. + + To apply templates to an existing stack in the organization, use the `stackID` parameter. + If you apply templates without providing a stack ID, + InfluxDB initializes a new stack with all new resources. + + To find a stack ID, use the InfluxDB [`/api/v2/stacks` API endpoint](#operation/ListStacks) to list stacks. + + + type: string + template: + description: | + A template object to apply. + A template object has a `contents` property + with an array of InfluxDB resource configurations. + + Pass `template` to apply only one template object. + If you use `template`, you can't use the `templates` parameter. + If you want to apply multiple template objects, use `templates` instead. + properties: + contentType: + type: string + contents: + $ref: '#/components/schemas/Template' + sources: + items: + type: string + type: array + type: object + templates: + description: | + A list of template objects to apply. + A template object has a `contents` property + with an array of InfluxDB resource configurations. + + Use the `templates` parameter to apply multiple template objects. + If you use `templates`, you can't use the `template` parameter. + items: + properties: + contentType: + type: string + contents: + $ref: '#/components/schemas/Template' + sources: + items: + type: string + type: array + type: object + type: array + type: object + TemplateChart: + properties: + height: + type: integer + properties: + $ref: '#/components/schemas/ViewProperties' + width: + type: integer + xPos: + type: integer + yPos: + type: integer + type: object + TemplateEnvReferences: + items: + properties: + defaultValue: + description: Default value that will be provided for the reference when no value is provided + nullable: true + oneOf: + - type: string + - type: integer + - type: number + - type: boolean + envRefKey: + description: Key identified as environment reference and is the key identified in the template + type: string + resourceField: + description: Field the environment reference corresponds too + type: string + value: + description: Value provided to fulfill reference + nullable: true + oneOf: + - type: string + - type: integer + - type: number + - type: boolean + required: + - resourceField + - envRefKey + type: object + type: array + TemplateExportByID: + properties: + orgIDs: + items: + properties: + orgID: + type: string + resourceFilters: + properties: + byLabel: + items: + type: string + type: array + byResourceKind: + items: + $ref: '#/components/schemas/TemplateKind' + type: array + type: object + type: object + type: array + resources: + items: + properties: + id: + type: string + kind: + $ref: '#/components/schemas/TemplateKind' + name: + description: if defined with id, name is used for resource exported by id. if defined independently, resources strictly matching name are exported + type: string + required: + - id + - kind + type: object + type: array + stackID: + type: string + type: object + TemplateExportByName: + properties: + orgIDs: + items: + properties: + orgID: + type: string + resourceFilters: + properties: + byLabel: + items: + type: string + type: array + byResourceKind: + items: + $ref: '#/components/schemas/TemplateKind' + type: array + type: object + type: object + type: array + resources: + items: + properties: + kind: + $ref: '#/components/schemas/TemplateKind' + name: + type: string + required: + - name + - kind + type: object + type: array + stackID: + type: string + type: object + TemplateKind: + enum: + - Bucket + - Check + - CheckDeadman + - CheckThreshold + - Dashboard + - Label + - NotificationEndpoint + - NotificationEndpointHTTP + - NotificationEndpointPagerDuty + - NotificationEndpointSlack + - NotificationRule + - Task + - Telegraf + - Variable + type: string + TemplateSummary: + properties: + diff: + properties: + buckets: + items: + properties: + id: + type: string + kind: + $ref: '#/components/schemas/TemplateKind' + new: + properties: + description: + type: string + name: + type: string + retentionRules: + $ref: '#/components/schemas/RetentionRules' + type: object + old: + properties: + description: + type: string + name: + type: string + retentionRules: + $ref: '#/components/schemas/RetentionRules' + type: object + stateStatus: + type: string + templateMetaName: + type: string + type: object + type: array + checks: + items: + properties: + id: + type: string + kind: + $ref: '#/components/schemas/TemplateKind' + new: + $ref: '#/components/schemas/CheckDiscriminator' + old: + $ref: '#/components/schemas/CheckDiscriminator' + stateStatus: + type: string + templateMetaName: + type: string + type: object + type: array + dashboards: + items: + properties: + id: + type: string + kind: + $ref: '#/components/schemas/TemplateKind' + new: + properties: + charts: + items: + $ref: '#/components/schemas/TemplateChart' + type: array + description: + type: string + name: + type: string + type: object + old: + properties: + charts: + items: + $ref: '#/components/schemas/TemplateChart' + type: array + description: + type: string + name: + type: string + type: object + stateStatus: + type: string + templateMetaName: + type: string + type: object + type: array + labelMappings: + items: + properties: + labelID: + type: string + labelName: + type: string + labelTemplateMetaName: + type: string + resourceID: + type: string + resourceName: + type: string + resourceTemplateMetaName: + type: string + resourceType: + type: string + status: + type: string + type: object + type: array + labels: + items: + properties: + id: + type: string + kind: + $ref: '#/components/schemas/TemplateKind' + new: + properties: + color: + type: string + description: + type: string + name: + type: string + type: object + old: + properties: + color: + type: string + description: + type: string + name: + type: string + type: object + stateStatus: + type: string + templateMetaName: + type: string + type: object + type: array + notificationEndpoints: + items: + properties: + id: + type: string + kind: + $ref: '#/components/schemas/TemplateKind' + new: + $ref: '#/components/schemas/NotificationEndpointDiscriminator' + old: + $ref: '#/components/schemas/NotificationEndpointDiscriminator' + stateStatus: + type: string + templateMetaName: + type: string + type: object + type: array + notificationRules: + items: + properties: + id: + type: string + kind: + $ref: '#/components/schemas/TemplateKind' + new: + properties: + description: + type: string + endpointID: + type: string + endpointName: + type: string + endpointType: + type: string + every: + type: string + messageTemplate: + type: string + name: + type: string + offset: + type: string + status: + type: string + statusRules: + items: + properties: + currentLevel: + type: string + previousLevel: + type: string + type: object + type: array + tagRules: + items: + properties: + key: + type: string + operator: + type: string + value: + type: string + type: object + type: array + type: object + old: + properties: + description: + type: string + endpointID: + type: string + endpointName: + type: string + endpointType: + type: string + every: + type: string + messageTemplate: + type: string + name: + type: string + offset: + type: string + status: + type: string + statusRules: + items: + properties: + currentLevel: + type: string + previousLevel: + type: string + type: object + type: array + tagRules: + items: + properties: + key: + type: string + operator: + type: string + value: + type: string + type: object + type: array + type: object + stateStatus: + type: string + templateMetaName: + type: string + type: object + type: array + tasks: + items: + properties: + id: + type: string + kind: + $ref: '#/components/schemas/TemplateKind' + new: + properties: + cron: + type: string + description: + type: string + every: + type: string + name: + type: string + offset: + type: string + query: + type: string + status: + type: string + type: object + old: + properties: + cron: + type: string + description: + type: string + every: + type: string + name: + type: string + offset: + type: string + query: + type: string + status: + type: string + type: object + stateStatus: + type: string + templateMetaName: + type: string + type: object + type: array + telegrafConfigs: + items: + properties: + id: + type: string + kind: + $ref: '#/components/schemas/TemplateKind' + new: + $ref: '#/components/schemas/TelegrafRequest' + old: + $ref: '#/components/schemas/TelegrafRequest' + stateStatus: + type: string + templateMetaName: + type: string + type: object + type: array + variables: + items: + properties: + id: + type: string + kind: + $ref: '#/components/schemas/TemplateKind' + new: + properties: + args: + $ref: '#/components/schemas/VariableProperties' + description: + type: string + name: + type: string + type: object + old: + properties: + args: + $ref: '#/components/schemas/VariableProperties' + description: + type: string + name: + type: string + type: object + stateStatus: + type: string + templateMetaName: + type: string + type: object + type: array + type: object + errors: + items: + properties: + fields: + items: + type: string + type: array + indexes: + items: + type: integer + type: array + kind: + $ref: '#/components/schemas/TemplateKind' + reason: + type: string + type: object + type: array + sources: + items: + type: string + type: array + stackID: + type: string + summary: + properties: + buckets: + items: + properties: + description: + type: string + envReferences: + $ref: '#/components/schemas/TemplateEnvReferences' + id: + type: string + kind: + $ref: '#/components/schemas/TemplateKind' + labelAssociations: + items: + $ref: '#/components/schemas/TemplateSummaryLabel' + type: array + name: + type: string + orgID: + type: string + retentionPeriod: + type: integer + templateMetaName: + type: string + type: object + type: array + checks: + items: + allOf: + - $ref: '#/components/schemas/CheckDiscriminator' + - properties: + envReferences: + $ref: '#/components/schemas/TemplateEnvReferences' + kind: + $ref: '#/components/schemas/TemplateKind' + labelAssociations: + items: + $ref: '#/components/schemas/TemplateSummaryLabel' + type: array + templateMetaName: + type: string + type: object + type: array + dashboards: + items: + properties: + charts: + items: + $ref: '#/components/schemas/TemplateChart' + type: array + description: + type: string + envReferences: + $ref: '#/components/schemas/TemplateEnvReferences' + id: + type: string + kind: + $ref: '#/components/schemas/TemplateKind' + labelAssociations: + items: + $ref: '#/components/schemas/TemplateSummaryLabel' + type: array + name: + type: string + orgID: + type: string + templateMetaName: + type: string + type: object + type: array + labelMappings: + items: + properties: + labelID: + type: string + labelName: + type: string + labelTemplateMetaName: + type: string + resourceID: + type: string + resourceName: + type: string + resourceTemplateMetaName: + type: string + resourceType: + type: string + status: + type: string + type: object + type: array + labels: + items: + $ref: '#/components/schemas/TemplateSummaryLabel' + type: array + missingEnvRefs: + items: + type: string + type: array + missingSecrets: + items: + type: string + type: array + notificationEndpoints: + items: + allOf: + - $ref: '#/components/schemas/NotificationEndpointDiscriminator' + - properties: + envReferences: + $ref: '#/components/schemas/TemplateEnvReferences' + kind: + $ref: '#/components/schemas/TemplateKind' + labelAssociations: + items: + $ref: '#/components/schemas/TemplateSummaryLabel' + type: array + templateMetaName: + type: string + type: object + type: array + notificationRules: + items: + properties: + description: + type: string + endpointID: + type: string + endpointTemplateMetaName: + type: string + endpointType: + type: string + envReferences: + $ref: '#/components/schemas/TemplateEnvReferences' + every: + type: string + kind: + $ref: '#/components/schemas/TemplateKind' + labelAssociations: + items: + $ref: '#/components/schemas/TemplateSummaryLabel' + type: array + messageTemplate: + type: string + name: + type: string + offset: + type: string + status: + type: string + statusRules: + items: + properties: + currentLevel: + type: string + previousLevel: + type: string + type: object + type: array + tagRules: + items: + properties: + key: + type: string + operator: + type: string + value: + type: string + type: object + type: array + templateMetaName: + type: string + type: object + type: array + tasks: + items: + properties: + cron: + type: string + description: + type: string + envReferences: + $ref: '#/components/schemas/TemplateEnvReferences' + every: + type: string + id: + type: string + kind: + $ref: '#/components/schemas/TemplateKind' + name: + type: string + offset: + type: string + query: + type: string + status: + type: string + templateMetaName: + type: string + type: object + type: array + telegrafConfigs: + items: + allOf: + - $ref: '#/components/schemas/TelegrafRequest' + - properties: + envReferences: + $ref: '#/components/schemas/TemplateEnvReferences' + kind: + $ref: '#/components/schemas/TemplateKind' + labelAssociations: + items: + $ref: '#/components/schemas/TemplateSummaryLabel' + type: array + templateMetaName: + type: string + type: object + type: array + variables: + items: + properties: + arguments: + $ref: '#/components/schemas/VariableProperties' + description: + type: string + envReferences: + $ref: '#/components/schemas/TemplateEnvReferences' + id: + type: string + kind: + $ref: '#/components/schemas/TemplateKind' + labelAssociations: + items: + $ref: '#/components/schemas/TemplateSummaryLabel' + type: array + name: + type: string + orgID: + type: string + templateMetaName: + type: string + type: object + type: array + type: object + type: object + TemplateSummaryLabel: + properties: + envReferences: + $ref: '#/components/schemas/TemplateEnvReferences' + id: + type: string + kind: + $ref: '#/components/schemas/TemplateKind' + name: + type: string + orgID: + type: string + properties: + properties: + color: + type: string + description: + type: string + type: object + templateMetaName: + type: string + type: object + TestStatement: + description: Declares a Flux test case + properties: + assignment: + $ref: '#/components/schemas/VariableAssignment' + type: + $ref: '#/components/schemas/NodeType' + type: object + Threshold: + discriminator: + mapping: + greater: '#/components/schemas/GreaterThreshold' + lesser: '#/components/schemas/LesserThreshold' + range: '#/components/schemas/RangeThreshold' + propertyName: type + oneOf: + - $ref: '#/components/schemas/GreaterThreshold' + - $ref: '#/components/schemas/LesserThreshold' + - $ref: '#/components/schemas/RangeThreshold' + ThresholdBase: + properties: + allValues: + description: If true, only alert if all values meet threshold. + type: boolean + level: + $ref: '#/components/schemas/CheckStatusLevel' + ThresholdCheck: + allOf: + - $ref: '#/components/schemas/CheckBase' + - properties: + every: + description: Check repetition interval. + type: string + offset: + description: Duration to delay after the schedule, before executing check. + type: string + statusMessageTemplate: + description: The template used to generate and write a status message. + type: string + tags: + description: List of tags to write to each status. + items: + properties: + key: + type: string + value: + type: string + type: object + type: array + thresholds: + items: + $ref: '#/components/schemas/Threshold' + type: array + type: + enum: + - threshold + type: string + required: + - type + type: object + Token: + properties: + token: + type: string + type: object + UnaryExpression: + description: Uses operators to act on a single operand in an expression + properties: + argument: + $ref: '#/components/schemas/Expression' + operator: + type: string + type: + $ref: '#/components/schemas/NodeType' + type: object + UnsignedIntegerLiteral: + description: Represents integer numbers + properties: + type: + $ref: '#/components/schemas/NodeType' + value: + type: string + type: object + User: + properties: + id: + readOnly: true + type: string + name: + type: string + org_id: + type: string + role: + enum: + - owner + - member + type: string + status: + default: active + description: If inactive the user is inactive. + enum: + - active + - inactive + type: string + required: + - name + UserResponse: + properties: + id: + description: | + The user ID. + readOnly: true + type: string + links: + example: + self: /api/v2/users/1 + properties: + self: + format: uri + type: string + readOnly: true + type: object + name: + description: | + The user name. + type: string + status: + default: active + description: | + The status of a user. + An inactive user can't read or write resources. + enum: + - active + - inactive + type: string + required: + - name + Users: + properties: + links: + properties: + self: + format: uri + type: string + type: object + users: + items: + $ref: '#/components/schemas/UserResponse' + type: array + type: object + Variable: + properties: + arguments: + $ref: '#/components/schemas/VariableProperties' + createdAt: + format: date-time + type: string + description: + type: string + id: + readOnly: true + type: string + labels: + $ref: '#/components/schemas/Labels' + links: + properties: + labels: + format: uri + type: string + org: + format: uri + type: string + self: + format: uri + type: string + readOnly: true + type: object + name: + type: string + orgID: + type: string + selected: + items: + type: string + type: array + sort_order: + type: integer + updatedAt: + format: date-time + type: string + required: + - name + - orgID + - arguments + type: object + VariableAssignment: + description: Represents the declaration of a variable + properties: + id: + $ref: '#/components/schemas/Identifier' + init: + $ref: '#/components/schemas/Expression' + type: + $ref: '#/components/schemas/NodeType' + type: object + VariableProperties: + oneOf: + - $ref: '#/components/schemas/QueryVariableProperties' + - $ref: '#/components/schemas/ConstantVariableProperties' + - $ref: '#/components/schemas/MapVariableProperties' + type: object + Variables: + example: + variables: + - arguments: + type: constant + values: + - howdy + - hello + - hi + - yo + - oy + id: '1221432' + name: ':ok:' + selected: + - hello + - arguments: + type: map + values: + a: fdjaklfdjkldsfjlkjdsa + b: dfaksjfkljekfajekdljfas + c: fdjksajfdkfeawfeea + id: '1221432' + name: ':ok:' + selected: + - c + - arguments: + language: flux + query: 'from(bucket: "foo") |> showMeasurements()' + type: query + id: '1221432' + name: ':ok:' + selected: + - host + properties: + variables: + items: + $ref: '#/components/schemas/Variable' + type: array + type: object + View: + properties: + id: + readOnly: true + type: string + links: + properties: + self: + type: string + readOnly: true + type: object + name: + type: string + properties: + $ref: '#/components/schemas/ViewProperties' + required: + - name + - properties + ViewProperties: + oneOf: + - $ref: '#/components/schemas/LinePlusSingleStatProperties' + - $ref: '#/components/schemas/XYViewProperties' + - $ref: '#/components/schemas/SingleStatViewProperties' + - $ref: '#/components/schemas/HistogramViewProperties' + - $ref: '#/components/schemas/GaugeViewProperties' + - $ref: '#/components/schemas/TableViewProperties' + - $ref: '#/components/schemas/SimpleTableViewProperties' + - $ref: '#/components/schemas/MarkdownViewProperties' + - $ref: '#/components/schemas/CheckViewProperties' + - $ref: '#/components/schemas/ScatterViewProperties' + - $ref: '#/components/schemas/HeatmapViewProperties' + - $ref: '#/components/schemas/MosaicViewProperties' + - $ref: '#/components/schemas/BandViewProperties' + - $ref: '#/components/schemas/GeoViewProperties' + Views: + properties: + links: + properties: + self: + type: string + type: object + views: + items: + $ref: '#/components/schemas/View' + type: array + type: object + WritePrecision: + enum: + - ms + - s + - us + - ns + type: string + XYGeom: + enum: + - line + - step + - stacked + - bar + - monotoneX + - stepBefore + - stepAfter + type: string + XYViewProperties: + properties: + adaptiveZoomHide: + type: boolean + axes: + $ref: '#/components/schemas/Axes' + colorMapping: + $ref: '#/components/schemas/ColorMapping' + description: An object that contains information about the color mapping + colors: + description: Colors define color encoding of data into a visualization + items: + $ref: '#/components/schemas/DashboardColor' + type: array + generateXAxisTicks: + items: + type: string + type: array + generateYAxisTicks: + items: + type: string + type: array + geom: + $ref: '#/components/schemas/XYGeom' + hoverDimension: + enum: + - auto + - x + - 'y' + - xy + type: string + legendColorizeRows: + type: boolean + legendHide: + type: boolean + legendOpacity: + format: float + type: number + legendOrientationThreshold: + type: integer + note: + type: string + position: + enum: + - overlaid + - stacked + type: string + queries: + items: + $ref: '#/components/schemas/DashboardQuery' + type: array + shadeBelow: + type: boolean + shape: + enum: + - chronograf-v2 + type: string + showNoteWhenEmpty: + description: If true, will display note when empty + type: boolean + staticLegend: + $ref: '#/components/schemas/StaticLegend' + timeFormat: + type: string + type: + enum: + - xy + type: string + xColumn: + type: string + xTickStart: + format: float + type: number + xTickStep: + format: float + type: number + xTotalTicks: + type: integer + yColumn: + type: string + yTickStart: + format: float + type: number + yTickStep: + format: float + type: number + yTotalTicks: + type: integer + required: + - type + - geom + - queries + - shape + - axes + - colors + - note + - showNoteWhenEmpty + - position + type: object + securitySchemes: + BasicAuthentication: + description: | + ### Basic authentication scheme + + Use the HTTP Basic authentication scheme for InfluxDB `/api/v2` API operations that support it: + + ### Syntax + + `Authorization: Basic BASE64_ENCODED_CREDENTIALS` + + To construct the `BASE64_ENCODED_CREDENTIALS`, combine the username and + the password with a colon (`USERNAME:PASSWORD`), and then encode the + resulting string in [base64](https://developer.mozilla.org/en-US/docs/Glossary/Base64). + Many HTTP clients encode the credentials for you before sending the + request. + + _**Warning**: Base64-encoding can easily be reversed to obtain the original + username and password. It is used to keep the data intact and does not provide + security. You should always use HTTPS when authenticating or sending a request with + sensitive information._ + + ### Examples + + In the examples, replace the following: + + - **`EMAIL_ADDRESS`**: InfluxDB Cloud username (the email address the user signed up with) + - **`PASSWORD`**: InfluxDB Cloud [API token](/influxdb/cloud-serverless/reference/glossary/#token) + - **`INFLUX_URL`**: your InfluxDB Cloud URL + + #### Encode credentials with cURL + + The following example shows how to use cURL to send an API request that uses Basic authentication. + With the `--user` option, cURL encodes the credentials and passes them + in the `Authorization: Basic` header. + + ```sh + curl --get "INFLUX_URL/api/v2/signin" + --user "EMAIL_ADDRESS":"PASSWORD" + ``` + + #### Encode credentials with Flux + + The Flux [`http.basicAuth()` function](https://docs.influxdata.com/flux/v0.x/stdlib/http/basicauth/) returns a Base64-encoded + basic authentication header using a specified username and password combination. + + #### Encode credentials with JavaScript + + The following example shows how to use the JavaScript `btoa()` function + to create a Base64-encoded string: + + ```js + btoa('EMAIL_ADDRESS:PASSWORD') + ``` + + The output is the following: + + ```js + 'VVNFUk5BTUU6UEFTU1dPUkQ=' + ``` + + Once you have the Base64-encoded credentials, you can pass them in the + `Authorization` header--for example: + + ```sh + curl --get "INFLUX_URL/api/v2/signin" + --header "Authorization: Basic VVNFUk5BTUU6UEFTU1dPUkQ=" + ``` + + To learn more about HTTP authentication, see + [Mozilla Developer Network (MDN) Web Docs, HTTP authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication)._ + scheme: basic + type: http + TokenAuthentication: + description: | + Use the [Token authentication](#section/Authentication/TokenAuthentication) + scheme to authenticate to the InfluxDB API. + + In your API requests, send an `Authorization` header. + For the header value, provide the word `Token` followed by a space and an InfluxDB API token. + The word `Token` is case-sensitive. + + ### Syntax + + `Authorization: Token INFLUX_API_TOKEN` + + ### Example + + #### Use Token authentication with cURL + + The following example shows how to use cURL to send an API request that uses Token authentication: + + ```sh + curl --request GET "INFLUX_URL/api/v2/buckets" \ + --header "Authorization: Token INFLUX_API_TOKEN" + ``` + + Replace the following: + + - *`INFLUX_URL`*: your InfluxDB Cloud URL + - *`INFLUX_API_TOKEN`*: your [InfluxDB API token](/influxdb/cloud-serverless/reference/glossary/#token) + + ### Related endpoints + + - [`/authorizations` endpoints](#tag/Authorizations-(API-tokens)) + + ### Related guides + + - [Authorize API requests](/influxdb/cloud-serverless/api-guide/api_intro/#authentication) + - [Manage API tokens](/influxdb/cloud-serverless/security/tokens/) + in: header + name: Authorization + type: apiKey +x-tagGroups: + - name: Using the InfluxDB HTTP API + tags: + - Quick start + - Authentication + - Supported operations + - Headers + - Pagination + - Response codes + - Data I/O endpoints + - Security and access endpoints + - System information endpoints + - name: All endpoints + tags: + - Authorizations (API tokens) + - Bucket Schemas + - Buckets + - Delete + - DBRPs + - Invokable Scripts + - Limits + - Organizations + - Query + - Resources + - Routes + - Secrets + - Tasks + - Telegrafs + - Templates + - Usage + - Variables + - Write diff --git a/api-docs/influxdb/cloud/v1-compatibility/content/info.yml b/api-docs/influxdb/cloud/v1-compatibility/content/info.yml index 07ae7e9e7..60e607a79 100644 --- a/api-docs/influxdb/cloud/v1-compatibility/content/info.yml +++ b/api-docs/influxdb/cloud/v1-compatibility/content/info.yml @@ -1,11 +1,16 @@ -title: InfluxDB v1 HTTP API for InfluxDB Cloud +title: InfluxDB v1 HTTP API for InfluxDB Cloud (TSM) x-influxdata-short-title: v1 Compatibility API -summary: The InfluxDB v1 compatibility API provides a programmatic interface for interactions with InfluxDB Cloud using InfluxDB v1-compatible endpoints. description: | - The InfluxDB 1.x compatibility /write and /query endpoints work with InfluxDB 1.x client libraries and third-party integrations like Grafana and others. + The v1-compatibility HTTP API provides compatibility for writing and querying data in an InfluxDB v2 bucket using InfluxDB v1 endpoints. + + The `/write` and `/query` endpoints support InfluxDB 1.x client libraries and third-party integrations such as Grafana. This documentation is generated from the [InfluxDB OpenAPI specification](https://raw.githubusercontent.com/influxdata/openapi/master/contracts/swaggerV1Compat.yml). license: name: MIT url: 'https://opensource.org/licenses/MIT' +contact: + name: InfluxData + url: https://www.influxdata.com + email: support@influxdata.com diff --git a/api-docs/influxdb/cloud/v1-compatibility/swaggerV1Compat.yml b/api-docs/influxdb/cloud/v1-compatibility/swaggerV1Compat.yml index 56853fefa..eff69ff75 100644 --- a/api-docs/influxdb/cloud/v1-compatibility/swaggerV1Compat.yml +++ b/api-docs/influxdb/cloud/v1-compatibility/swaggerV1Compat.yml @@ -1,16 +1,21 @@ openapi: 3.0.0 info: - title: InfluxDB v1 HTTP API for InfluxDB Cloud + title: InfluxDB v1 HTTP API for InfluxDB Cloud (TSM) version: '' description: | - The InfluxDB 1.x compatibility /write and /query endpoints work with InfluxDB 1.x client libraries and third-party integrations like Grafana and others. + The v1-compatibility HTTP API provides compatibility for writing and querying data in an InfluxDB v2 bucket using InfluxDB v1 endpoints. + + The `/write` and `/query` endpoints support InfluxDB 1.x client libraries and third-party integrations such as Grafana. This documentation is generated from the [InfluxDB OpenAPI specification](https://raw.githubusercontent.com/influxdata/openapi/master/contracts/swaggerV1Compat.yml). license: name: MIT url: https://opensource.org/licenses/MIT - summary: The InfluxDB v1 compatibility API provides a programmatic interface for interactions with InfluxDB Cloud using InfluxDB v1-compatible endpoints. + contact: + name: InfluxData + url: https://www.influxdata.com + email: support@influxdata.com servers: - url: / security: @@ -276,9 +281,9 @@ components: properties: results: description: | - A resultset object that contains the `statement_id` and the `series` array. + A resultset object that contains the `statement_id` and the `series` array. - Except for `statement_id`, all properties are optional and omitted if empty. If a property is not present, it is assumed to be `null`. + Except for `statement_id`, all properties are optional and omitted if empty. If a property is not present, it is assumed to be `null`. items: properties: error: @@ -327,12 +332,12 @@ components: type: integer type: object oneOf: - - required: - - statement_id - - error - - required: - - statement_id - - series + - required: + - statement_id + - error + - required: + - statement_id + - series type: array type: object InfluxQLCSVResponse: diff --git a/api-docs/influxdb/cloud/v2/content/info.yml b/api-docs/influxdb/cloud/v2/content/info.yml index 0504afa39..ff0de618c 100644 --- a/api-docs/influxdb/cloud/v2/content/info.yml +++ b/api-docs/influxdb/cloud/v2/content/info.yml @@ -1,8 +1,8 @@ title: InfluxDB Cloud API Service x-influxdata-short-title: v2 API -summary: The InfluxDB v2 HTTP API provides a programmatic interface for all interactions with InfluxDB v2. description: | - The InfluxDB v2 HTTP API provides a programmatic interface for all interactions with InfluxDB v2. Access the InfluxDB API using `/api/v2/` and InfluxDB v1-compatible endpoints. + The InfluxDB v2 HTTP API provides a programmatic interface for all interactions with InfluxDB v2. + Access the InfluxDB API using `/api/v2/` and InfluxDB v1-compatible endpoints. This documentation is generated from the [InfluxDB OpenAPI specification](https://raw.githubusercontent.com/influxdata/openapi/master/contracts/ref/cloud.yml). @@ -10,3 +10,7 @@ version: 2.x license: name: MIT url: 'https://opensource.org/licenses/MIT' +contact: + name: InfluxData + url: https://www.influxdata.com + email: support@influxdata.com \ No newline at end of file diff --git a/api-docs/influxdb/cloud/v2/ref.yml b/api-docs/influxdb/cloud/v2/ref.yml index df84bf180..e4dfa73f3 100644 --- a/api-docs/influxdb/cloud/v2/ref.yml +++ b/api-docs/influxdb/cloud/v2/ref.yml @@ -3,14 +3,18 @@ info: title: InfluxDB Cloud API Service version: 2.x description: | - The InfluxDB v2 HTTP API provides a programmatic interface for all interactions with InfluxDB v2. Access the InfluxDB API using `/api/v2/` and InfluxDB v1-compatible endpoints. + The InfluxDB v2 HTTP API provides a programmatic interface for all interactions with InfluxDB v2. + Access the InfluxDB API using `/api/v2/` and InfluxDB v1-compatible endpoints. This documentation is generated from the [InfluxDB OpenAPI specification](https://raw.githubusercontent.com/influxdata/openapi/master/contracts/ref/cloud.yml). license: name: MIT url: https://opensource.org/licenses/MIT - summary: The InfluxDB v2 HTTP API provides a programmatic interface for all interactions with InfluxDB v2. + contact: + name: InfluxData + url: https://www.influxdata.com + email: support@influxdata.com servers: - url: https://{baseurl} description: InfluxDB Cloud API URL @@ -14600,9 +14604,9 @@ components: properties: results: description: | - A resultset object that contains the `statement_id` and the `series` array. + A resultset object that contains the `statement_id` and the `series` array. - Except for `statement_id`, all properties are optional and omitted if empty. If a property is not present, it is assumed to be `null`. + Except for `statement_id`, all properties are optional and omitted if empty. If a property is not present, it is assumed to be `null`. items: properties: error: @@ -14651,12 +14655,12 @@ components: type: integer type: object oneOf: - - required: - - statement_id - - error - - required: - - statement_id - - series + - required: + - statement_id + - error + - required: + - statement_id + - series type: array type: object IntegerLiteral: diff --git a/api-docs/influxdb/v2/content/info.yml b/api-docs/influxdb/v2/content/info.yml index 4a75f7efa..d5527ec62 100644 --- a/api-docs/influxdb/v2/content/info.yml +++ b/api-docs/influxdb/v2/content/info.yml @@ -10,3 +10,7 @@ version: 2.x license: name: MIT url: 'https://opensource.org/licenses/MIT' +contact: + name: InfluxData + url: https://www.influxdata.com + email: support@influxdata.com \ No newline at end of file diff --git a/api-docs/influxdb/v2/v1-compatibility/content/info.yml b/api-docs/influxdb/v2/v1-compatibility/content/info.yml index f897815d3..f58bd21f1 100644 --- a/api-docs/influxdb/v2/v1-compatibility/content/info.yml +++ b/api-docs/influxdb/v2/v1-compatibility/content/info.yml @@ -1,12 +1,15 @@ title: InfluxDB v1 HTTP API for InfluxDB v2 OSS x-influxdata-short-title: v1 Compatibility API -summary: The InfluxDB v1 compatibility API provides a programmatic interface for interactions with InfluxDB v2 using InfluxDB v1-compatible endpoints. description: | + The v1-compatibility HTTP API provides compatibility for writing and querying data in an InfluxDB v2 bucket using InfluxDB v1 endpoints. The InfluxDB 1.x compatibility `/write` and `/query` endpoints work with InfluxDB 1.x client libraries and third-party integrations like Grafana and others. This documentation is generated from the [InfluxDB OpenAPI specification](https://raw.githubusercontent.com/influxdata/openapi/master/contracts/swaggerV1Compat.yml). - license: name: MIT url: 'https://opensource.org/licenses/MIT' +contact: + name: InfluxData + url: https://www.influxdata.com + email: support@influxdata.com \ No newline at end of file diff --git a/api-docs/influxdb/v2/v1-compatibility/swaggerV1Compat.yml b/api-docs/influxdb/v2/v1-compatibility/swaggerV1Compat.yml index b008e0315..9e6fab1a7 100644 --- a/api-docs/influxdb/v2/v1-compatibility/swaggerV1Compat.yml +++ b/api-docs/influxdb/v2/v1-compatibility/swaggerV1Compat.yml @@ -3,14 +3,18 @@ info: title: InfluxDB v1 HTTP API for InfluxDB v2 OSS version: '' description: | - The InfluxDB 1.x compatibility /write and /query endpoints work with InfluxDB 1.x client libraries and third-party integrations like Grafana and others. + The v1-compatibility HTTP API provides compatibility for writing and querying data in an InfluxDB v2 bucket using InfluxDB v1 endpoints. + The InfluxDB 1.x compatibility `/write` and `/query` endpoints work with InfluxDB 1.x client libraries and third-party integrations like Grafana and others. This documentation is generated from the [InfluxDB OpenAPI specification](https://raw.githubusercontent.com/influxdata/openapi/master/contracts/swaggerV1Compat.yml). license: name: MIT url: https://opensource.org/licenses/MIT - summary: The InfluxDB v1 compatibility API provides a programmatic interface for interactions with InfluxDB v2 using InfluxDB v1-compatible endpoints. + contact: + name: InfluxData + url: https://www.influxdata.com + email: support@influxdata.com servers: - url: / security: @@ -276,9 +280,9 @@ components: properties: results: description: | - A resultset object that contains the `statement_id` and the `series` array. + A resultset object that contains the `statement_id` and the `series` array. - Except for `statement_id`, all properties are optional and omitted if empty. If a property is not present, it is assumed to be `null`. + Except for `statement_id`, all properties are optional and omitted if empty. If a property is not present, it is assumed to be `null`. items: properties: error: @@ -327,12 +331,12 @@ components: type: integer type: object oneOf: - - required: - - statement_id - - error - - required: - - statement_id - - series + - required: + - statement_id + - error + - required: + - statement_id + - series type: array type: object InfluxQLCSVResponse: diff --git a/api-docs/influxdb3/cloud-dedicated/management/content/info.yml b/api-docs/influxdb3/cloud-dedicated/management/content/info.yml index 5b533dd20..32171c2b7 100644 --- a/api-docs/influxdb3/cloud-dedicated/management/content/info.yml +++ b/api-docs/influxdb3/cloud-dedicated/management/content/info.yml @@ -1,12 +1,15 @@ title: InfluxDB 3 Cloud Dedicated Management API x-influxdata-short-title: Management API -summary: | - The Management API for InfluxDB 3 Cloud Dedicated provides a programmatic interface for managing a Cloud Dedicated instance. description: | - The Management API lets you manage an InfluxDB 3 Cloud Dedicated instance and integrate functions such as creating and managing databases, permissions, and tokens into your workflow or application. + The Management API for InfluxDB 3 Cloud Dedicated provides a programmatic interface for managing a Cloud Dedicated instance. + The Management API lets you integrate functions such as creating and managing databases, permissions, and tokens into your workflow or application. This documentation is generated from the InfluxDB OpenAPI specification. license: name: MIT url: 'https://opensource.org/licenses/MIT' +contact: + name: InfluxData + url: https://www.influxdata.com + email: support@influxdata.com \ No newline at end of file diff --git a/api-docs/influxdb3/cloud-dedicated/management/openapi.yml b/api-docs/influxdb3/cloud-dedicated/management/openapi.yml index edadccd7f..d18885231 100644 --- a/api-docs/influxdb3/cloud-dedicated/management/openapi.yml +++ b/api-docs/influxdb3/cloud-dedicated/management/openapi.yml @@ -2,16 +2,19 @@ openapi: 3.1.0 info: title: InfluxDB 3 Cloud Dedicated Management API description: | - The Management API lets you manage an InfluxDB 3 Cloud Dedicated instance and integrate functions such as creating and managing databases, permissions, and tokens into your workflow or application. + The Management API for InfluxDB 3 Cloud Dedicated provides a programmatic interface for managing a Cloud Dedicated instance. + The Management API lets you integrate functions such as creating and managing databases, permissions, and tokens into your workflow or application. This documentation is generated from the InfluxDB OpenAPI specification. - summary: | - The Management API for InfluxDB 3 Cloud Dedicated provides a programmatic interface for managing a Cloud Dedicated instance. license: name: MIT url: https://opensource.org/licenses/MIT version: '' + contact: + name: InfluxData + url: https://www.influxdata.com + email: support@influxdata.com servers: - url: https://{baseurl}/api/v0 description: InfluxDB 3 Cloud Dedicated Management API URL @@ -37,8 +40,6 @@ tags: See how to [create a management token](/influxdb3/cloud-dedicated/admin/tokens/management/). By default, management tokens in InfluxDB 3 are short-lived tokens issued by an OAuth2 identity provider that grant a specific user administrative access to your InfluxDB cluster. However, for automation purposes, you can manually create management tokens that authenticate directly with your InfluxDB cluster and do not require human interaction with your identity provider. - - - name: Database tokens description: Manage database read/write tokens for a cluster - name: Databases @@ -1020,7 +1021,6 @@ paths: For example, see how to [authenticate Telegraf using tokens in your OS secret store](https://github.com/influxdata/telegraf/tree/master/plugins/secretstores/os). If you lose a token, [delete the token from InfluxDB](/influxdb3/cloud-dedicated/admin/tokens/database/delete/) and create a new one. - parameters: - name: accountId in: path diff --git a/api-docs/influxdb3/cloud-dedicated/v1-compatibility/content/info.yml b/api-docs/influxdb3/cloud-dedicated/v1-compatibility/content/info.yml index 5a162fa57..cd9f852f8 100644 --- a/api-docs/influxdb3/cloud-dedicated/v1-compatibility/content/info.yml +++ b/api-docs/influxdb3/cloud-dedicated/v1-compatibility/content/info.yml @@ -1,7 +1,7 @@ title: InfluxDB v1 HTTP API for InfluxDB 3 Cloud Dedicated x-influxdata-short-title: v1 Compatibility API -summary: The InfluxDB v1 HTTP API provides v1 compatibility for writing and querying data in an InfluxDB 3 Cloud Dedicated database. description: | + The v1-compatibility HTTP API provides compatibility for writing and querying data in an InfluxDB 3 Cloud Dedicated database using InfluxDB v1 endpoints. The InfluxDB 1.x `/write` and `/query` endpoints work with InfluxDB 1.x client libraries and third-party integrations like Grafana and others. This documentation is generated from the @@ -13,3 +13,7 @@ description: | license: name: MIT url: 'https://opensource.org/licenses/MIT' +contact: + name: InfluxData + url: https://www.influxdata.com + email: support@influxdata.com diff --git a/api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml b/api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml index 46de3a497..6ae70ec6e 100644 --- a/api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml +++ b/api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml @@ -3,6 +3,7 @@ info: title: InfluxDB v1 HTTP API for InfluxDB 3 Cloud Dedicated version: '' description: | + The v1-compatibility HTTP API provides compatibility for writing and querying data in an InfluxDB 3 Cloud Dedicated database using InfluxDB v1 endpoints. The InfluxDB 1.x `/write` and `/query` endpoints work with InfluxDB 1.x client libraries and third-party integrations like Grafana and others. This documentation is generated from the @@ -14,7 +15,10 @@ info: license: name: MIT url: https://opensource.org/licenses/MIT - summary: The InfluxDB v1 HTTP API provides v1 compatibility for writing and querying data in an InfluxDB 3 Cloud Dedicated database. + contact: + name: InfluxData + url: https://www.influxdata.com + email: support@influxdata.com servers: - url: / security: @@ -35,6 +39,7 @@ tags: x-traitTag: true + - name: Ping - name: Query - name: Write paths: @@ -244,7 +249,7 @@ paths: get: description: | Reports the InfluxQL bridge querier health and the InfluxDB version of the instance. - + The response is a HTTP `204` status code to inform you the querier is available. For InfluxDB 3 Cloud Dedicated, this endpoint only checks the status of queriers; doesn't check the status of ingesters. @@ -282,7 +287,7 @@ paths: head: description: | Reports the InfluxQL bridge querier health and the InfluxDB version of the instance. - + The response is a HTTP `204` status code to inform you the querier is available. For InfluxDB 3 Cloud Dedicated, this endpoint only checks the status of queriers; doesn't check the status of ingesters. @@ -290,7 +295,6 @@ paths: To check the health of ingesters before writing data, send a request to one of the [write endpoints](/influxdb3/cloud-dedicated/api/v2/#tag/Write). This endpoint doesn't require authentication. - operationId: HeadPing responses: '204': @@ -357,9 +361,9 @@ components: properties: results: description: | - A resultset object that contains the `statement_id` and the `series` array. + A resultset object that contains the `statement_id` and the `series` array. - Except for `statement_id`, all properties are optional and omitted if empty. If a property is not present, it is assumed to be `null`. + Except for `statement_id`, all properties are optional and omitted if empty. If a property is not present, it is assumed to be `null`. items: properties: error: @@ -408,12 +412,12 @@ components: type: integer type: object oneOf: - - required: - - statement_id - - error - - required: - - statement_id - - series + - required: + - statement_id + - error + - required: + - statement_id + - series type: array type: object InfluxQLCSVResponse: diff --git a/api-docs/influxdb3/cloud-dedicated/v2/content/info.yml b/api-docs/influxdb3/cloud-dedicated/v2/content/info.yml index e8b72ba41..4fd037931 100644 --- a/api-docs/influxdb3/cloud-dedicated/v2/content/info.yml +++ b/api-docs/influxdb3/cloud-dedicated/v2/content/info.yml @@ -1,12 +1,16 @@ title: InfluxDB v2 HTTP API for InfluxDB 3 Cloud Dedicated x-influxdata-short-title: v2 API -summary: The InfluxDB v2 HTTP API for InfluxDB 3 Cloud Dedicated provides a v2-compatible programmatic interface for writing data stored in an InfluxDB 3 Cloud Dedicated database. - description: | - The InfluxDB v2 HTTP API lets you use `/api/v2` endpoints for managing retention policy mappings and writing data stored in an InfluxDB 3 instance. + The InfluxDB v2 HTTP API provides a v2-compatible programmatic interface for writing and managing data stored in an InfluxDB 3 Cloud Dedicated database. + + Use the InfluxDB v2 HTTP API `/api/v2` endpoints to manage retention policy mappings and write data to an InfluxDB 3 instance. This documentation is generated from the [InfluxDB OpenAPI specification](https://raw.githubusercontent.com/influxdata/openapi/master/contracts/ref/cloud.yml). license: name: MIT url: 'https://opensource.org/licenses/MIT' +contact: + name: InfluxData + url: https://www.influxdata.com + email: support@influxdata.com \ No newline at end of file diff --git a/api-docs/influxdb3/cloud-dedicated/v2/ref.yml b/api-docs/influxdb3/cloud-dedicated/v2/ref.yml index eec0b7d3a..8a3d80f15 100644 --- a/api-docs/influxdb3/cloud-dedicated/v2/ref.yml +++ b/api-docs/influxdb3/cloud-dedicated/v2/ref.yml @@ -2,6 +2,8 @@ openapi: 3.0.0 info: title: InfluxDB v2 HTTP API for InfluxDB 3 Cloud Dedicated description: | + The InfluxDB v2 HTTP API provides a v2-compatible programmatic interface for writing data stored in an InfluxDB 3 Cloud Dedicated database. + The InfluxDB v2 HTTP API lets you use `/api/v2` endpoints for managing retention policy mappings and writing data stored in an InfluxDB 3 instance. This documentation is generated from the @@ -9,8 +11,11 @@ info: license: name: MIT url: https://opensource.org/licenses/MIT - summary: The InfluxDB v2 HTTP API for InfluxDB 3 Cloud Dedicated provides a v2-compatible programmatic interface for writing data stored in an InfluxDB 3 Cloud Dedicated database. version: '' + contact: + name: InfluxData + url: https://www.influxdata.com + email: support@influxdata.com servers: - url: https://{baseurl} description: InfluxDB 3 Cloud Dedicated API URL @@ -150,7 +155,7 @@ paths: get: description: | Reports the InfluxQL bridge querier health and the InfluxDB version of the instance. - + The response is a HTTP `204` status code to inform you the querier is available. For InfluxDB 3 Cloud Dedicated, this endpoint only checks the status of queriers; doesn't check the status of ingesters. @@ -188,7 +193,7 @@ paths: head: description: | Reports the InfluxQL bridge querier health and the InfluxDB version of the instance. - + The response is a HTTP `204` status code to inform you the querier is available. For InfluxDB 3 Cloud Dedicated, this endpoint only checks the status of queriers; doesn't check the status of ingesters. @@ -1243,9 +1248,9 @@ components: properties: results: description: | - A resultset object that contains the `statement_id` and the `series` array. + A resultset object that contains the `statement_id` and the `series` array. - Except for `statement_id`, all properties are optional and omitted if empty. If a property is not present, it is assumed to be `null`. + Except for `statement_id`, all properties are optional and omitted if empty. If a property is not present, it is assumed to be `null`. items: properties: error: @@ -1294,12 +1299,12 @@ components: type: integer type: object oneOf: - - required: - - statement_id - - error - - required: - - statement_id - - series + - required: + - statement_id + - error + - required: + - statement_id + - series type: array type: object IntegerLiteral: diff --git a/api-docs/influxdb3/cloud-serverless/v1-compatibility/content/info.yml b/api-docs/influxdb3/cloud-serverless/v1-compatibility/content/info.yml index 1e2d82d4c..f2ca028fa 100644 --- a/api-docs/influxdb3/cloud-serverless/v1-compatibility/content/info.yml +++ b/api-docs/influxdb3/cloud-serverless/v1-compatibility/content/info.yml @@ -13,3 +13,7 @@ description: | license: name: MIT url: 'https://opensource.org/licenses/MIT' +contact: + name: InfluxData + url: https://www.influxdata.com + email: support@influxdata.com \ No newline at end of file diff --git a/api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml b/api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml index 12332cb35..cd656e8e0 100644 --- a/api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml +++ b/api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml @@ -15,6 +15,10 @@ info: name: MIT url: https://opensource.org/licenses/MIT summary: The InfluxDB v1 HTTP API provides v1 compatibility for writing and querying data in an InfluxDB 3 Cloud Serverless bucket. + contact: + name: InfluxData + url: https://www.influxdata.com + email: support@influxdata.com servers: - url: / security: @@ -280,9 +284,9 @@ components: properties: results: description: | - A resultset object that contains the `statement_id` and the `series` array. + A resultset object that contains the `statement_id` and the `series` array. - Except for `statement_id`, all properties are optional and omitted if empty. If a property is not present, it is assumed to be `null`. + Except for `statement_id`, all properties are optional and omitted if empty. If a property is not present, it is assumed to be `null`. items: properties: error: @@ -331,12 +335,12 @@ components: type: integer type: object oneOf: - - required: - - statement_id - - error - - required: - - statement_id - - series + - required: + - statement_id + - error + - required: + - statement_id + - series type: array type: object InfluxQLCSVResponse: diff --git a/api-docs/influxdb3/cloud-serverless/v2/content/info.yml b/api-docs/influxdb3/cloud-serverless/v2/content/info.yml index f175cf3c7..58010adcf 100644 --- a/api-docs/influxdb3/cloud-serverless/v2/content/info.yml +++ b/api-docs/influxdb3/cloud-serverless/v2/content/info.yml @@ -10,3 +10,7 @@ description: | license: name: MIT url: 'https://opensource.org/licenses/MIT' +contact: + name: InfluxData + url: https://www.influxdata.com + email: support@influxdata.com \ No newline at end of file diff --git a/api-docs/influxdb3/cloud-serverless/v2/ref.yml b/api-docs/influxdb3/cloud-serverless/v2/ref.yml index 78e7ff814..36a040b88 100644 --- a/api-docs/influxdb3/cloud-serverless/v2/ref.yml +++ b/api-docs/influxdb3/cloud-serverless/v2/ref.yml @@ -12,6 +12,10 @@ info: summary: | The InfluxDB v2 HTTP API for InfluxDB 3 Cloud Serverless provides a programmatic interface for writing data stored in an InfluxDB 3 Cloud Serverless bucket. version: '' + contact: + name: InfluxData + url: https://www.influxdata.com + email: support@influxdata.com servers: - url: https://{baseurl} description: InfluxDB 3 Cloud Serverless API URL diff --git a/api-docs/influxdb3/clustered/v1-compatibility/content/info.yml b/api-docs/influxdb3/clustered/v1-compatibility/content/info.yml index 80ab8c17f..657db1fa6 100644 --- a/api-docs/influxdb3/clustered/v1-compatibility/content/info.yml +++ b/api-docs/influxdb3/clustered/v1-compatibility/content/info.yml @@ -13,3 +13,7 @@ description: | license: name: MIT url: 'https://opensource.org/licenses/MIT' +contact: + name: InfluxData + url: https://www.influxdata.com + email: support@influxdata.com \ No newline at end of file diff --git a/api-docs/influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml b/api-docs/influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml index 7bfc57eda..1516ae8aa 100644 --- a/api-docs/influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml +++ b/api-docs/influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml @@ -15,6 +15,10 @@ info: name: MIT url: https://opensource.org/licenses/MIT summary: The InfluxDB v1 HTTP API provides v1 compatibility for writing and querying data in an InfluxDB 3 Clustered database. + contact: + name: InfluxData + url: https://www.influxdata.com + email: support@influxdata.com servers: - url: / security: @@ -280,9 +284,9 @@ components: properties: results: description: | - A resultset object that contains the `statement_id` and the `series` array. + A resultset object that contains the `statement_id` and the `series` array. - Except for `statement_id`, all properties are optional and omitted if empty. If a property is not present, it is assumed to be `null`. + Except for `statement_id`, all properties are optional and omitted if empty. If a property is not present, it is assumed to be `null`. items: properties: error: @@ -331,12 +335,12 @@ components: type: integer type: object oneOf: - - required: - - statement_id - - error - - required: - - statement_id - - series + - required: + - statement_id + - error + - required: + - statement_id + - series type: array type: object InfluxQLCSVResponse: diff --git a/api-docs/influxdb3/clustered/v2/content/info.yml b/api-docs/influxdb3/clustered/v2/content/info.yml index bc01b768f..e25f720df 100644 --- a/api-docs/influxdb3/clustered/v2/content/info.yml +++ b/api-docs/influxdb3/clustered/v2/content/info.yml @@ -9,3 +9,7 @@ description: | license: name: MIT url: 'https://opensource.org/licenses/MIT' +contact: + name: InfluxData + url: https://www.influxdata.com + email: support@influxdata.com \ No newline at end of file diff --git a/api-docs/influxdb3/clustered/v2/ref.yml b/api-docs/influxdb3/clustered/v2/ref.yml index 71245c9c2..0a73ad3ad 100644 --- a/api-docs/influxdb3/clustered/v2/ref.yml +++ b/api-docs/influxdb3/clustered/v2/ref.yml @@ -11,6 +11,10 @@ info: name: MIT url: https://opensource.org/licenses/MIT summary: The InfluxDB v2 HTTP API for InfluxDB 3 Clustered provides a v2-compatible programmatic interface for writing data stored in an InfluxDB 3 Clustered database. + contact: + name: InfluxData + url: https://www.influxdata.com + email: support@influxdata.com servers: - url: https://{baseurl} description: InfluxDB 3 Clustered API URL @@ -1235,9 +1239,9 @@ components: properties: results: description: | - A resultset object that contains the `statement_id` and the `series` array. + A resultset object that contains the `statement_id` and the `series` array. - Except for `statement_id`, all properties are optional and omitted if empty. If a property is not present, it is assumed to be `null`. + Except for `statement_id`, all properties are optional and omitted if empty. If a property is not present, it is assumed to be `null`. items: properties: error: @@ -1286,12 +1290,12 @@ components: type: integer type: object oneOf: - - required: - - statement_id - - error - - required: - - statement_id - - series + - required: + - statement_id + - error + - required: + - statement_id + - series type: array type: object IntegerLiteral: diff --git a/api-docs/influxdb3/core/v3/content/info.yml b/api-docs/influxdb3/core/v3/content/info.yml index 88b963d91..5fbeb9e20 100644 --- a/api-docs/influxdb3/core/v3/content/info.yml +++ b/api-docs/influxdb3/core/v3/content/info.yml @@ -1,18 +1,21 @@ title: InfluxDB 3 Core API Service x-influxdata-short-title: InfluxDB 3 API x-influxdata-version-matrix: - v1: Legacy compatibility layer - v2: Backward compatibility with InfluxDB 2.x - v3: Current native API + v1: Compatibility layer for InfluxDB 1.x clients (supported) + v2: Compatibility layer for InfluxDB 2.x clients (supported) + v3: Native API for InfluxDB 3.x (current) summary: The InfluxDB HTTP API for InfluxDB 3 Core provides a programmatic interface for writing data stored in an InfluxDB 3 Core database. description: | Write and query data, and perform administrative tasks, such as managing databases and processing engine plugins. - The InfluxDB HTTP API for InfluxDB 3 Core includes endpoints for compatibility with InfluxDB 2.x and InfluxDB 1.x APIs. + The InfluxDB HTTP API for InfluxDB 3 Core includes endpoints for the following: + - InfluxDB v1: Compatibility layer for InfluxDB 1.x clients (supported) + - `/api/v2`: Compatibility layer for InfluxDB 2.x clients (supported) + - `/api/v3`: Native API for InfluxDB 3.x (current) license: name: MIT diff --git a/api-docs/influxdb3/core/v3/ref.yml b/api-docs/influxdb3/core/v3/ref.yml index fc6ca423e..3e8bf82a4 100644 --- a/api-docs/influxdb3/core/v3/ref.yml +++ b/api-docs/influxdb3/core/v3/ref.yml @@ -18,19 +18,21 @@ tags: description: Create, read, update, and delete database and cache resources - name: Tables description: Manage table schemas and data - - name: Data Operations + - name: Data operations description: Write, query, and process data - - name: Legacy APIs - description: Backwards compatibility APIs for v1.x and v2.x clients + - name: Backward compatibility + description: Endpoints compatible with v1.x and v2.x clients + - name: Server information + description: Retrieve server metrics, status, and version information paths: /write: post: - operationId: PostLegacyV1Write + operationId: PostV1Write summary: Write line protocol (v1-compatible) description: > Writes line protocol to the specified database. - This is a legacy endpoint compatible with InfluxDB 2.x client libraries, the Telegraf `outputs.influxdb` output plugin, and third-party tools. + This endpoint provides backward compatibility for InfluxDB 1.x write workloads using tools such as InfluxDB 1.x client libraries, the Telegraf `outputs.influxdb` output plugin, or third-party tools. Use this endpoint to send data in [line protocol](https://docs.influxdata.com/influxdb3/core/reference/syntax/line-protocol/) format to InfluxDB. Use query parameters to specify options for writing data. @@ -40,28 +42,11 @@ paths: in: query required: true schema: - $ref: '#/components/schemas/LegacyWritePrecision' + $ref: '#/components/schemas/PrecisionWrite' description: Precision of timestamps. - - name: no_sync - in: query - required: false - schema: - type: boolean - default: false - description: Do not sync writes. - - $ref: '#/components/parameters/ContentType' + - $ref: '#/components/parameters/ContentTypeLineProtocol' requestBody: - required: true - content: - text/plain: - schema: - type: string - format: byte - examples: - plain-utf8-multiline: - value: | - measurement,tag=id001 field=1.0 1234567890 - measurement,tag=id001 field=1.1 1234567900 + $ref: '#/components/requestBodies/lineProtocolRequestBody' responses: "204": description: Success ("No Content"). All data in the batch is written and queryable. @@ -111,16 +96,16 @@ paths: security: - BearerAuth: [] tags: - - Legacy v1-compatible - - Write data + - Backward compatibility + - Data operations /api/v2/write: post: - operationId: PostLegacyV2Write + operationId: PostV2Write summary: Write line protocol (v2-compatible) description: > Writes line protocol to the specified database. - This is a legacy endpoint compatible with InfluxDB 2.x client libraries the Telegraf `outputs.influxdb_v2` output plugin, and third-party tools. + This endpoint provides backward compatibility for InfluxDB 2.x write workloads using tools such as InfluxDB 2.x client libraries, the Telegraf `outputs.influxdb_v2` output plugin, or third-party tools. Use this endpoint to send data in [line protocol](/influxdb3/core/reference/syntax/line-protocol/) format to InfluxDB. Use query parameters to specify options for writing data. @@ -140,19 +125,7 @@ paths: - gzip - identity type: string - - description: | - The format of the data in the request body. - To send a line protocol payload, pass `Content-Type: text/plain; charset=utf-8`. - in: header - name: Content-Type - schema: - default: text/plain; charset=utf-8 - description: | - `text/plain` is the content type for line protocol. `UTF-8` is the default character set. - enum: - - text/plain - - text/plain; charset=utf-8 - type: string + - $ref: "#/components/parameters/ContentTypeLineProtocol" - description: | The size of the entity-body, in bytes, sent to InfluxDB. in: header @@ -185,33 +158,19 @@ paths: in: query required: false schema: - type: boolean - default: false - description: Whether to accept partial writes. + $ref: '#/components/schemas/AcceptPartial' - name: precision in: query required: true schema: - $ref: '#/components/schemas/LegacyWritePrecision' + $ref: '#/components/schemas/PrecisionWrite' description: The precision for unix timestamps in the line protocol batch. - - name: no_sync - in: query - required: false - schema: - type: boolean - default: false - description: Do not sync writes. - $ref: '#/components/parameters/ContentType' requestBody: - required: true - content: - text/plain: - schema: - type: string - example: "measurement,tag=value field=1 1234567890" + $ref: '#/components/requestBodies/lineProtocolRequestBody' responses: "204": - description: Write successful. + description: Success ("No Content"). All data in the batch is written and queryable. "400": description: Bad request. "401": @@ -223,8 +182,8 @@ paths: security: - BearerAuth: [] tags: - - Legacy v2-compatible - - Write data + - Backward compatibility + - Data operations /api/v3/write_lp: post: operationId: PostWriteLP @@ -236,37 +195,23 @@ paths: Use query parameters to specify options for writing data. parameters: - $ref: '#/components/parameters/dbWriteParam' - - name: accept_partial - in: query - required: false - schema: - type: boolean - default: true - description: Whether to accept partial writes. + - $ref: '#/components/parameters/accept_partial' - name: precision in: query required: true schema: - $ref: '#/components/schemas/WritePrecision' + $ref: '#/components/schemas/PrecisionWrite' description: Precision of timestamps. - name: no_sync in: query - required: false schema: - type: boolean - default: false - description: Do not sync writes. - - $ref: '#/components/parameters/ContentType' + $ref: '#/components/schemas/NoSync' + - $ref: '#/components/parameters/ContentTypeLineProtocol' requestBody: - required: true - content: - text/plain: - schema: - type: string - example: "measurement,tag=value field=1 1234567890" + $ref: '#/components/requestBodies/lineProtocolRequestBody' responses: "204": - description: Write successful. + description: Success ("No Content"). All data in the batch is written and queryable. "400": description: Bad request. "401": @@ -280,7 +225,7 @@ paths: security: - BearerAuth: [] tags: - - Write data + - Data operations /api/v3/query_sql: get: operationId: GetExecuteQuerySQL @@ -298,7 +243,8 @@ paths: required: false schema: type: string - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/AcceptQueryHeader' + - $ref: '#/components/parameters/ContentType' responses: "200": description: Success. The response body contains query results. @@ -336,213 +282,16 @@ paths: security: - BearerAuth: [] tags: - - Query data + - Data operations post: operationId: PostExecuteQuerySQL summary: Execute SQL query description: Executes an SQL query to retrieve data from the specified database. parameters: + - $ref: '#/components/parameters/AcceptQueryHeader' - $ref: '#/components/parameters/ContentType' requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/QueryRequest' - responses: - "200": - description: Successful query execution. - content: - application/json: - schema: - $ref: '#/components/schemas/QueryResponse' - text/csv: - schema: - type: string - application/vnd.apache.parquet: - schema: - type: string - application/jsonl: - schema: - type: string - "400": - description: Bad request. - "401": - $ref: '#/components/responses/Unauthorized' - "403": - description: Access denied. - "404": - description: Database not found. - "405": - description: Method not allowed. - "422": - description: Unprocessable entity. - security: - - BearerAuth: [] - tags: - - Query data - /api/v3/query_influxql: - get: - operationId: GetExecuteInfluxQLQuery - summary: Execute InfluxQL query - description: Executes an InfluxQL query to retrieve data from the specified database. - parameters: - - $ref: '#/components/parameters/db' - - name: q - in: query - required: true - schema: - type: string - - name: format - in: query - required: false - schema: - type: string - - $ref: '#/components/parameters/Accept' - responses: - "200": - description: Successful query execution. - content: - application/json: - schema: - $ref: '#/components/schemas/QueryResponse' - text/csv: - schema: - type: string - application/vnd.apache.parquet: - schema: - type: string - application/jsonl: - schema: - type: string - "400": - description: Bad request. - "401": - $ref: '#/components/responses/Unauthorized' - "403": - description: Access denied. - "404": - description: Database not found. - "405": - description: Method not allowed. - "422": - description: Unprocessable entity. - security: - - BearerAuth: [] - tags: - - InfluxQL query - post: - operationId: PostExecuteQueryInfluxQL - summary: Execute InfluxQL query - description: Executes an InfluxQL query to retrieve data from the specified database. - parameters: - - $ref: '#/components/parameters/ContentType' - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/QueryRequest' - responses: - "200": - description: Successful query execution. - content: - application/json: - schema: - $ref: '#/components/schemas/QueryResponse' - text/csv: - schema: - type: string - application/vnd.apache.parquet: - schema: - type: string - application/jsonl: - schema: - type: string - "400": - description: Bad request. - "401": - $ref: '#/components/responses/Unauthorized' - "403": - description: Access denied. - "404": - description: Database not found. - "405": - description: Method not allowed. - "422": - description: Unprocessable entity. - security: - - BearerAuth: [] - tags: - - InfluxQL query - /query: - get: - operationId: GetLegacyV1ExecuteQuery - summary: Execute InfluxQL query (v1-compatible) - description: | - Executes an InfluxQL query to retrieve data from the specified database. - - This endpoint is compatible with InfluxDB 1.x client libraries and third-party integrations such as Grafana. - Use query parameters to specify the database and the InfluxQL query. - - parameters: - - $ref: '#/components/parameters/db' - - name: q - in: query - required: true - schema: - type: string - - name: format - in: query - required: false - schema: - type: string - - $ref: '#/components/parameters/Accept' - responses: - "200": - description: Successful query execution. - content: - application/json: - schema: - $ref: '#/components/schemas/QueryResponse' - text/csv: - schema: - type: string - application/vnd.apache.parquet: - schema: - type: string - application/jsonl: - schema: - type: string - "400": - description: Bad request. - "401": - $ref: '#/components/responses/Unauthorized' - "403": - description: Access denied. - "404": - description: Database not found. - "405": - description: Method not allowed. - "422": - description: Unprocessable entity. - security: - - BearerAuth: [] - tags: - - Query data - - Legacy v1-compatible - post: - operationId: PostExecuteLegacyV1Query - summary: Execute InfluxQL query (v1-compatible) - description: Executes an InfluxQL query to retrieve data from the specified database. - parameters: - - $ref: '#/components/parameters/ContentType' - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/QueryRequest' + $ref: '#/components/requestBodies/queryRequestBody' responses: "200": description: Success. The response body contains query results. @@ -574,61 +323,369 @@ paths: security: - BearerAuth: [] tags: - - Query data - - Legacy v1-compatible + - Data operations + /api/v3/query_influxql: + get: + operationId: GetExecuteInfluxQLQuery + summary: Execute InfluxQL query + description: Executes an InfluxQL query to retrieve data from the specified database. + parameters: + - $ref: '#/components/parameters/dbQueryParam' + - name: q + in: query + required: true + schema: + type: string + - name: format + in: query + required: false + schema: + type: string + - $ref: '#/components/parameters/AcceptQueryHeader' + responses: + "200": + description: Success. The response body contains query results. + content: + application/json: + schema: + $ref: '#/components/schemas/QueryResponse' + text/csv: + schema: + type: string + application/vnd.apache.parquet: + schema: + type: string + application/jsonl: + schema: + type: string + "400": + description: Bad request. + "401": + $ref: '#/components/responses/Unauthorized' + "403": + description: Access denied. + "404": + description: Database not found. + "405": + description: Method not allowed. + "422": + description: Unprocessable entity. + security: + - BearerAuth: [] + tags: + - Data operations + post: + operationId: PostExecuteQueryInfluxQL + summary: Execute InfluxQL query + description: Executes an InfluxQL query to retrieve data from the specified database. + parameters: + - $ref: '#/components/parameters/AcceptQueryHeader' + - $ref: '#/components/parameters/ContentType' + requestBody: + $ref: '#/components/requestBodies/queryRequestBody' + responses: + "200": + description: Success. The response body contains query results. + content: + application/json: + schema: + $ref: '#/components/schemas/QueryResponse' + text/csv: + schema: + type: string + application/vnd.apache.parquet: + schema: + type: string + application/jsonl: + schema: + type: string + "400": + description: Bad request. + "401": + $ref: '#/components/responses/Unauthorized' + "403": + description: Access denied. + "404": + description: Database not found. + "405": + description: Method not allowed. + "422": + description: Unprocessable entity. + security: + - BearerAuth: [] + tags: + - Data operations + /query: + get: + operationId: GetV1ExecuteQuery + summary: Execute InfluxQL query (v1-compatible) + description: | + Executes an InfluxQL query to retrieve data from the specified database. + + This endpoint is compatible with InfluxDB 1.x client libraries and third-party integrations such as Grafana. + Use query parameters to specify the database and the InfluxQL query. + parameters: + # Source: https://github.com/influxdata/influxdb/blob/main/influxdb3_server/src/http/v1.rs + - name: Accept + in: header + schema: + type: string + default: application/json + enum: + - application/json + - application/csv + - text/csv + required: false + description: | + The content type that the client can understand. + + If `text/csv` is specified, the `Content-type` response header is `application/csv` and the response is formatted as CSV. + + Returns an error if the format is invalid or non-UTF8. + - in: query + name: chunked + description: | + If true, the response is divided into chunks of size `chunk_size`. + schema: + type: boolean + default: false + - in: query + name: chunk_size + description: | + The number of records that will go into a chunk. + This parameter is only used if `chunked=true`. + schema: + type: integer + default: 10000 + - in: query + name: db + description: The database to query. If not provided, the InfluxQL query string must specify the database. + schema: + type: string + format: InfluxQL + - in: query + name: epoch + description: | + Map timestamps to UNIX epoch time, with the given precision. + The default is `ns`. + schema: + type: string + enum: [h, m, s, ms, u, ns] + - in: query + name: pretty + description: | + If true, the JSON response is formatted in a human-readable format. + schema: + type: boolean + default: false + - in: query + name: q + description: The InfluxQL query string. + required: true + schema: + type: string + responses: + "200": + description: | + Success. The response body contains query results. + content: + application/json: + schema: + $ref: '#/components/schemas/QueryResponse' + application/csv: + schema: + type: string + headers: + Content-Type: + description: | + The content type of the response. + Default is `application/json`. + + If the `Accept` request header is `application/csv` or `text/csv`, the `Content-type` response header is `application/csv` + and the response is formatted as CSV. + schema: + type: string + default: application/json + enum: + - application/json + - application/csv + "400": + description: Bad request. + "401": + $ref: '#/components/responses/Unauthorized' + "403": + description: Access denied. + "404": + description: Database not found. + "405": + description: Method not allowed. + "422": + description: Unprocessable entity. + security: + - BearerAuth: [] + tags: + - Data operations + - Backward compatibility + post: + operationId: PostExecuteV1Query + summary: Execute InfluxQL query (v1-compatible) + description: Executes an InfluxQL query to retrieve data from the specified database. + requestBody: + # Source: https://github.com/influxdata/influxdb/blob/main/influxdb3_server/src/http/v1.rs + content: + application/json: + schema: + type: object + properties: + db: + type: string + description: The database to query. If not provided, the InfluxQL query string must specify the database. + q: + description: The InfluxQL query string. + type: string + chunked: + description: | + If true, the response is divided into chunks of size `chunk_size`. + type: boolean + chunk_size: + description: | + The number of records that will go into a chunk. + This parameter is only used if `chunked=true`. + type: integer + default: 10000 + epoch: + description: | + Map timestamps to UNIX epoch time, with the given precision. + The default is `ns`. + type: string + enum: [h, m, s, ms, u, ns] + pretty: + description: | + If true, the JSON response is formatted in a human-readable format. + type: boolean + required: + - q + parameters: + - name: Accept + in: header + schema: + type: string + default: application/json + enum: + - application/json + - application/csv + - text/csv + required: false + description: | + The content type that the client can understand. + + If `text/csv` is specified, the `Content-type` response header is `application/csv` and the response is formatted as CSV. + + Returns an error if the format is invalid or non-UTF8. + responses: + "200": + description: | + Success. The response body contains query results. + content: + application/json: + schema: + $ref: '#/components/schemas/QueryResponse' + application/csv: + schema: + type: string + headers: + Content-Type: + description: | + The content type of the response. + Default is `application/json`. + + If the `Accept` request header is `application/csv` or `text/csv`, the `Content-type` response header is `application/csv` + and the response is formatted as CSV. + schema: + type: string + default: application/json + enum: + - application/json + - application/csv + "400": + description: Bad request. + "401": + $ref: '#/components/responses/Unauthorized' + "403": + description: Access denied. + "404": + description: Database not found. + "405": + description: Method not allowed. + "422": + description: Unprocessable entity. + security: + - BearerAuth: [] + tags: + - Data operations + - Backward compatibility /health: get: operationId: GetHealth - summary: Health Check - description: Returns the status of the service. + summary: Health check + description: Checks the status of the service. responses: "200": description: Service is running. "500": description: Service is unavailable. tags: - - Server + - Server information + # Why /api/v1/health? The v1 endpoint is `/health`. /api/v1/health: get: operationId: GetHealthV1 - summary: Health Check (v1) - description: Returns the status of the service. + summary: Health check (v1) + description: Checks the status of the service. responses: "200": description: Service is running. "500": description: Service is unavailable. tags: - - Server - - Legacy v1-compatible + - Server information + - Backward compatibility /ping: get: operationId: GetPing tags: - - Server - summary: Ping the Server - description: Returns basic server information. + - Server information + summary: Ping the server + description: Returns version information for the server. responses: "200": - description: Server is reachable. + description: Success. The response body contains server information. + content: + application/json: + schema: + example: + version: "0.1.0" + revision: "f3d3d3d" /metrics: get: operationId: GetMetrics summary: Metrics - description: Retrieves Prometheus-compatible metrics. + description: Retrieves Prometheus-compatible server metrics. responses: "200": - description: Metrics returned. + description: Success. The response body contains Prometheus-compatible server metrics. tags: - - Server + - Server information /api/v3/configure/database: get: operationId: GetConfigureDatabase - summary: List Databases + summary: List databases description: Retrieves a list of databases. + parameters: + - $ref: '#/components/parameters/formatRequired' responses: "200": - description: Databases retrieved. + description: Success. The response body contains the list of databases. content: application/json: schema: @@ -642,11 +699,10 @@ paths: security: - BearerAuth: [] tags: - - List - - Database + - Databases post: operationId: PostConfigureDatabase - summary: Create a Database + summary: Create a database description: Creates a new database in the system. requestBody: required: true @@ -656,7 +712,7 @@ paths: $ref: '#/components/schemas/CreateDatabaseRequest' responses: "201": - description: Database created. + description: Success. Database created. "400": description: Bad request. "401": @@ -666,19 +722,18 @@ paths: security: - BearerAuth: [] tags: - - Create - - Database + - Databases delete: operationId: DeleteConfigureDatabase - summary: Delete a Database + summary: Delete a database description: | Soft deletes a database. The database is scheduled for deletion and unavailable for querying. parameters: - - $ref: '#/components/parameters/db' + - $ref: '#/components/parameters/db' responses: "200": - description: Database deleted. + description: Success. Database deleted. "401": $ref: '#/components/responses/Unauthorized' "404": @@ -686,12 +741,12 @@ paths: security: - BearerAuth: [] tags: - - Delete - - Database + - Databases /api/v3/configure/table: post: + # client log message: [CreateTable(WalTableDefinition { database_id: DbId(0), database_name: "sensors2", table_name: "home2", table_id: TableId(3), field_definitions: [FieldDefinition { name: "time", id: ColumnId(3), data_type: Timestamp }], key: [] })] } operationId: PostConfigureTable - summary: Create a Table + summary: Create a table description: Creates a new table within a database. requestBody: required: true @@ -701,7 +756,7 @@ paths: $ref: '#/components/schemas/CreateTableRequest' responses: "201": - description: Table created. + description: Success. The table has been created. "400": description: Bad request. "401": @@ -711,16 +766,15 @@ paths: security: - BearerAuth: [] tags: - - Create - - Table + - Tables delete: operationId: DeleteConfigureTable - summary: Delete a Table + summary: Delete a table description: | Soft deletes a table. The table is scheduled for deletion and unavailable for querying. parameters: - - $ref: '#/components/parameters/db' + - $ref: '#/components/parameters/db' - name: table in: query required: true @@ -728,7 +782,7 @@ paths: type: string responses: "200": - description: Table deleted. + description: Success (no content). The table has been deleted. "401": $ref: '#/components/responses/Unauthorized' "404": @@ -736,12 +790,11 @@ paths: security: - BearerAuth: [] tags: - - Delete - - Table + - Tables /api/v3/configure/distinct_cache: post: operationId: PostConfigureDistinctCache - summary: Create Distinct Cache + summary: Create distinct cache description: Creates a distinct cache for a table. requestBody: required: true @@ -751,54 +804,18 @@ paths: $ref: '#/components/schemas/DistinctCacheCreateRequest' responses: "201": - description: Distinct cache created. + description: Success. The distinct cache has been created. + "204": + description: Not created. A distinct cache with this configuration already exists. "400": - description: Bad request. - "401": - $ref: '#/components/responses/Unauthorized' - "404": - description: Cache not found. - "409": - description: Cache already exists. - security: - - BearerAuth: [] - tags: - - Create - - Cache - delete: - operationId: DeleteConfigureDistinctCache - summary: Delete Distinct Cache - description: Deletes a distinct cache. - parameters: - - $ref: '#/components/parameters/db' - - name: table - in: query - required: true - schema: - type: string - - name: name - in: query - required: true - schema: - type: string - responses: - "200": - description: Distinct cache deleted. - "400": - description: Bad request. - "401": - $ref: '#/components/responses/Unauthorized' - "404": - description: Cache not found. - security: - - BearerAuth: [] - tags: - - Delete - - Cache + description: | + Bad request. + + The server responds with status `400` if the request would overwrite an existing cache with a different configuration. /api/v3/configure/last_cache: post: operationId: PostConfigureLastCache - summary: Create Last Cache + summary: Create last cache description: Creates a last cache for a table. requestBody: required: true @@ -808,7 +825,7 @@ paths: $ref: '#/components/schemas/LastCacheCreateRequest' responses: "201": - description: Last cache created. + description: Success. Last cache created. "400": description: Bad request. "401": @@ -820,11 +837,10 @@ paths: security: - BearerAuth: [] tags: - - Create - - Cache + - Tables delete: operationId: DeleteConfigureLastCache - summary: Delete Last Cache + summary: Delete last cache description: Deletes a last cache. parameters: - $ref: '#/components/parameters/db' @@ -840,7 +856,7 @@ paths: type: string responses: "200": - description: Last cache deleted. + description: Success. The last cache has been deleted. "400": description: Bad request. "401": @@ -850,12 +866,11 @@ paths: security: - BearerAuth: [] tags: - - Delete - - Cache + - Tables /api/v3/configure/processing_engine_trigger: post: operationId: PostConfigureProcessingEngineTrigger - summary: Create Processing Engine Trigger + summary: Create processing engine trigger description: Creates a new processing engine trigger. requestBody: required: true @@ -865,7 +880,7 @@ paths: $ref: '#/components/schemas/ProcessingEngineTriggerRequest' responses: "201": - description: Processing engine trigger created. + description: Success. Processing engine trigger created. "400": description: Bad request. "401": @@ -875,11 +890,10 @@ paths: security: - BearerAuth: [] tags: - - Create - - Processing engine + - Data operations delete: operationId: DeleteConfigureProcessingEngineTrigger - summary: Delete Processing Engine Trigger + summary: Delete processing engine trigger description: Deletes a processing engine trigger. parameters: - $ref: '#/components/parameters/db' @@ -896,7 +910,7 @@ paths: default: false responses: "200": - description: Processing engine trigger deleted. + description: Success. The processing engine trigger has been deleted. "400": description: Bad request. "401": @@ -906,12 +920,11 @@ paths: security: - BearerAuth: [] tags: - - Delete - - Processing engine + - Data operations /api/v3/configure/processing_engine_trigger/disable: post: operationId: PostDisableProcessingEngineTrigger - summary: Disable Processing Engine Trigger + summary: Disable processing engine trigger description: Disables a processing engine trigger. parameters: - $ref: '#/components/parameters/ContentType' @@ -923,7 +936,7 @@ paths: $ref: '#/components/schemas/ProcessingEngineTriggerRequest' responses: "200": - description: Processing engine trigger disabled. + description: Success. The processing engine trigger has been disabled. "400": description: Bad request. "401": @@ -933,11 +946,11 @@ paths: security: - BearerAuth: [] tags: - - Processing engine + - Data operations /api/v3/configure/processing_engine_trigger/enable: post: operationId: PostEnableProcessingEngineTrigger - summary: Enable Processing Engine Trigger + summary: Enable processing engine trigger description: Enables a processing engine trigger. parameters: - $ref: '#/components/parameters/ContentType' @@ -949,7 +962,7 @@ paths: $ref: '#/components/schemas/ProcessingEngineTriggerRequest' responses: "200": - description: Processing engine trigger enabled. + description: Success. The processing engine trigger has been enabled. "400": description: Bad request. "401": @@ -959,11 +972,11 @@ paths: security: - BearerAuth: [] tags: - - Processing engine + - Data operations /api/v3/configure/plugin_environment/install_packages: post: operationId: PostInstallPluginPackages - summary: Install Plugin Packages + summary: Install plugin packages description: Installs packages for the plugin environment. parameters: - $ref: '#/components/parameters/ContentType' @@ -976,7 +989,7 @@ paths: additionalProperties: true responses: "200": - description: Packages installed. + description: Success. The packages have been installed. "400": description: Bad request. "401": @@ -984,11 +997,11 @@ paths: security: - BearerAuth: [] tags: - - Processing engine + - Data operations /api/v3/configure/plugin_environment/install_requirements: post: operationId: PostInstallPluginRequirements - summary: Install Plugin Requirements + summary: Install plugin requirements description: Installs requirements for the plugin environment. parameters: - $ref: '#/components/parameters/ContentType' @@ -1001,7 +1014,7 @@ paths: additionalProperties: true responses: "200": - description: Requirements installed. + description: Success. The requirements have been installed. "400": description: Bad request. "401": @@ -1009,15 +1022,15 @@ paths: security: - BearerAuth: [] tags: - - Processing engine + - Data operations /api/v3/plugin_test/wal: post: operationId: PostTestWALPlugin - summary: Test WAL Plugin + summary: Test WAL plugin description: Executes a test of a write-ahead logging (WAL) plugin. responses: "200": - description: Plugin test executed. + description: Success. The plugin test has been executed. "400": description: Bad request. "401": @@ -1027,15 +1040,15 @@ paths: security: - BearerAuth: [] tags: - - Processing engine + - Data operations /api/v3/plugin_test/schedule: post: operationId: PostTestSchedulingPlugin - summary: Test Scheduling Plugin + summary: Test scheduling plugin description: Executes a test of a scheduling plugin. responses: "200": - description: Plugin test executed. + description: Success. The plugin test has been executed. "400": description: Bad request. "401": @@ -1045,23 +1058,45 @@ paths: security: - BearerAuth: [] tags: - - Processing engine + - Data operations /api/v3/engine/{plugin_path}: parameters: - name: plugin_path + description: | + The path configured in the `trigger-spec` for the plugin. + + For example, if you define a trigger with the following: + + ``` + trigger-spec: "request:hello-world" + ``` + + then, the HTTP API exposes the following plugin endpoint: + + ``` + /api/v3/engine/hello-world + ``` in: path required: true schema: type: string get: operationId: GetProcessingEnginePluginRequest - summary: Custom Processing Engine Request (GET) - description: Sends a custom request to a processing engine plugin. - parameters: - - $ref: '#/components/parameters/Accept' + summary: On-request processing engine plugin request + description: | + Sends a request to invoke an _on-request_ processing engine plugin. + The request can include request headers, query string parameters, and a request body, which InfluxDB passes to the plugin. + + An on-request plugin implements the following signature: + + ```python + def process_request(influxdb3_local, query_parameters, request_headers, request_body, args=None) + ``` + + The response depends on the plugin implementation. responses: "200": - description: Request successful. + description: Success. The plugin request has been executed. "400": description: Malformed request. "401": @@ -1073,11 +1108,11 @@ paths: security: - BearerAuth: [] tags: - - Processing engine + - Data operations post: operationId: PostProcessingEnginePluginRequest - summary: Custom Processing Engine Request (POST) - description: Sends a custom request to a processing engine plugin. + summary: On-request processing engine plugin request + description: Sends custom request to a processing engine plugin. parameters: - $ref: '#/components/parameters/ContentType' requestBody: @@ -1089,7 +1124,7 @@ paths: additionalProperties: true responses: "200": - description: Request successful. + description: Success. The plugin request has been executed. "400": description: Malformed request. "401": @@ -1101,9 +1136,23 @@ paths: security: - BearerAuth: [] tags: - - Processing engine + - Data operations components: parameters: + AcceptQueryHeader: + name: Accept + in: header + schema: + type: string + default: application/json + enum: + - application/json + - application/jsonl + - application/vnd.apache.parquet + - text/csv + required: false + description: | + The content type that the client can understand. ContentEncoding: name: Content-Encoding in: header @@ -1113,13 +1162,6 @@ components: schema: $ref: '#/components/schemas/ContentEncoding' required: false - Accept: - name: Accept - in: header - schema: - $ref: '#/components/schemas/Accept' - required: false - description: The content type that the client can understand. ContentLength: name: Content-Length in: header @@ -1128,6 +1170,14 @@ components: schema: $ref: '#/components/schemas/ContentLength' ContentType: + name: Content-Type + in: header + schema: + type: string + enum: + - application/json + required: false + ContentTypeLineProtocol: name: Content-Type in: header description: | @@ -1135,48 +1185,8 @@ components: To send a line protocol payload, pass `Content-Type: text/plain; charset=utf-8`. schema: - $ref: '#/components/schemas/ContentType' + $ref: '#/components/schemas/LineProtocol' required: false - dbWriteParam: - name: db - in: query - required: true - schema: - type: string - description: | - A database name. - InfluxDB creates the database if it doesn't already exist, and then - writes all points in the batch to the database. - accept_partial: - name: accept_partial - in: query - required: false - schema: - type: boolean - default: false - description: Whether to accept partial writes. - precision: - name: precision - in: query - required: true - schema: - $ref: '#/components/schemas/WritePrecision' - description: The precision for unix timestamps in the line protocol batch. - precisionLegacyParam: - name: precision - in: query - required: true - schema: - $ref: '#/components/schemas/LegacyWritePrecision' - description: The precision for unix timestamps in the line protocol batch. - no_sync: - name: no_sync - in: query - required: false - schema: - type: boolean - default: false - description: Do not sync writes. db: name: db in: query @@ -1185,14 +1195,67 @@ components: type: string description: | The name of the database. - q: - name: q + dbWriteParam: + name: db in: query required: true schema: type: string + description: | + The name of the database. + InfluxDB creates the database if it doesn't already exist, and then + writes all points in the batch to the database. + dbQueryParam: + name: db + in: query + required: false + schema: + type: string + description: | + The name of the database. + + If you provide a query that specifies the database, you can omit the 'db' parameter from your request. + accept_partial: + name: accept_partial + in: query + required: false + schema: + $ref: '#/components/schemas/AcceptPartial' + compatibilityPrecisionParam: + name: precision + in: query + required: true + schema: + $ref: '#/components/schemas/PrecisionWriteCompatibility' + description: The precision for unix timestamps in the line protocol batch. + precisionParam: + name: precision + in: query + required: true + schema: + $ref: '#/components/schemas/PrecisionWrite' + description: The precision for unix timestamps in the line protocol batch. + querySqlParam: + name: q + in: query + required: true + schema: + type: string + format: SQL description: | The query to execute. + format: + name: format + in: query + required: false + schema: + $ref: '#/components/schemas/Format' + formatRequired: + name: format + in: query + required: true + schema: + $ref: '#/components/schemas/Format' requestBodies: lineProtocolRequestBody: required: true @@ -1210,6 +1273,12 @@ components: measurement,tag=value field=1 1234567890 measurement,tag=value field=2 1234567900 measurement,tag=value field=3 1234568000 + queryRequestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/QueryRequestObject' schemas: ContentEncoding: type: string @@ -1218,43 +1287,36 @@ components: Content coding. Use `gzip` for compressed data or `identity` for unmodified, uncompressed data. default: identity - - ContentType: + LineProtocol: type: string enum: [text/plain, text/plain; charset=utf-8] description: | `text/plain` is the content type for line protocol. `UTF-8` is the default character set. default: text/plain; charset=utf-8 - ContentLength: type: integer description: The length in decimal number of octets. - - Accept: - type: string - enum: [application/json] - description: Error content type. - default: application/json - - db: + Database: type: string + AcceptPartial: + type: boolean + default: true + description: Accept partial writes. + Format: + type: string + enum: [json, csv, parquet, jsonl] description: | - A database name. - InfluxDB creates the database if it doesn't already exist, and then - writes all points in the batch to the database. - - accept_partial: + The format of data in the response body. + NoSync: type: boolean default: false - description: Whether to accept partial writes. - precision: - $ref: '#/components/schemas/LegacyWritePrecision' - no_sync: - type: boolean - default: false - description: Do not sync writes. + description: | + Do not sync writes. + + By default, InfluxDB writes ingested data to the WAL file and then waits for the WAL to be persistend to disk before acknowledging the write. - LegacyWritePrecision: + If `no_sync=true`, InfluxDB writes ingested data to the WAL file and the server does not wait for the write to be persisted before acknowledging the write. + PrecisionWriteCompatibility: enum: - ms - s @@ -1264,7 +1326,7 @@ components: description: | The precision for unix timestamps in the line protocol batch. Use `ms` for milliseconds, `s` for seconds, `us` for microseconds, or `ns` for nanoseconds. - WritePrecision: + PrecisionWrite: enum: - auto - millisecond @@ -1272,16 +1334,27 @@ components: - microsecond - nanosecond type: string - QueryRequest: + description: | + The precision for unix timestamps in the line protocol batch. + QueryRequestObject: type: object properties: database: + description: | + The name of the database to query. + Required if the query (`query_str`) doesn't specify the database. type: string query_str: + description: The query to execute. type: string format: + description: The format of the query results. type: string + enum: [json, csv, parquet, jsonl] params: + description: | + Additional parameters for the query. + Use this field to pass query parameters. type: object additionalProperties: true required: @@ -1326,6 +1399,7 @@ components: - db - table - fields + - tags DistinctCacheCreateRequest: type: object properties: @@ -1474,12 +1548,24 @@ components: required: - code responses: + # // Source https://github.com/influxdata/influxdb/blob/main/influxdb3_server/src/http.rs Unauthorized: description: Unauthorized access. content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' + Bad request: + description: | + Request failed. Possible reasons: + + - Invalid database name + - Malformed request body + - Invalid timestamp precision + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorMessage' Forbidden: description: Access denied. content: @@ -1495,10 +1581,13 @@ components: securitySchemes: BearerAuth: type: http - scheme: Bearer + scheme: bearer bearerFormat: JWT description: | + _During Alpha release, an API token is not required._ + A Bearer token for authentication. + Provide the scheme and the API token in the `Authorization` header--for example: ```bash diff --git a/api-docs/influxdb3/enterprise/v3/content/info.yml b/api-docs/influxdb3/enterprise/v3/content/info.yml index 76b2b11fd..4cb222003 100644 --- a/api-docs/influxdb3/enterprise/v3/content/info.yml +++ b/api-docs/influxdb3/enterprise/v3/content/info.yml @@ -1,10 +1,17 @@ title: InfluxDB 3 Enterprise API Service x-influxdata-short-title: InfluxDB 3 API -summary: The InfluxDB HTTP API for InfluxDB 3 Enterprise provides a programmatic interface for writing data stored in an InfluxDB 3 Enterprise database. +x-influxdata-version-matrix: + v1: Compatibility layer for InfluxDB 1.x clients (supported) + v2: Compatibility layer for InfluxDB 2.x clients (supported) + v3: Native API for InfluxDB 3.x (current) +summary: The InfluxDB HTTP API for InfluxDB 3 Core provides a programmatic interface for writing data stored in an InfluxDB 3 Core database. description: | Write and query data, and perform administrative tasks, such as managing databases and processing engine plugins. - The InfluxDB HTTP API for InfluxDB 3 Enterprise includes endpoints for compatibility with InfluxDB 2.x and InfluxDB 1.x APIs. + The InfluxDB HTTP API for InfluxDB 3 Core includes endpoints for the following: + - InfluxDB v1: Compatibility layer for InfluxDB 1.x clients (supported) + - `/api/v2`: Compatibility layer for InfluxDB 2.x clients (supported) + - `/api/v3`: Native API for InfluxDB 3.x (current)