diff --git a/api-docs/.redocly.yaml b/api-docs/.redocly.yaml index 78958a319..e4679a686 100644 --- a/api-docs/.redocly.yaml +++ b/api-docs/.redocly.yaml @@ -1,11 +1,8 @@ +apiDefintions: + main: ref.yaml lint: + plugins: + - './openapi/plugins/docs-plugin.js' extends: - recommended - plugins: - - './plugins/servers-plugin.js' - rules: - no-server-trailing-slash: off - servers/validate-servers-url: error - decorators: - servers/replace-servers-url: error - servers/set-servers-url: error + - docs/all diff --git a/api-docs/README.md b/api-docs/README.md index d94d08c9b..ecd1d2b56 100755 --- a/api-docs/README.md +++ b/api-docs/README.md @@ -2,7 +2,7 @@ InfluxDB uses [Redoc](https://github.com/Redocly/redoc/), [redoc-cli](https://github.com/Redocly/redoc/blob/master/cli/README.md), and Redocly's [OpenApi CLI](https://redoc.ly/docs/cli/) to generate -API documentation from the InfluxDB `swagger.yml`. +API documentation from the InfluxDB openapi contracts. To minimize repo size, the generated API documentation HTML is gitignored, therefore not committed directly to the docs repo. @@ -13,19 +13,28 @@ to generate version-specific API documentation. The structure versions swagger files using the following pattern: ``` - │ └── swagger.yml +api-docs/ + ├── v2.0/ + │ └── ref.yml + ├── v2.1/ + │ └── ref.yml + ├── v2.2/ + │ └── ref.yml └── etc... ``` -### OpenAPI CLI configuration +### Configure OpenAPI CLI linting and bundling `.redoc.yaml` sets linting and bundling options for `openapi` CLI. -`./plugins` contains custom OpenAPI CLI plugins composed of *rules* (for linting) and *decorators* (for bundle customization). -api-docs/ - ├── v2.0/ - │ └── swagger.yml - ├── v2.1/ - │ └── swagger.yml - ├── v2.2/ +`./openapi/plugins` contains custom OpenAPI CLI plugins composed of *rules* (for linting) and *decorators* (for bundle customization). + +### Custom content +`./openapi/content` contains custom OAS (OpenAPI Spec) content in YAML files. The content structure and Markdown must be valid OAS. + +`./openapi/plugins` use `./openapi/plugins/decorators` to apply the content to the contracts. +`.yml` files in `./openapi/content/` set content for sections (nodes) in the contract. To update the content for those nodes, you only need to update the YAML files. + +To add new YAML files for other nodes in the openapi contracts, configure the new content YAML file in `./openapi/content/content.js`. Then, write a decorator module for the node and configure the decorator in the plugin, e.g. `./openapi/plugins/docs-plugin.js`. See the [complete list of OAS v3.0 nodes](https://github.com/Redocly/openapi-cli/blob/master/packages/core/src/types/oas3.ts#L529). + `openapi` CLI requires that modules use CommonJS `require` syntax for imports. ### Generate API docs locally diff --git a/api-docs/cloud/swagger.yml b/api-docs/cloud/ref.yml similarity index 67% rename from api-docs/cloud/swagger.yml rename to api-docs/cloud/ref.yml index 89303339d..966b491ad 100644 --- a/api-docs/cloud/swagger.yml +++ b/api-docs/cloud/ref.yml @@ -1,6412 +1,14 @@ -openapi: 3.0.0 -info: - title: Influx Cloud API Service - version: 2.0.1 - description: | - The InfluxDB v2 API provides a programmatic interface for all interactions with InfluxDB. Access the InfluxDB API using the `/api/v2/` endpoint. -servers: -- url: "/" -tags: - - name: Authentication - 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) - - x-traitTag: true - - name: Invocable Scripts - description: | - Manage and execute scripts as API endpoints in InfluxDB. - - An API Invocable Script assigns your custom Flux script to a new InfluxDB API endpoint for your organization. - Invocable scripts let you execute your script as an HTTP request to the endpoint. - - Invocable scripts accept parameters. Add parameter references in your script as `params.myparameter`. - When you `invoke` your script, you send parameters as key-value pairs in the `params` object. - InfluxDB executes your script with the key-value pairs as arguments and returns the result. - - For more information and examples, see [Invoke custom scripts](https://docs.influxdata.com/influxdb/cloud/api-guide/api-invocable-scripts). - - name: Quick start - x-traitTag: true - description: | - See the [**API Quick Start**](https://docs.influxdata.com/influxdb/cloud/api-guide/api_intro/) to get up and running authenticating with tokens, writing to buckets, and querying data. - - [**InfluxDB API client libraries**](https://docs.influxdata.com/influxdb/cloud/api-guide/client-libraries/) are available for popular languages and ready to import into your application. - - name: Response codes - x-traitTag: true - description: | - The InfluxDB API uses 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 | | - | `204` | No content | For a `POST` request, `204` indicates that InfluxDB accepted the request and request data is valid. Asynchronous operations, such as `write`, might not have completed yet. | - | `400` | Bad request | `Authorization` header is missing or malformed or the API token does not have permission for the operation. | - | `401` | Unauthorized | May indicate one of the following:
  • `Authorization: Token` header is missing or malformed
  • API token value is missing from the header
  • API token does not have permission. For more information about token types and permissions, see [Manage API tokens](https://docs.influxdata.com/influxdb/cloud/security/tokens/)
    • | - | `404` | Not found | Requested resource was not found. `message` in the response body provides details about the requested resource. | - | `413` | Request entity too large | Request payload exceeds the size limit. | - | `422` | Unprocessible 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: Query - description: | - Retrieve data, analyze queries, and get query suggestions. - - name: Write - description: | - Write time series data to buckets. - - name: Authorizations - description: | - Create and manage API tokens. An **authorization** associates a list of permissions to an **organization** and provides a token for API access. To assign a token to a specific user, scope the authorization to the user ID. -x-tagGroups: - - name: Overview - tags: - - Quick start - - Authentication - - Response codes - - name: Data I/O endpoints - tags: - - Write - - Query - - name: Resource endpoints - tags: - - Buckets - - Dashboards - - Tasks - - Resources - - name: Security and access endpoints - tags: - - Authorizations - - Organizations - - Users - - name: System information endpoints - tags: - - Ping - - Routes - - name: All endpoints - tags: - - Annotations - - Authorizations - - Buckets - - Cells - - Checks - - DBRPs - - Dashboards - - Delete - - DemoDataBuckets - - Invocable Scripts - - Labels - - Limits - - NotificationEndpoints - - NotificationRules - - OAuth - - Organizations - - Ping - - Public Flags - - Query - - Resources - - Routes - - Rules - - Secrets - - Setup - - Signin - - Signout - - Streams - - Tasks - - Telegraf Plugins - - Telegrafs - - Templates - - Usage - - Users - - Variables - - Write -paths: - /api/v2/: - get: - operationId: GetRoutes - parameters: - - $ref: '#/components/parameters/TraceSpan' - responses: - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Routes' - description: All routes - summary: List all top level routes - tags: - - Routes - /api/v2/authorizations: - get: - operationId: GetAuthorizations - parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: Only show authorizations that belong to a user ID. - in: query - name: userID - schema: - type: string - - description: Only show authorizations that belong to a user name. - in: query - name: user - schema: - type: string - - description: Only show authorizations that belong to an organization ID. - in: query - name: orgID - schema: - type: string - - description: Only show authorizations that belong to a organization name. - in: query - name: org - schema: - type: string - - description: Find a token by value. - in: query - name: token - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/Authorizations' - description: A list of authorizations - default: - $ref: '#/components/responses/ServerError' - description: Unexpected error - summary: List all authorizations - tags: - - Authorizations - post: - operationId: PostAuthorizations - parameters: - - $ref: '#/components/parameters/TraceSpan' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Authorization' - description: Authorization to create - required: true - responses: - "201": - content: - application/json: - schema: - $ref: '#/components/schemas/Authorization' - description: Authorization created - "400": - $ref: '#/components/responses/ServerError' - description: Invalid request - default: - $ref: '#/components/responses/ServerError' - description: Unexpected error - summary: Create an authorization - tags: - - Authorizations - /api/v2/authorizations/{authID}: - delete: - operationId: DeleteAuthorizationsID - parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The identifier of the authorization to delete. - in: path - name: authID - required: true - schema: - type: string - responses: - "204": - description: Authorization deleted - default: - $ref: '#/components/responses/ServerError' - description: Unexpected error - summary: Delete an authorization - tags: - - Authorizations - get: - operationId: GetAuthorizationsID - parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The identifier of the authorization to get. - in: path - name: authID - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/Authorization' - description: Authorization details - default: - $ref: '#/components/responses/ServerError' - description: Unexpected error - summary: Retrieve an authorization - tags: - - Authorizations - patch: - description: Update an authorization's status to `active` or `inactive`. - operationId: PatchAuthorizationsID - parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The identifier of the authorization to update. - in: path - name: authID - required: true - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AuthorizationUpdateRequest' - description: The updated Authorization object. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/Authorization' - description: The updated authorization. - default: - $ref: '#/components/responses/ServerError' - description: Unexpected error - summary: Update authorization status - tags: - - Authorizations - /api/v2/buckets: - get: - operationId: GetBuckets - parameters: - - $ref: '#/components/parameters/TraceSpan' - - $ref: '#/components/parameters/Offset' - - $ref: '#/components/parameters/Limit' - - $ref: '#/components/parameters/After' - - description: The name of the organization. - in: query - name: org - schema: - type: string - - description: The organization ID. - in: query - name: orgID - schema: - type: string - - description: Only returns buckets with a specific name. - in: query - name: name - schema: - type: string - - description: Only returns buckets with a specific ID. - in: query - name: id - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/Buckets' - description: A list of buckets - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: List all buckets - tags: - - Buckets - post: - operationId: PostBuckets - parameters: - - $ref: '#/components/parameters/TraceSpan' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/PostBucketRequest' - description: Bucket to create - required: true - responses: - "201": - content: - application/json: - schema: - $ref: '#/components/schemas/Bucket' - description: Bucket created - "422": - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Request body failed validation - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: Create a bucket - tags: - - Buckets - /api/v2/buckets/{bucketID}: - delete: - operationId: DeleteBucketsID - parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The ID of the bucket to delete. - in: path - name: bucketID - 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 bucket - tags: - - Buckets - get: - operationId: GetBucketsID - parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The bucket ID. - in: path - name: bucketID - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/Bucket' - description: Bucket details - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: Retrieve a bucket - tags: - - Buckets - patch: - 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: Bucket update to apply - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/Bucket' - description: An updated bucket - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: Update a bucket - tags: - - Buckets - /api/v2/buckets/{bucketID}/labels: - get: - operationId: GetBucketsIDLabels - parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The bucket ID. - in: path - name: bucketID - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/LabelsResponse' - description: A list of all labels for a bucket - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: List all labels for a bucket - tags: - - Buckets - post: - operationId: PostBucketsIDLabels - 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/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 bucket - tags: - - Buckets - /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: - operationId: GetBucketsIDMembers - parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The bucket ID. - in: path - name: bucketID - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceMembers' - description: A list of bucket members - 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: - operationId: PostBucketsIDMembers - 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/AddResourceMemberRequestBody' - description: User to add as member - required: true - responses: - "201": - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceMember' - description: Member added to bucket - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: Add a member to a bucket - tags: - - Buckets - /api/v2/buckets/{bucketID}/members/{userID}: - delete: - operationId: DeleteBucketsIDMembersID - parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The ID of the member to remove. - in: path - name: userID - required: true - schema: - type: string - - description: The bucket ID. - in: path - name: bucketID - 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 bucket - tags: - - Buckets - /api/v2/buckets/{bucketID}/owners: - get: - operationId: GetBucketsIDOwners - parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The bucket ID. - in: path - name: bucketID - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceOwners' - description: A list of bucket owners - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: List all owners of a bucket - tags: - - Buckets - post: - operationId: PostBucketsIDOwners - 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/AddResourceMemberRequestBody' - description: User to add as owner - required: true - responses: - "201": - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceOwner' - description: Bucket owner added - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: Add an owner to a bucket - tags: - - Buckets - /api/v2/buckets/{bucketID}/owners/{userID}: - delete: - 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 bucket ID. - in: path - name: bucketID - 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 bucket - tags: - - Buckets - /api/v2/buckets/{bucketID}/schema/measurements: - get: - operationId: getMeasurementSchemas - parameters: - - description: The name of the organization. - in: query - name: org - schema: - type: string - - description: The identifier of the organization. - in: query - name: orgID - schema: - type: string - - description: The name of the measurement to return schemas for. - in: query - name: name - schema: - type: string - - description: The identifier of the 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 - "404": - $ref: '#/components/responses/ServerError' - description: Bucket not found - summary: List all measurement schemas of a bucket - tags: - - Bucket Schemas - post: - operationId: createMeasurementSchema - parameters: - - description: The name of the organization. - in: query - name: org - schema: - type: string - - description: The identifier of the organization. - in: query - name: orgID - schema: - type: string - - description: The identifier of the bucket. - in: path - name: bucketID - required: true - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MeasurementSchemaCreateRequest' - responses: - "201": - content: - application/json: - schema: - $ref: '#/components/schemas/MeasurementSchema' - description: The created 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: Client error with create request - summary: Create a measurement schema for a bucket - tags: - - Bucket Schemas - summary: Bucket schemas - /api/v2/buckets/{bucketID}/schema/measurements/{measurementID}: - get: - operationId: getMeasurementSchema - parameters: - - description: The name of the organization. - in: query - name: org - schema: - type: string - - description: The identifier of the organization. - in: query - name: orgID - schema: - type: string - - description: The identifier of the bucket. - in: path - name: bucketID - required: true - schema: - type: string - - description: The identifier of the measurement. - 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 - summary: Retrieve measurement schema information - tags: - - Bucket Schemas - patch: - operationId: updateMeasurementSchema - parameters: - - description: The name of the organization. - in: query - name: org - schema: - type: string - - description: The identifier of the organization. - in: query - name: orgID - schema: - type: string - - description: The identifier of the bucket. - in: path - name: bucketID - required: true - schema: - type: string - - description: The identifier of the measurement. - in: path - name: measurementID - required: true - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MeasurementSchemaUpdateRequest' - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MeasurementSchema' - description: The updated 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: Client error updating measurement schema - summary: Update a measurement schema - tags: - - Bucket Schemas - summary: Bucket Schema - /api/v2/checks: - get: - operationId: GetChecks - parameters: - - $ref: '#/components/parameters/TraceSpan' - - $ref: '#/components/parameters/Offset' - - $ref: '#/components/parameters/Limit' - - description: Only show checks that belong to a specific organization ID. - in: query - name: orgID - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/Checks' - description: A list of checks - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: List all checks - tags: - - Checks - post: - operationId: CreateCheck - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/PostCheck' - description: Check to create - required: true - responses: - "201": - content: - application/json: - schema: - $ref: '#/components/schemas/Check' - description: Check created - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: Add new check - tags: - - Checks - /api/v2/checks/{checkID}: - delete: - operationId: DeleteChecksID - parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The check ID. - in: path - name: checkID - required: true - schema: - type: string - responses: - "204": - description: Delete has been accepted - "404": - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: The check was not found - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: Delete a check - tags: - - Checks - get: - operationId: GetChecksID - parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The check ID. - in: path - name: checkID - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/Check' - description: The check requested - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: Retrieve a check - tags: - - Checks - patch: - operationId: PatchChecksID - parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The check ID. - in: path - name: checkID - required: true - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CheckPatch' - description: Check update to apply - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/Check' - description: An updated check - "404": - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: The check was not found - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: Update a check - tags: - - Checks - put: - operationId: PutChecksID - parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The check ID. - in: path - name: checkID - required: true - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Check' - description: Check update to apply - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/Check' - description: An updated check - "404": - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: The check was not found - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: Update a check - tags: - - Checks - /api/v2/checks/{checkID}/labels: - get: - operationId: GetChecksIDLabels - parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The check ID. - in: path - name: checkID - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/LabelsResponse' - description: A list of all labels for a check - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: List all labels for a check - tags: - - Checks - post: - operationId: PostChecksIDLabels - parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The check ID. - in: path - name: checkID - 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 was added to the check - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: Add a label to a check - tags: - - Checks - /api/v2/checks/{checkID}/labels/{labelID}: - delete: - operationId: DeleteChecksIDLabelsID - parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The check ID. - in: path - name: checkID - 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: Check or label not found - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: Delete label from a check - tags: - - Checks - /api/v2/checks/{checkID}/query: - get: - operationId: GetChecksIDQuery - parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The check ID. - in: path - name: checkID - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/FluxResponse' - description: The check query requested - "400": - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Invalid request - "404": - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Check not found - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: Retrieve a check query - tags: - - Checks - /api/v2/dashboards: - get: - operationId: GetDashboards - parameters: - - $ref: '#/components/parameters/TraceSpan' - - $ref: '#/components/parameters/Offset' - - $ref: '#/components/parameters/Descending' - - description: The non-zero number of dashboards to return - in: query - name: limit - schema: - default: 20 - maximum: 100 - minimum: -1 - type: integer - - description: A user identifier. Returns only dashboards where this user has - the `owner` role. - in: query - name: owner - schema: - type: string - - description: The column to sort by. - in: query - name: sortBy - schema: - enum: - - ID - - CreatedAt - - UpdatedAt - type: string - - description: A list of dashboard identifiers. Returns only the listed dashboards. - If both `id` and `owner` are specified, only `id` is used. - in: query - name: id - schema: - items: - type: string - type: array - - description: The identifier of the organization. - in: query - name: orgID - schema: - type: string - - description: The name of the organization. - in: query - name: org - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/Dashboards' - description: All dashboards - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: List all dashboards - tags: - - Dashboards - post: - operationId: PostDashboards - parameters: - - $ref: '#/components/parameters/TraceSpan' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CreateDashboardRequest' - description: Dashboard to create - required: true - responses: - "201": - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/Dashboard' - - $ref: '#/components/schemas/DashboardWithViewProperties' - description: Added dashboard - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: Create a dashboard - tags: - - Dashboards - /api/v2/dashboards/{dashboardID}: - delete: - operationId: DeleteDashboardsID - parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The ID of the dashboard to update. - in: path - name: dashboardID - required: true - schema: - type: string - responses: - "204": - description: Delete has been accepted - "404": - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Dashboard not found - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: Delete a dashboard - tags: - - Dashboards - get: - operationId: GetDashboardsID - parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The ID of the dashboard to update. - in: path - name: dashboardID - required: true - schema: - type: string - - description: Includes the cell view properties in the response if set to `properties` - in: query - name: include - required: false - schema: - enum: - - properties - type: string - responses: - "200": - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/Dashboard' - - $ref: '#/components/schemas/DashboardWithViewProperties' - description: Retrieve a single dashboard - "404": - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Dashboard not found - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: Retrieve a Dashboard - tags: - - Dashboards - patch: - operationId: PatchDashboardsID - parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The ID of the dashboard to update. - in: path - name: dashboardID - required: true - schema: - type: string - requestBody: - content: - application/json: - schema: - properties: - cells: - $ref: '#/components/schemas/CellWithViewProperties' - description: optional, when provided will replace all existing cells - with the cells provided - description: - description: optional, when provided will replace the description - type: string - name: - description: optional, when provided will replace the name - type: string - title: PatchDashboardRequest - type: object - description: Patching of a dashboard - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/Dashboard' - description: Updated dashboard - "404": - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Dashboard not found - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: Update a dashboard - tags: - - Dashboards - /api/v2/dashboards/{dashboardID}/cells: - post: - operationId: PostDashboardsIDCells - parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The ID of the dashboard to update. - in: path - name: dashboardID - required: true - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CreateCell' - description: Cell that will be added - required: true - responses: - "201": - content: - application/json: - schema: - $ref: '#/components/schemas/Cell' - description: Cell successfully added - "404": - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Dashboard not found - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: Create a dashboard cell - tags: - - Cells - - Dashboards - put: - description: Replaces all cells in a dashboard. This is used primarily to update - the positional information of all cells. - operationId: PutDashboardsIDCells - parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The ID of the dashboard to update. - in: path - name: dashboardID - required: true - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Cells' - required: true - responses: - "201": - content: - application/json: - schema: - $ref: '#/components/schemas/Dashboard' - description: Replaced dashboard cells - "404": - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Dashboard not found - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: Replace cells in a dashboard - tags: - - Cells - - Dashboards - /api/v2/dashboards/{dashboardID}/cells/{cellID}: - delete: - operationId: DeleteDashboardsIDCellsID - parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The ID of the dashboard to delete. - in: path - name: dashboardID - required: true - schema: - type: string - - description: The ID of the cell to delete. - in: path - name: cellID - required: true - schema: - type: string - responses: - "204": - description: Cell successfully deleted - "404": - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Cell or dashboard not found - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: Delete a dashboard cell - tags: - - Cells - - Dashboards - patch: - description: Updates the non positional information related to a cell. Updates - to a single cell's positional data could cause grid conflicts. - operationId: PatchDashboardsIDCellsID - parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The ID of the dashboard to update. - in: path - name: dashboardID - required: true - schema: - type: string - - description: The ID of the cell to update. - in: path - name: cellID - required: true - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CellUpdate' - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/Cell' - description: Updated dashboard cell - "404": - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Cell or dashboard not found - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: Update the non-positional information related to a cell - tags: - - Cells - - Dashboards - /api/v2/dashboards/{dashboardID}/cells/{cellID}/view: - get: - operationId: GetDashboardsIDCellsIDView - parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The dashboard ID. - in: path - name: dashboardID - required: true - schema: - type: string - - description: The cell ID. - in: path - name: cellID - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/View' - description: A dashboard cells view - "404": - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Cell or dashboard not found - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: Retrieve the view for a cell - tags: - - Cells - - Dashboards - - Views - patch: - operationId: PatchDashboardsIDCellsIDView - parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The ID of the dashboard to update. - in: path - name: dashboardID - required: true - schema: - type: string - - description: The ID of the cell to update. - in: path - name: cellID - required: true - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/View' - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/View' - description: Updated cell view - "404": - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Cell or dashboard not found - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: Update the view for a cell - tags: - - Cells - - Dashboards - - Views - /api/v2/dashboards/{dashboardID}/labels: - get: - operationId: GetDashboardsIDLabels - parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The dashboard ID. - in: path - name: dashboardID - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/LabelsResponse' - description: A list of all labels for a dashboard - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: List all labels for a dashboard - tags: - - Dashboards - post: - operationId: PostDashboardsIDLabels - parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The dashboard ID. - in: path - name: dashboardID - 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 dashboard - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: Add a label to a dashboard - tags: - - Dashboards - /api/v2/dashboards/{dashboardID}/labels/{labelID}: - delete: - operationId: DeleteDashboardsIDLabelsID - parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The dashboard ID. - in: path - name: dashboardID - 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: Dashboard not found - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: Delete a label from a dashboard - tags: - - Dashboards - /api/v2/dashboards/{dashboardID}/members: - get: - operationId: GetDashboardsIDMembers - parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The dashboard ID. - in: path - name: dashboardID - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceMembers' - description: A list of users who have member privileges for a dashboard - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: List all dashboard members - tags: - - Dashboards - post: - operationId: PostDashboardsIDMembers - parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The dashboard ID. - in: path - name: dashboardID - 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: Added to dashboard members - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: Add a member to a dashboard - tags: - - Dashboards - /api/v2/dashboards/{dashboardID}/members/{userID}: - delete: - operationId: DeleteDashboardsIDMembersID - parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The ID of the member to remove. - in: path - name: userID - required: true - schema: - type: string - - description: The dashboard ID. - in: path - name: dashboardID - 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 dashboard - tags: - - Dashboards - /api/v2/dashboards/{dashboardID}/owners: - get: - operationId: GetDashboardsIDOwners - parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The dashboard ID. - in: path - name: dashboardID - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceOwners' - description: A list of users who have owner privileges for a dashboard - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: List all dashboard owners - tags: - - Dashboards - post: - operationId: PostDashboardsIDOwners - parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The dashboard ID. - in: path - name: dashboardID - 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: Added to dashboard owners - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: Add an owner to a dashboard - tags: - - Dashboards - /api/v2/dashboards/{dashboardID}/owners/{userID}: - delete: - operationId: DeleteDashboardsIDOwnersID - parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The ID of the owner to remove. - in: path - name: userID - required: true - schema: - type: string - - description: The dashboard ID. - in: path - name: dashboardID - 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 dashboard - tags: - - Dashboards - /api/v2/dbrps: - get: - operationId: GetDBRPs - parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: Specifies the organization ID to filter on - in: query - name: orgID - schema: - type: string - - description: Specifies the organization name to filter on - in: query - name: org - schema: - type: string - - description: Specifies the mapping ID to filter on - in: query - name: id - schema: - type: string - - description: Specifies the bucket ID to filter on - in: query - name: bucketID - schema: - type: string - - description: Specifies filtering on default - in: query - name: default - schema: - type: boolean - - description: Specifies the database to filter on - in: query - name: db - schema: - type: string - - description: Specifies the retention policy to filter on - in: query - name: rp - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/DBRPs' - description: Success. Returns a list of database retention policy mappings. - "400": - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Bad request. The request has one or more invalid parameters. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: List database retention policy mappings - tags: - - DBRPs - post: - operationId: PostDBRP - parameters: - - $ref: '#/components/parameters/TraceSpan' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/DBRPCreate' - description: The database retention policy mapping to add - required: true - responses: - "201": - content: - application/json: - schema: - $ref: '#/components/schemas/DBRP' - description: Created. Returns the created database retention policy mapping. - "400": - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Bad request. The mapping in the request has one or more invalid - IDs. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: Add a database retention policy mapping - tags: - - DBRPs - /api/v2/dbrps/{dbrpID}: - delete: - operationId: DeleteDBRPID - parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: Specifies the organization ID of the mapping - in: query - name: orgID - schema: - type: string - - description: Specifies the organization name of the mapping - in: query - name: org - schema: - type: string - - description: The database retention policy mapping - in: path - name: dbrpID - required: true - schema: - type: string - responses: - "204": - description: Delete has been accepted - "400": - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: if any of the IDs passed is invalid - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: Delete a database retention policy - tags: - - DBRPs - get: - operationId: GetDBRPsID - parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: Specifies the organization ID of the mapping - in: query - name: orgID - schema: - type: string - - description: Specifies the organization name of the mapping - in: query - name: org - schema: - type: string - - description: The database retention policy mapping ID - in: path - name: dbrpID - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/DBRPGet' - description: The database retention policy requested - "400": - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: if any of the IDs passed is invalid - 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: Specifies the organization ID of the mapping - in: query - name: orgID - schema: - type: string - - description: Specifies the organization name of the mapping - in: query - name: org - schema: - type: string - - description: The database retention policy mapping. - in: path - name: dbrpID - required: true - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/DBRPUpdate' - description: Database retention policy update to apply - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/DBRPGet' - description: An updated mapping - "400": - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: if any of the IDs passed is invalid - "404": - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: The mapping was not found - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: Update a database retention policy mapping - tags: - - DBRPs - /api/v2/delete: - post: - operationId: PostDelete - parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: Specifies the organization to delete data from. - in: query - name: org - schema: - description: Only points from this organization are deleted. - type: string - - description: Specifies the bucket to delete data from. - in: query - name: bucket - schema: - description: Only points from this bucket are deleted. - type: string - - description: Specifies the organization ID of the resource. - in: query - name: orgID - schema: - type: string - - description: Specifies the bucket ID to delete data from. - in: query - name: bucketID - schema: - description: Only points from this bucket ID are deleted. - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/DeletePredicateRequest' - description: Deletes data from an InfluxDB bucket. - required: true - responses: - "204": - description: delete has been accepted - "400": - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Invalid request. - "403": - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: no token was sent or does not have sufficient permissions. - "404": - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: the bucket or organization is not found. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: internal server error - summary: Delete data - tags: - - Delete - /api/v2/experimental/sampledata/buckets: - get: - operationId: GetDemoDataBuckets - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/DemoDataBuckets' - description: A list of demo data buckets - default: - $ref: '#/components/responses/ServerError' - description: Unexpected error - summary: List of Demo Data Buckets - tags: - - DemoDataBuckets - /api/v2/experimental/sampledata/buckets/{bucketID}/members: - delete: - operationId: DeleteDemoDataBucketMembers - parameters: - - description: bucket id - in: path - name: bucketID - required: true - schema: - type: string - responses: - "200": - description: if sampledata route is not available gateway responds with - 200 - "204": - description: A list of demo data buckets - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: List of Demo Data Buckets - tags: - - DemoDataBuckets - post: - operationId: GetDemoDataBucketMembers - parameters: - - description: bucket id - in: path - name: bucketID - required: true - schema: - type: string - responses: - "200": - description: if sampledata route is not available gateway responds with - 200 - "204": - description: A list of demo data buckets - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: List of Demo Data Buckets - tags: - - DemoDataBuckets - /api/v2/flags: - get: - operationId: GetFlags - parameters: - - $ref: '#/components/parameters/TraceSpan' - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/Flags' - description: Feature flags for the currently authenticated user - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: Return the feature flags for the currently authenticated user - tags: - - Users - /api/v2/labels: - get: - operationId: GetLabels - parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The organization ID. - in: query - name: orgID - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/LabelsResponse' - description: A list of labels - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: List all labels - tags: - - Labels - post: - operationId: PostLabels - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/LabelCreateRequest' - description: Label to create - required: true - responses: - "201": - content: - application/json: - schema: - $ref: '#/components/schemas/LabelResponse' - description: Added label - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: Create a label - tags: - - Labels - /api/v2/labels/{labelID}: - delete: - operationId: DeleteLabelsID - parameters: - - $ref: '#/components/parameters/TraceSpan' - - 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: Label not found - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: Delete a label - tags: - - Labels - get: - operationId: GetLabelsID - parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The ID of the label to update. - in: path - name: labelID - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/LabelResponse' - description: A label - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: Retrieve a label - tags: - - Labels - patch: - operationId: PatchLabelsID - parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The ID of the label to update. - in: path - name: labelID - required: true - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/LabelUpdate' - description: Label update - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/LabelResponse' - description: Updated label - "404": - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Label not found - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: Update a label - tags: - - Labels - /api/v2/maps/mapToken: - get: - operationId: getMapboxToken - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/Token' - description: A temp token for Mapbox - "401": - $ref: '#/components/responses/ServerError' - "500": - $ref: '#/components/responses/ServerError' - default: - $ref: '#/components/responses/ServerError' - /api/v2/me: - get: - operationId: GetMe - parameters: - - $ref: '#/components/parameters/TraceSpan' - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/UserResponse' - description: The currently authenticated user. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: Retrieve the currently authenticated user - tags: - - Users - /api/v2/me/password: - put: - operationId: PutMePassword - parameters: - - $ref: '#/components/parameters/TraceSpan' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/PasswordResetBody' - description: New password - required: true - responses: - "204": - description: Password successfully updated - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unsuccessful authentication - security: - - BasicAuthentication: [] - summary: Update a password - tags: - - Users - /api/v2/notificationEndpoints: - get: - operationId: GetNotificationEndpoints - parameters: - - $ref: '#/components/parameters/TraceSpan' - - $ref: '#/components/parameters/Offset' - - $ref: '#/components/parameters/Limit' - - description: Only show notification endpoints that belong to specific organization - ID. - in: query - name: orgID - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/NotificationEndpoints' - description: A list of notification endpoints - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: List all notification endpoints - tags: - - NotificationEndpoints - post: - operationId: CreateNotificationEndpoint - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/PostNotificationEndpoint' - description: Notification endpoint to create - required: true - responses: - "201": - content: - application/json: - schema: - $ref: '#/components/schemas/NotificationEndpoint' - description: Notification endpoint created - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: Add a notification endpoint - tags: - - NotificationEndpoints - /api/v2/notificationEndpoints/{endpointID}: - delete: - operationId: DeleteNotificationEndpointsID - parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The notification endpoint ID. - in: path - name: endpointID - required: true - schema: - type: string - responses: - "204": - description: Delete has been accepted - "404": - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: The endpoint was not found - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: Delete a notification endpoint - tags: - - NotificationEndpoints - get: - operationId: GetNotificationEndpointsID - parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The notification endpoint ID. - in: path - name: endpointID - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/NotificationEndpoint' - description: The notification endpoint requested - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: Retrieve a notification endpoint - tags: - - NotificationEndpoints - patch: - operationId: PatchNotificationEndpointsID - parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The notification endpoint ID. - in: path - name: endpointID - required: true - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/NotificationEndpointUpdate' - description: Check update to apply - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/NotificationEndpoint' - description: An updated notification endpoint - "404": - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: The notification endpoint was not found - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: Update a notification endpoint - tags: - - NotificationEndpoints - put: - operationId: PutNotificationEndpointsID - parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The notification endpoint ID. - in: path - name: endpointID - required: true - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/NotificationEndpoint' - description: A new notification endpoint to replace the existing endpoint - with - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/NotificationEndpoint' - description: An updated notification endpoint - "404": - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: The notification endpoint was not found - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: Update a notification endpoint - tags: - - NotificationEndpoints - /api/v2/notificationEndpoints/{endpointID}/labels: - get: - operationId: GetNotificationEndpointsIDLabels - parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The notification endpoint ID. - in: path - name: endpointID - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/LabelsResponse' - description: A list of all labels for a notification endpoint - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: List all labels for a notification endpoint - tags: - - NotificationEndpoints - post: - operationId: PostNotificationEndpointIDLabels - parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The notification endpoint ID. - in: path - name: endpointID - 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 was added to the notification endpoint - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: Add a label to a notification endpoint - tags: - - NotificationEndpoints - /api/v2/notificationEndpoints/{endpointID}/labels/{labelID}: - delete: - operationId: DeleteNotificationEndpointsIDLabelsID - parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The notification endpoint ID. - in: path - name: endpointID - 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: Endpoint or label not found - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: Delete a label from a notification endpoint - tags: - - NotificationEndpoints - /api/v2/notificationRules: - get: - operationId: GetNotificationRules - parameters: - - $ref: '#/components/parameters/TraceSpan' - - $ref: '#/components/parameters/Offset' - - $ref: '#/components/parameters/Limit' - - description: Only show notification rules that belong to a specific organization - ID. - in: query - name: orgID - required: true - schema: - type: string - - description: Only show notifications that belong to the specific check ID. - in: query - name: checkID - schema: - type: string - - description: Only return notification rules that "would match" statuses which - contain the tag key value pairs provided. - in: query - name: tag - schema: - example: env:prod - pattern: ^[a-zA-Z0-9_]+:[a-zA-Z0-9_]+$ - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/NotificationRules' - description: A list of notification rules - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: List all notification rules - tags: - - NotificationRules - post: - operationId: CreateNotificationRule - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/PostNotificationRule' - description: Notification rule to create - required: true - responses: - "201": - content: - application/json: - schema: - $ref: '#/components/schemas/NotificationRule' - description: Notification rule created - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: Add a notification rule - tags: - - NotificationRules - /api/v2/notificationRules/{ruleID}: - delete: - operationId: DeleteNotificationRulesID - parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The notification rule ID. - in: path - name: ruleID - required: true - schema: - type: string - responses: - "204": - description: Delete has been accepted - "404": - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: The check was not found - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: Delete a notification rule - tags: - - NotificationRules - get: - operationId: GetNotificationRulesID - parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The notification rule ID. - in: path - name: ruleID - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/NotificationRule' - description: The notification rule requested - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: Retrieve a notification rule - tags: - - NotificationRules - patch: - operationId: PatchNotificationRulesID - parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The notification rule ID. - in: path - name: ruleID - required: true - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/NotificationRuleUpdate' - description: Notification rule update to apply - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/NotificationRule' - description: An updated notification rule - "404": - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: The notification rule was not found - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: Update a notification rule - tags: - - NotificationRules - put: - operationId: PutNotificationRulesID - parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The notification rule ID. - in: path - name: ruleID - required: true - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/NotificationRule' - description: Notification rule update to apply - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/NotificationRule' - description: An updated notification rule - "404": - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: The notification rule was not found - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: Update a notification rule - tags: - - NotificationRules - /api/v2/notificationRules/{ruleID}/labels: - get: - operationId: GetNotificationRulesIDLabels - parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The notification rule ID. - in: path - name: ruleID - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/LabelsResponse' - description: A list of all labels for a notification rule - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: List all labels for a notification rule - tags: - - NotificationRules - post: - operationId: PostNotificationRuleIDLabels - parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The notification rule ID. - in: path - name: ruleID - 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 was added to the notification rule - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: Add a label to a notification rule - tags: - - NotificationRules - /api/v2/notificationRules/{ruleID}/labels/{labelID}: - delete: - operationId: DeleteNotificationRulesIDLabelsID - parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The notification rule ID. - in: path - name: ruleID - 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: Rule or label not found - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: Delete label from a notification rule - tags: - - NotificationRules - /api/v2/notificationRules/{ruleID}/query: - get: - operationId: GetNotificationRulesIDQuery - parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The notification rule ID. - in: path - name: ruleID - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/FluxResponse' - description: The notification rule query requested - "400": - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Invalid request - "404": - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Notification rule not found - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: Retrieve a notification rule query - tags: - - Rules - /api/v2/orgs: - get: - operationId: GetOrgs - parameters: - - $ref: '#/components/parameters/TraceSpan' - - $ref: '#/components/parameters/Offset' - - $ref: '#/components/parameters/Limit' - - $ref: '#/components/parameters/Descending' - - description: Filter organizations to a specific organization name. - in: query - name: org - schema: - type: string - - description: Filter organizations to a specific organization ID. - in: query - name: orgID - schema: - type: string - - description: Filter organizations to a specific user ID. - in: query - name: userID - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/Organizations' - description: A list of organizations - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: List all organizations - tags: - - Organizations - post: - operationId: PostOrgs - parameters: - - $ref: '#/components/parameters/TraceSpan' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/PostOrganizationRequest' - description: Organization to create - required: true - responses: - "201": - content: - application/json: - schema: - $ref: '#/components/schemas/Organization' - description: Organization created - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: Create an organization - tags: - - Organizations - /api/v2/orgs/{orgID}: - delete: - 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: Delete has been accepted - "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: Delete an organization - tags: - - Organizations - get: - operationId: GetOrgsID - parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The ID of the organization to get. - in: path - name: orgID - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/Organization' - description: Organization details - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: Retrieve an organization - tags: - - Organizations - patch: - operationId: PatchOrgsID - parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The ID of the organization to get. - in: path - name: orgID - required: true - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/PatchOrganizationRequest' - description: Organization update to apply - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/Organization' - description: Organization updated - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: Update an organization - tags: - - Organizations - /api/v2/orgs/{orgID}/limits: - get: - parameters: - - description: The identifier 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: The Limits defined for the organization. - default: - $ref: '#/components/responses/ServerError' - description: unexpected error - summary: Retrieve limits for an organization - tags: - - Limits - /api/v2/orgs/{orgID}/members: - get: - operationId: GetOrgsIDMembers - 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/ResourceMembers' - description: A list of organization members - "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 members of an organization - tags: - - Organizations - post: - operationId: PostOrgsIDMembers - 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/AddResourceMemberRequestBody' - description: User to add as member - required: true - responses: - "201": - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceMember' - description: Added to organization created - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: Add a member to an organization - tags: - - Organizations - /api/v2/orgs/{orgID}/members/{userID}: - delete: - operationId: DeleteOrgsIDMembersID - parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The ID of the member to remove. - in: path - name: userID - required: true - schema: - type: string - - description: The organization ID. - in: path - name: orgID - 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 an organization - tags: - - Organizations - /api/v2/orgs/{orgID}/owners: - get: - operationId: GetOrgsIDOwners - 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/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: - operationId: PostOrgsIDOwners - 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/AddResourceMemberRequestBody' - description: User to add as owner - required: true - responses: - "201": - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceOwner' - description: Organization owner added - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: Add an owner to an organization - tags: - - Organizations - /api/v2/orgs/{orgID}/owners/{userID}: - delete: - operationId: DeleteOrgsIDOwnersID - parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The ID of the owner to remove. - in: path - name: userID - required: true - schema: - type: string - - description: The organization ID. - in: path - name: orgID - 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 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/ServerError' - 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: - parameters: - - description: The identifier of the organization. - in: path - name: orgID - required: true - schema: - type: string - - description: start time - in: query - name: start - required: true - schema: - type: timestamp - - description: stop time - in: query - name: stop - required: false - schema: - type: timestamp - - 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: The Content-Encoding entity header is used to compress - the media-type. When present, its value indicates which encodings - were applied to the entity-body - schema: - default: identity - description: Specifies that the response in the body is encoded with - gzip or not encoded with identity. - enum: - - gzip - - identity - type: string - default: - $ref: '#/components/responses/ServerError' - description: unexpected error - summary: Retrieve usage for an organization - tags: - - Usage - /ping: - get: - operationId: GetPing - responses: - "204": - description: OK - headers: - X-Influxdb-Build: - description: The type of InfluxDB build. - schema: - type: string - X-Influxdb-Version: - description: The version of InfluxDB. - schema: - type: integer - servers: - - url: "" - summary: Checks the status of InfluxDB instance and version of InfluxDB. - tags: - - Ping - head: - operationId: HeadPing - responses: - "204": - description: OK - headers: - X-Influxdb-Build: - description: The type of InfluxDB build. - schema: - type: string - X-Influxdb-Version: - description: The version of InfluxDB. - schema: - type: integer - servers: - - url: "" - summary: Checks the status of InfluxDB instance and version of InfluxDB. - tags: - - Ping - /api/v2/query: - post: - description: | - Retrieves data from InfluxDB buckets. - - To query data, you need the following: - - **organization** – _See [View organizations](https://docs.influxdata.com/influxdb/cloud/organizations/view-orgs/#view-your-organization-id) for instructions on viewing your organization ID._ - - **API token** – _See [View tokens](https://docs.influxdata.com/influxdb/cloud/security/tokens/view-tokens/) - for instructions on viewing your API token._ - - **InfluxDB URL** – _See [InfluxDB URLs](https://docs.influxdata.com/influxdb/cloud/reference/urls/)_. - - **Flux query** – _See [Flux](https://docs.influxdata.com/flux/v0.x/)._ - - For more information and examples, see [Query with the InfluxDB API](https://docs.influxdata.com/influxdb/cloud/query-data/execute-queries/influx-api/). - operationId: PostQuery - parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The Accept-Encoding request HTTP header advertises which content - encoding, usually a compression algorithm, the client is able to understand. - in: header - name: Accept-Encoding - schema: - default: identity - description: Specifies that the query response in the body should be encoded - with gzip or not encoded with identity. - enum: - - gzip - - identity - type: string - - in: header - name: Content-Type - schema: - enum: - - application/json - - application/vnd.flux - type: string - - description: Specifies the name of the organization executing the query. Takes - either the ID or Name. If both `orgID` and `org` are specified, `org` takes - precedence. - in: query - name: org - schema: - type: string - - description: Specifies the ID of the organization executing the query. If - both `orgID` and `org` are specified, `org` takes precedence. - in: query - name: orgID - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Query' - application/vnd.flux: - schema: - type: string - example: | - from(bucket: "example-bucket") - |> range(start: -5m) - |> filter(fn: (r) => r._measurement == "example-measurement") - description: Flux query or specification to execute - responses: - "200": - content: - application/vnd.influx.arrow: - schema: - format: binary - type: string - text/csv: - schema: - example: | - result,table,_start,_stop,_time,region,host,_value mean,0,2018-05-08T20:50:00Z,2018-05-08T20:51:00Z,2018-05-08T20:50:00Z,east,A,15.43 mean,0,2018-05-08T20:50:00Z,2018-05-08T20:51:00Z,2018-05-08T20:50:20Z,east,B,59.25 mean,0,2018-05-08T20:50:00Z,2018-05-08T20:51:00Z,2018-05-08T20:50:40Z,east,C,52.62 - type: string - description: Success. Returns query results. - headers: - Content-Encoding: - description: The Content-Encoding entity header is used to compress - the media-type. When present, its value indicates which encodings - were applied to the entity-body - schema: - default: identity - description: Specifies that the response in the body is encoded with - gzip or not encoded with identity. - enum: - - gzip - - identity - type: string - Trace-Id: - description: The Trace-Id header reports the request's trace ID, if - one was generated. - schema: - description: Specifies the request's trace ID. - type: string - "429": - description: Token is temporarily over quota. The Retry-After header describes - when to try the read 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 data - tags: - - Query - /api/v2/query/analyze: - post: - 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: - schema: - $ref: '#/components/schemas/AnalyzeQueryResponse' - description: Query analyze results. Errors will be empty if the query is - valid. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Internal server error - headers: - X-Influx-Error: - description: Error string describing the problem - schema: - type: string - X-Influx-Reference: - description: Reference code unique to the error type - schema: - type: integer - summary: Analyze a Flux query - tags: - - Query - /api/v2/query/ast: - post: - description: Analyzes flux query and generates a query specification. - 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: Analyzed Flux query to generate abstract syntax tree. - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/ASTResponse' - description: Abstract syntax tree of the flux query. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Any response other than 200 is an internal server error - summary: Generate an Abstract Syntax Tree (AST) from a query - tags: - - Query - /api/v2/query/suggestions: - get: - operationId: GetQuerySuggestions - parameters: - - $ref: '#/components/parameters/TraceSpan' - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/FluxSuggestions' - description: Suggestions for next functions in call chain - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Any response other than 200 is an internal server error - summary: Retrieve query suggestions - tags: - - Query - /api/v2/query/suggestions/{name}: - get: - operationId: GetQuerySuggestionsName - parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The name of the branching suggestion. - in: path - name: name - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/FluxSuggestion' - description: Suggestions for next functions in call chain - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Any response other than 200 is an internal server error - summary: Retrieve query suggestions 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 - /api/v2/scripts: - get: - operationId: GetScripts - parameters: - - description: The number of scripts to return. - in: query - name: limit - required: false - schema: - type: integer - - description: The offset for pagination. - in: query - name: offset - required: false - schema: - type: integer - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/Scripts' - description: The list of scripts. - default: - $ref: '#/components/responses/ServerError' - description: Unexpected error - summary: List scripts - tags: - - Invocable Scripts - post: - operationId: PostScripts - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ScriptCreateRequest' - description: The script to create. - required: true - responses: - "201": - content: - application/json: - schema: - $ref: '#/components/schemas/Script' - description: The created script. - default: - $ref: '#/components/responses/ServerError' - description: Unexpected error - summary: Create a script - tags: - - Invocable Scripts - /api/v2/scripts/{scriptID}: - delete: - description: Deletes a script and all associated records. - operationId: DeleteScriptsID - parameters: - - description: The ID of the script to delete. - in: path - name: scriptID - required: true - schema: - type: string - responses: - "204": - description: The script is deleted. - default: - $ref: '#/components/responses/ServerError' - description: Unexpected error - summary: Delete a script - tags: - - Invocable Scripts - get: - description: Uses script ID to retrieve details of an invocable script. - operationId: GetScriptsID - parameters: - - description: The script ID. - in: path - name: scriptID - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/Script' - description: The requested script object. - default: - $ref: '#/components/responses/ServerError' - description: Unexpected error - summary: Retrieve a script - tags: - - Invocable Scripts - patch: - description: | - Updates properties (`name`, `description`, and `script`) of an invocable script. - operationId: PatchScriptsID - parameters: - - description: The script ID. - in: path - name: scriptID - required: true - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ScriptUpdateRequest' - description: Script update to apply - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/Script' - description: The updated script. - default: - $ref: '#/components/responses/ServerError' - description: Unexpected error - summary: Update a script - tags: - - Invocable Scripts - /api/v2/scripts/{scriptID}/invoke: - post: - description: Invokes a script and substitutes `params` keys referenced in the - script with `params` key-values sent in the request body. - operationId: PostScriptsIDInvoke - parameters: - - in: path - name: scriptID - required: true - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ScriptInvocationParams' - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/ScriptHTTPResponseData' - description: The result of the script execution. - default: - $ref: '#/components/responses/ServerError' - description: Unexpected error - summary: Invoke a script - tags: - - Invocable Scripts - /api/v2/setup: - get: - description: Check if setup is allowed. Returns `true` if no default user, organization, - or bucket have been created. - operationId: GetSetup - parameters: - - $ref: '#/components/parameters/TraceSpan' - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/IsOnboarding' - description: Setup is allowed, true or false - summary: Retrieve setup status - tags: - - Setup - post: - description: Post an onboarding request to create an initial user, organization, - and bucket. - operationId: PostSetup - parameters: - - $ref: '#/components/parameters/TraceSpan' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/OnboardingRequest' - description: Source to create - required: true - responses: - "201": - content: - application/json: - schema: - $ref: '#/components/schemas/OnboardingResponse' - description: The created default user, bucket, and organization - default: - $ref: '#/components/responses/ServerError' - description: Unexpected error - summary: Create an initial user, organization, and bucket - tags: - - Setup - /api/v2/setup/user: - post: - description: Post an onboarding request to create a new user, organization, - and bucket. - operationId: PostSetupUser - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/OnboardingRequest' - description: Source to create - required: true - responses: - "201": - content: - application/json: - schema: - $ref: '#/components/schemas/OnboardingResponse' - description: The created default user, bucket, and organization. - default: - $ref: '#/components/responses/ServerError' - description: Unexpected error - summary: Create a new user, organization, and bucket - tags: - - Setup - /api/v2/signin: - post: - description: Authenticates ***Basic Auth*** credentials for a user. If successful, - creates a new UI session for the user. - operationId: PostSignin - parameters: - - $ref: '#/components/parameters/TraceSpan' - responses: - "204": - description: Success. User authenticated. - "401": - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unauthorized access. - "403": - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: User account is disabled. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unsuccessful authentication. - security: - - BasicAuthentication: [] - summary: Create a user session. - tags: - - Signin - /api/v2/signout: - post: - description: Expires the current UI session for the user. - operationId: PostSignout - parameters: - - $ref: '#/components/parameters/TraceSpan' - responses: - "204": - description: Session successfully expired - "401": - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unauthorized access - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unsuccessful session expiry - summary: Expire the current UI session - tags: - - Signout - /api/v2/stacks: - get: - operationId: ListStacks - parameters: - - description: The organization ID of the stacks - in: query - name: orgID - required: true - schema: - type: string - - description: A collection of names to filter the list by. - in: query - name: name - schema: - type: string - - description: A collection of stackIDs to filter the list by. - 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. Returns the list of stacks. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: List installed templates - tags: - - Templates - post: - 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. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: Create a new 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: - operationId: GetTasks - parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: Returns task with a specific name. - in: query - name: name - schema: - type: string - - description: Return tasks after a specified ID. - in: query - name: after - schema: - type: string - - description: Filter tasks to a specific user ID. - in: query - name: user - schema: - type: string - - description: Filter tasks to a specific organization name. - in: query - name: org - schema: - type: string - - description: Filter tasks to a specific organization ID. - in: query - name: orgID - schema: - type: string - - description: Filter tasks by a status--"inactive" or "active". - in: query - name: status - schema: - enum: - - active - - inactive - type: string - - description: The non-zero number of tasks to return - in: query - name: limit - schema: - default: 100 - maximum: 500 - minimum: -1 - type: integer - - description: Type of task, unset by default. - in: query - name: type - required: false - schema: - default: "" - enum: - - basic - - system - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/Tasks' - description: A list of tasks - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: List all tasks - tags: - - Tasks - post: - operationId: PostTasks - parameters: - - $ref: '#/components/parameters/TraceSpan' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/TaskCreateRequest' - description: Task to create - required: true - responses: - "201": - content: - application/json: - schema: - $ref: '#/components/schemas/Task' - description: Task created - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: Create a new task - tags: - - Tasks - /api/v2/tasks/{taskID}: - delete: - description: Deletes a task and all associated records - operationId: DeleteTasksID - parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The ID of the task to delete. - in: path - name: taskID - required: true - schema: - type: string - responses: - "204": - description: Task deleted - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: Delete a task - tags: - - Tasks - get: - operationId: GetTasksID - 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/Task' - description: Task details - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: Retrieve a task - tags: - - Tasks - patch: - description: Update a task. This will cancel all queued runs. - operationId: PatchTasksID - 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/TaskUpdateRequest' - description: Task update to apply - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/Task' - description: Task updated - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: Update a task - tags: - - Tasks - /api/v2/tasks/{taskID}/labels: - get: - operationId: GetTasksIDLabels - 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/LabelsResponse' - description: A list of all labels for a task - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: List all labels for a task - tags: - - Tasks - post: - operationId: PostTasksIDLabels - 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/LabelMapping' - description: Label to add - required: true - responses: - "201": - content: - application/json: - schema: - $ref: '#/components/schemas/LabelResponse' - description: A list of all labels for a task - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: Add a label to a task - tags: - - Tasks - /api/v2/tasks/{taskID}/labels/{labelID}: - delete: - operationId: DeleteTasksIDLabelsID - parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The task ID. - in: path - name: taskID - 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: Task not found - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: Delete a label from a task - tags: - - Tasks - /api/v2/tasks/{taskID}/logs: - get: - 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: - schema: - $ref: '#/components/schemas/Logs' - description: All logs for a task - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: Retrieve all logs for a task - tags: - - Tasks - /api/v2/tasks/{taskID}/members: - get: - 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: A list of users who have member privileges for a task - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: List all task members - tags: - - Tasks - post: - 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: User to add as member - required: true - responses: - "201": - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceMember' - description: 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: - 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: - operationId: GetTasksIDOwners - 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/ResourceOwners' - description: A list of users who have owner privileges for a task - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: List all owners of a task - tags: - - Tasks - post: - 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: User to add as owner - required: true - responses: - "201": - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceOwner' - description: Added to task owners - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: Add an owner to a task - tags: - - Tasks - /api/v2/tasks/{taskID}/owners/{userID}: - delete: - 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: - operationId: GetTasksIDRuns - parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The ID of the task to get runs for. - in: path - name: taskID - required: true - schema: - type: string - - description: Returns runs after a specific ID. - in: query - name: after - schema: - type: string - - description: The number of runs to return - in: query - name: limit - schema: - default: 100 - maximum: 500 - minimum: 1 - type: integer - - description: Filter runs to those scheduled after this time, RFC3339 - in: query - name: afterTime - schema: - format: date-time - type: string - - description: Filter runs to those scheduled before this time, RFC3339 - in: query - name: beforeTime - schema: - format: date-time - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/Runs' - description: A list of task runs - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: List runs for a task - tags: - - Tasks - post: - 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: Run scheduled to start - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: Manually start a task run, overriding the current schedule - tags: - - Tasks - /api/v2/tasks/{taskID}/runs/{runID}: - delete: - operationId: DeleteTasksIDRunsID - parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The task ID. - in: path - name: taskID - required: true - schema: - type: string - - description: The run ID. - in: path - name: runID - 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: Cancel a running task - tags: - - Tasks - get: - operationId: GetTasksIDRunsID - parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The task ID. - in: path - name: taskID - required: true - schema: - type: string - - description: The run ID. - in: path - name: runID - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/Run' - description: The run record - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: Retrieve a single run for a task - tags: - - Tasks - /api/v2/tasks/{taskID}/runs/{runID}/logs: - get: - operationId: GetTasksIDRunsIDLogs - parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: ID of task to get logs for. - in: path - name: taskID - required: true - schema: - type: string - - description: ID of run to get logs for. - in: path - name: runID - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/Logs' - description: All logs for a run - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: Retrieve all logs for a run - tags: - - Tasks - /api/v2/tasks/{taskID}/runs/{runID}/retry: - post: - operationId: PostTasksIDRunsIDRetry - parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The task ID. - in: path - name: taskID - required: true - schema: - type: string - - description: The run ID. - in: path - name: runID - required: true - schema: - type: string - requestBody: - content: - application/json; charset=utf-8: - schema: - type: object - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/Run' - description: Run that has been queued - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: Retry a task run - tags: - - Tasks - /api/v2/telegraf/plugins: - get: - operationId: GetTelegrafPlugins - parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The type of plugin desired. - in: query - name: type - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/TelegrafPlugins' - description: A list of Telegraf plugins. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: List all Telegraf plugins - tags: - - 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/TelegrafRequest' - 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/TelegrafRequest' - 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 or performs a dry-run of template in an organization. - operationId: ApplyTemplate - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/TemplateApply' - application/x-jsonnet: - schema: - $ref: '#/components/schemas/TemplateApply' - text/yml: - schema: - $ref: '#/components/schemas/TemplateApply' - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/TemplateSummary' - description: | - Success. The package dry-run succeeded. No new resources were created. Returns a diff and summary of the dry-run. 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 package applied successfully. Returns a diff and summary of the run. The summary contains newly created resources. The diff compares the initial state to the state after the package applied. This corresponds to `"dryRun": true`. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unexpected error - summary: Apply or dry-run a template - tags: - - Templates - /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: - get: - operationId: GetUsers - parameters: - - $ref: '#/components/parameters/TraceSpan' - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/Users' - description: A list of users - default: - $ref: '#/components/responses/ServerError' - description: Unexpected error - summary: List all users - tags: - - Users - post: - operationId: PostUsers - parameters: - - $ref: '#/components/parameters/TraceSpan' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/User' - description: User to create - required: true - responses: - "201": - content: - application/json: - schema: - $ref: '#/components/schemas/UserResponse' - description: User created - default: - $ref: '#/components/responses/ServerError' - description: Unexpected error - summary: Create a user - tags: - - Users - /api/v2/users/{userID}: - delete: - operationId: DeleteUsersID - parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The ID of the user to delete. - in: path - name: userID - required: true - schema: - type: string - responses: - "204": - description: User deleted - default: - $ref: '#/components/responses/ServerError' - description: Unexpected error - summary: Delete a user - tags: - - Users - get: - operationId: GetUsersID - parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The user ID. - in: path - name: userID - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/UserResponse' - description: User details - default: - $ref: '#/components/responses/ServerError' - description: Unexpected error - summary: Retrieve a user - tags: - - Users - patch: - operationId: PatchUsersID - parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The ID of the user to update. - in: path - name: userID - required: true - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/User' - description: User update to apply - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/UserResponse' - description: User updated - default: - $ref: '#/components/responses/ServerError' - description: Unexpected error - summary: Update a user - tags: - - Users - /api/v2/users/{userID}/password: - post: - operationId: PostUsersIDPassword - parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The user ID. - in: path - name: userID - required: true - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/PasswordResetBody' - description: New password - required: true - responses: - "204": - description: Password successfully updated - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unsuccessful authentication - security: - - BasicAuthentication: [] - summary: Update a password - tags: - - Users - /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/ServerError' - description: Invalid request - default: - $ref: '#/components/responses/ServerError' - 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/ServerError' - 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/ServerError' - 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/ServerError' - description: Variable not found - default: - $ref: '#/components/responses/ServerError' - 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/ServerError' - 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/ServerError' - 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. - - To write data into InfluxDB, you need the following: - - - **organization name or ID** – _See [View organizations](https://docs.influxdata.com/influxdb/cloud/organizations/view-orgs/#view-your-organization-id) for instructions on viewing your organization ID._ - - **bucket** – _See [View buckets](https://docs.influxdata.com/influxdb/cloud/organizations/buckets/view-buckets/) for - instructions on viewing your bucket ID._ - - **API token** – _See [View tokens](https://docs.influxdata.com/influxdb/cloud/security/tokens/view-tokens/) - for instructions on viewing your API token._ - - **InfluxDB URL** – _See [InfluxDB URLs](https://docs.influxdata.com/influxdb/cloud/reference/urls/)_. - - data in [line protocol](https://docs.influxdata.com/influxdb/cloud/reference/syntax/line-protocol) format. - - For more information and examples, see [Write data with the InfluxDB API](https://docs.influxdata.com/influxdb/cloud/write-data/developer-tools/api). - operationId: PostWrite - parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: When present, the header value tells the database that compression - is applied to the line protocol in the request body. - in: header - name: Content-Encoding - schema: - default: identity - description: The header value specifies that the line protocol in the request - body is encoded with gzip or not encoded with identity. - enum: - - gzip - - identity - type: string - - description: The header value indicates the format of the data in the request - body. - in: header - name: Content-Type - schema: - default: text/plain; charset=utf-8 - description: | - `text/plain` specifies line protocol. `UTF-8` is the default character set. - enum: - - text/plain - - text/plain; charset=utf-8 - - application/vnd.influx.arrow - type: string - - description: The header value indicates the size of the entity-body, in bytes, - sent to the database. If the length is greater than the database's `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 header value specifies the response format. - in: header - name: Accept - schema: - default: application/json - description: The response format for errors. - enum: - - application/json - type: string - - description: The parameter value specifies the destination organization for - writes. The database writes all points in the batch to this organization. - If you provide both `orgID` and `org` parameters, `org` takes precedence. - in: query - name: org - required: true - schema: - description: Organization name or ID. - type: string - - description: The parameter value specifies the ID of the destination organization - for writes. If both `orgID` and `org` are specified, `org` takes precedence. - in: query - name: orgID - schema: - type: string - - description: The destination bucket for writes. - in: query - name: bucket - required: true - schema: - description: All points within batch are written to this bucket. - type: string - - description: The precision for the unix timestamps within the body line-protocol. - in: query - name: precision - schema: - $ref: '#/components/schemas/WritePrecision' - requestBody: - content: - text/plain: - schema: - format: byte - type: string - description: Data in line protocol format. - required: true - responses: - "204": - description: InfluxDB validated the request data format and accepted the - data for writing to the bucket. `204` doesn't indicate a successful write - operation since writes are asynchronous. See [how to check for write errors](https://docs.influxdata.com/influxdb/cloud/write-data/troubleshoot). - "400": - content: - application/json: - examples: - measurementSchemaFieldTypeConflict: - summary: Field type conflict thrown by an explicit bucket schema - value: - code: invalid - message: 'partial write error (2 written): unable to parse ''air_sensor,service=S1,sensor=L1 - temperature="90.5",humidity=70.0 1632850122'': schema: field - type for field "temperature" not permitted by schema; got String - but expected Float' - schema: - $ref: '#/components/schemas/LineProtocolError' - description: Bad request. The line protocol data in the request is malformed. - The response body contains the first malformed line in the data. InfluxDB - rejected the batch and did not write any data. - "401": - content: - application/json: - examples: - tokenNotAuthorized: - summary: Token is not authorized to access the organization or resource - value: - code: unauthorized - message: unauthorized access - schema: - $ref: '#/components/schemas/Error' - 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 does not have sufficient permissions to write to this organization and bucket. - "404": - content: - application/json: - examples: - resource-not-found: - summary: Not found error - value: - code: not found - message: bucket "air_sensor" not found - schema: - $ref: '#/components/schemas/Error' - description: Not found. A requested resource was not found. The response - body contains the requested resource type, e.g. `organization name` or - `bucket`, and name. - "413": - content: - text/html: - examples: - dataExceedsSizeLimit: - summary: Cloud response - value: | - - 413 Request Entity Too Large - -

    413 Request Entity Too Large

    -
    -
    nginx
    - - - schema: - type: string - description: Request entity too large. The payload exceeded the 50MB size - limit. InfluxDB rejected the batch and did not write any data. - "429": - description: The 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 - "500": - content: - application/json: - examples: - internalError: - summary: Internal error example - value: - code: internal error - schema: - $ref: '#/components/schemas/Error' - description: Internal server error. - "503": - description: The 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: - $ref: '#/components/responses/ServerError' - summary: Write data - tags: - - Write components: parameters: After: - description: | - The last resource ID from which to seek from (but not including). This is to be used instead of `offset`. + description: > + The last resource ID from which to seek from (but not including). This + is to be used instead of `offset`. in: query name: after required: false schema: type: string - AnnotationDeleteFilter: - description: Annotations to delete - in: query - name: AnnotationDeleteFilter - required: true - schema: - $ref: '#/components/schemas/AnnotationDeleteFilter' - AnnotationListFilter: - description: Filter for returned annotations - in: query - name: AnnotationListFilter - required: false - schema: - $ref: '#/components/schemas/AnnotationListFilter' Descending: in: query name: descending @@ -6436,32 +38,25 @@ components: required: false schema: type: string - StreamDeleteFilter: - description: Stream to delete - in: query - name: StreamDeleteFilter - required: true - schema: - $ref: '#/components/schemas/StreamDeleteFilter' - StreamListFilter: - description: Filter for returned streams - in: query - name: StreamListFilter - required: false - schema: - $ref: '#/components/schemas/StreamListFilter' TraceSpan: description: OpenTracing span context example: baggage: key: value - span_id: "1" - trace_id: "1" + span_id: '1' + trace_id: '1' in: header name: Zap-Trace-Span required: false schema: type: string + responses: + 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 @@ -6476,7 +71,7 @@ components: name: type: string required: - - id + - id type: object AnalyzeQueryResponse: properties: @@ -6494,111 +89,6 @@ components: type: object type: array type: object - Annotation: - properties: - endTime: - format: date-time - type: string - message: - type: string - startTime: - format: date-time - type: string - stickers: - additionalProperties: - type: string - type: object - summary: - type: string - type: object - AnnotationCreate: - allOf: - - $ref: '#/components/schemas/Annotation' - - properties: - stream: - type: string - type: object - AnnotationCreateList: - items: - $ref: '#/components/schemas/AnnotationCreate' - type: array - AnnotationDeleteFilter: - properties: - endTime: - format: date-time - type: string - startTime: - format: date-time - type: string - stickers: - additionalProperties: - type: string - type: object - stream: - type: string - streamID: - type: string - required: - - stream - - startTime - - endTime - type: object - AnnotationEvent: - allOf: - - $ref: '#/components/schemas/Annotation' - - properties: - id: - type: string - stream: - type: string - type: object - AnnotationEventList: - items: - $ref: '#/components/schemas/AnnotationEvent' - type: array - AnnotationList: - items: - properties: - annotations: - items: - $ref: '#/components/schemas/AnnotationResponse' - type: array - stream: - type: string - type: object - type: array - AnnotationListFilter: - allOf: - - $ref: '#/components/schemas/BasicFilter' - - properties: - stickerIncludes: - additionalProperties: - type: string - type: object - streamIncludes: - items: - type: string - type: array - type: object - AnnotationResponse: - properties: - endTime: - format: date-time - type: string - id: - type: string - message: - type: string - startTime: - format: date-time - type: string - stickers: - additionalProperties: - type: string - type: object - summary: - type: string - type: object ArrayExpression: description: Used to create and directly specify the elements of an array object properties: @@ -6612,63 +102,65 @@ components: type: object Authorization: allOf: - - $ref: '#/components/schemas/AuthorizationUpdateRequest' - - properties: - createdAt: - format: date-time - readOnly: true - type: string - 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: Name of the org token is scoped to. - readOnly: true - type: string - orgID: - description: ID of org that authorization is scoped to. - type: string - permissions: - description: List of permissions for an auth. An auth must have at least - one Permission. - items: - $ref: '#/components/schemas/Permission' - minItems: 1 - type: array - token: - description: Passed via the Authorization Header and Token Authentication - type. - readOnly: true - type: string - updatedAt: - format: date-time - readOnly: true - type: string - user: - description: Name of user that created and owns the token. - readOnly: true - type: string - userID: - description: ID of user that created and owns the token. - readOnly: true - type: string - type: object + - $ref: '#/components/schemas/AuthorizationUpdateRequest' + - properties: + createdAt: + format: date-time + readOnly: true + type: string + 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: Name of the org token is scoped to. + readOnly: true + type: string + orgID: + description: ID of org that authorization is scoped to. + type: string + permissions: + description: >- + List of permissions for an auth. An auth must have at least one + Permission. + items: + $ref: '#/components/schemas/Permission' + minItems: 1 + type: array + token: + description: >- + Passed via the Authorization Header and Token Authentication + type. + readOnly: true + type: string + updatedAt: + format: date-time + readOnly: true + type: string + user: + description: Name of user that created and owns the token. + readOnly: true + type: string + userID: + description: ID of user that created and owns the token. + readOnly: true + type: string + type: object required: - - orgID - - permissions + - orgID + - permissions AuthorizationUpdateRequest: properties: description: @@ -6676,11 +168,12 @@ components: type: string status: default: active - description: If inactive the token is inactive and requests using the token - will be rejected. + description: >- + If inactive the token is inactive and requests using the token will + be rejected. enum: - - active - - inactive + - active + - inactive type: string Authorizations: properties: @@ -6697,11 +190,11 @@ components: properties: x: $ref: '#/components/schemas/Axis' - "y": + 'y': $ref: '#/components/schemas/Axis' required: - - x - - "y" + - x + - 'y' type: object Axis: description: The description of a particular axis for a visualization. @@ -6709,13 +202,14 @@ components: base: description: Base represents the radix for formatting axis values. enum: - - "" - - "2" - - "10" + - '' + - '2' + - '10' type: string bounds: - description: The extents of an axis in the form [lower, upper]. Clients - determine whether bounds are to be inclusive or exclusive of their limits + description: >- + The extents of an axis in the form [lower, upper]. Clients determine + whether bounds are to be inclusive or exclusive of their limits items: type: string maxItems: 2 @@ -6736,12 +230,13 @@ components: AxisScale: description: 'Scale is the axis formatting scale. Supported: "log", "linear"' enum: - - log - - linear + - log + - linear type: string BadStatement: - description: A placeholder for statements for which no correct statement nodes - can be created + description: >- + A placeholder for statements for which no correct statement nodes can be + created properties: text: description: Raw source text @@ -6770,10 +265,10 @@ components: $ref: '#/components/schemas/XYGeom' hoverDimension: enum: - - auto - - x - - "y" - - xy + - auto + - x + - 'y' + - xy type: string legendColorizeRows: type: boolean @@ -6796,7 +291,7 @@ components: type: array shape: enum: - - chronograf-v2 + - chronograf-v2 type: string showNoteWhenEmpty: description: If true, will display note when empty @@ -6807,7 +302,7 @@ components: type: string type: enum: - - band + - band type: string upperColumn: type: string @@ -6832,23 +327,14 @@ components: yTotalTicks: type: integer required: - - type - - geom - - queries - - shape - - axes - - colors - - note - - showNoteWhenEmpty - type: object - BasicFilter: - properties: - endTime: - format: date-time - type: string - startTime: - format: date-time - type: string + - type + - geom + - queries + - shape + - axes + - colors + - note + - showNoteWhenEmpty type: object BinaryExpression: description: uses binary operators to act on two operands in an expression @@ -6914,8 +400,7 @@ components: description: URL to retrieve parent organization for this bucket owners: $ref: '#/components/schemas/Link' - description: URL to retrieve owners that can read and write to this - bucket. + description: URL to retrieve owners that can read and write to this bucket. self: $ref: '#/components/schemas/Link' description: URL for this bucket @@ -6938,8 +423,8 @@ components: type: default: user enum: - - user - - system + - user + - system readOnly: true type: string updatedAt: @@ -6947,8 +432,8 @@ components: readOnly: true type: string required: - - name - - retentionRules + - name + - retentionRules Buckets: properties: buckets: @@ -6961,8 +446,8 @@ components: type: object BuilderAggregateFunctionType: enum: - - filter - - group + - filter + - group type: string BuilderConfig: properties: @@ -7046,7 +531,7 @@ components: x: format: int32 type: integer - "y": + 'y': format: int32 type: integer type: object @@ -7061,19 +546,19 @@ components: x: format: int32 type: integer - "y": + 'y': format: int32 type: integer type: object CellWithViewProperties: allOf: - - $ref: '#/components/schemas/Cell' - - properties: - name: - type: string - properties: - $ref: '#/components/schemas/ViewProperties' - type: object + - $ref: '#/components/schemas/Cell' + - properties: + name: + type: string + properties: + $ref: '#/components/schemas/ViewProperties' + type: object type: object Cells: items: @@ -7085,7 +570,7 @@ components: type: array Check: allOf: - - $ref: '#/components/schemas/CheckDiscriminator' + - $ref: '#/components/schemas/CheckDiscriminator' CheckBase: properties: createdAt: @@ -7105,9 +590,9 @@ components: type: string lastRunStatus: enum: - - failed - - success - - canceled + - failed + - success + - canceled readOnly: true type: string latestCompleted: @@ -7161,9 +646,9 @@ components: readOnly: true type: string required: - - name - - orgID - - query + - name + - orgID + - query CheckDiscriminator: discriminator: mapping: @@ -7172,9 +657,9 @@ components: threshold: '#/components/schemas/ThresholdCheck' propertyName: type oneOf: - - $ref: '#/components/schemas/DeadmanCheck' - - $ref: '#/components/schemas/ThresholdCheck' - - $ref: '#/components/schemas/CustomCheck' + - $ref: '#/components/schemas/DeadmanCheck' + - $ref: '#/components/schemas/ThresholdCheck' + - $ref: '#/components/schemas/CustomCheck' CheckPatch: properties: description: @@ -7183,18 +668,18 @@ components: type: string status: enum: - - active - - inactive + - active + - inactive type: string type: object CheckStatusLevel: description: The state to record if check matches a criteria. enum: - - UNKNOWN - - OK - - INFO - - CRIT - - WARN + - UNKNOWN + - OK + - INFO + - CRIT + - WARN type: string CheckViewProperties: properties: @@ -7222,18 +707,18 @@ components: type: array shape: enum: - - chronograf-v2 + - chronograf-v2 type: string type: enum: - - check + - check type: string required: - - type - - shape - - checkID - - queries - - colors + - type + - shape + - checkID + - queries + - colors type: object Checks: properties: @@ -7245,21 +730,22 @@ components: $ref: '#/components/schemas/Links' ColumnDataType: enum: - - integer - - float - - boolean - - string - - unsigned + - integer + - float + - boolean + - string + - unsigned type: string ColumnSemanticType: enum: - - timestamp - - tag - - field + - timestamp + - tag + - field nullable: false type: string ConditionalExpression: - description: Selects one of two expressions, `Alternate` or `Consequent`, depending + description: >- + Selects one of two expressions, `Alternate` or `Consequent`, depending on a third boolean expression, `Test` properties: alternate: @@ -7275,7 +761,7 @@ components: properties: type: enum: - - constant + - constant type: string values: items: @@ -7297,7 +783,7 @@ components: x: format: int32 type: integer - "y": + 'y': format: int32 type: integer type: object @@ -7313,19 +799,19 @@ components: description: The ID of the organization that owns the dashboard. type: string required: - - orgID - - name + - orgID + - name CustomCheck: allOf: - - $ref: '#/components/schemas/CheckBase' - - properties: - type: - enum: - - custom - type: string - required: - - type - type: object + - $ref: '#/components/schemas/CheckBase' + - properties: + type: + enum: + - custom + type: string + required: + - type + type: object DBRP: properties: bucketID: @@ -7335,8 +821,9 @@ components: description: InfluxDB v1 database type: string default: - description: Specify if this mapping represents the default retention policy - for the database specificed. + description: >- + Specify if this mapping represents the default retention policy for + the database specificed. type: boolean id: description: the mapping identifier @@ -7351,12 +838,12 @@ components: description: InfluxDB v1 retention policy type: string required: - - id - - orgID - - bucketID - - database - - retention_policy - - default + - id + - orgID + - bucketID + - database + - retention_policy + - default type: object DBRPCreate: properties: @@ -7367,8 +854,9 @@ components: description: InfluxDB v1 database type: string default: - description: Specify if this mapping represents the default retention policy - for the database specificed. + description: >- + Specify if this mapping represents the default retention policy for + the database specificed. type: boolean org: description: the organization that owns this mapping. @@ -7380,9 +868,9 @@ components: description: InfluxDB v1 retention policy type: string required: - - bucketID - - database - - retention_policy + - bucketID + - database + - retention_policy type: object DBRPGet: properties: @@ -7405,47 +893,47 @@ components: 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 + - $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. @@ -7464,23 +952,23 @@ components: type: description: Type is how the color is used. enum: - - min - - max - - threshold - - scale - - text - - background + - 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 + - id + - type + - hex + - name + - value type: object DashboardQuery: properties: @@ -7496,47 +984,47 @@ components: 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 + - $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: @@ -7548,8 +1036,9 @@ components: $ref: '#/components/schemas/Links' type: object DateTimeLiteral: - description: Represents an instant in time with nanosecond precision using the - syntax of golang's RFC3339 Nanosecond variant + description: >- + Represents an instant in time with nanosecond precision using the syntax + of golang's RFC3339 Nanosecond variant properties: type: $ref: '#/components/schemas/NodeType' @@ -7559,49 +1048,51 @@ components: 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 + - $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. + 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 @@ -7627,8 +1118,8 @@ components: format: date-time type: string required: - - start - - stop + - start + - stop type: object DemoDataBucket: properties: @@ -7663,8 +1154,7 @@ components: description: URL to retrieve parent organization for this bucket owners: $ref: '#/components/schemas/Link' - description: URL to retrieve owners that can read and write to this - bucket. + description: URL to retrieve owners that can read and write to this bucket. self: $ref: '#/components/schemas/Link' description: URL for this bucket @@ -7693,8 +1183,8 @@ components: readOnly: true type: string required: - - name - - retentionRules + - name + - retentionRules DemoDataBuckets: properties: buckets: @@ -7706,15 +1196,17 @@ components: readOnly: true type: object Dialect: - description: Dialect are options to change the default CSV output format; https://www.w3.org/TR/2015/REC-tabular-metadata-20151217/#dialect-descriptions + description: >- + Dialect are options to change the default CSV output format; + https://www.w3.org/TR/2015/REC-tabular-metadata-20151217/#dialect-descriptions properties: annotations: description: https://www.w3.org/TR/2015/REC-tabular-data-model-20151217/#columns items: enum: - - group - - datatype - - default + - group + - datatype + - default type: string type: array uniqueItems: true @@ -7728,8 +1220,8 @@ components: default: RFC3339 description: Format of timestamps enum: - - RFC3339 - - RFC3339Nano + - RFC3339 + - RFC3339Nano type: string delimiter: default: ',' @@ -7764,8 +1256,9 @@ components: $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. + 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 @@ -7775,7 +1268,8 @@ components: type: string type: object DurationLiteral: - description: Represents the elapsed time between two instants as an int64 nanosecond + description: >- + Represents the elapsed time between two instants as an int64 nanosecond count with syntax of golang's time.Duration properties: type: @@ -7791,24 +1285,25 @@ components: code: description: code is the machine-readable error code. enum: - - internal error - - not found - - conflict - - invalid - - unprocessable entity - - empty value - - unavailable - - forbidden - - too many requests - - unauthorized - - method not allowed - - request too large - - unsupported media type + - internal error + - 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: err is a stack of errors that occurred during processing of - the request. Useful for debugging. + description: >- + err is a stack of errors that occurred during processing of the + request. Useful for debugging. readOnly: true type: string message: @@ -7816,40 +1311,42 @@ components: readOnly: true type: string op: - description: op describes the logical code operation during error. Useful - for debugging. + description: >- + op describes the logical code operation during error. Useful for + debugging. readOnly: true type: string required: - - code - - message + - code + - message 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' + - $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 does not return a value and is + description: >- + May consist of an expression that does not return a value and is executed solely for its side-effects properties: expression: @@ -7860,7 +1357,8 @@ components: Field: properties: alias: - description: Alias overrides the field name in the returned response. Applies + description: >- + Alias overrides the field name in the returned response. Applies only if type is `func` type: string args: @@ -7869,19 +1367,21 @@ components: $ref: '#/components/schemas/Field' type: array type: - description: '`type` describes the field type. `func` is a function. `field` - is a field reference.' + description: >- + `type` describes the field type. `func` is a function. `field` is a + field reference. enum: - - func - - field - - integer - - number - - regex - - wildcard + - 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 + description: >- + value is the value of the field. Meaning of the value is implied by + the `type` key type: string type: object File: @@ -7909,8 +1409,9 @@ components: additionalProperties: true type: object FloatLiteral: - description: Represents floating point numbers according to the double representations - defined by the IEEE-754-1985 + description: >- + Represents floating point numbers according to the double + representations defined by the IEEE-754-1985 properties: type: $ref: '#/components/schemas/NodeType' @@ -7938,18 +1439,6 @@ components: $ref: '#/components/schemas/FluxSuggestion' type: array type: object - ForbiddenRequestError: - properties: - code: - description: returns error code 403 - enum: - - forbidden - readOnly: true - type: string - message: - description: message is a human-readable message. - readOnly: true - type: string FunctionExpression: description: Function expression properties: @@ -7982,7 +1471,7 @@ components: type: array shape: enum: - - chronograf-v2 + - chronograf-v2 type: string showNoteWhenEmpty: description: If true, will display note when empty @@ -7995,116 +1484,116 @@ components: type: string type: enum: - - gauge + - gauge type: string required: - - type - - queries - - colors - - shape - - note - - showNoteWhenEmpty - - prefix - - tickPrefix - - suffix - - tickSuffix - - decimalPlaces + - 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 + - $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 + - $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: + - $ref: '#/components/schemas/GeoViewLayerProperties' + - properties: + colorDimension: + $ref: '#/components/schemas/Axis' + colorField: + description: Marker color field type: string - type: array - required: - - colorField - - colorDimension - - colors - type: object + 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 + - $ref: '#/components/schemas/GeoViewLayerProperties' + - required: + - trackWidth + - speed + - randomColors + - trackPointVisualization + type: object properties: colors: description: Colors define color encoding of data into a visualization @@ -8122,29 +1611,28 @@ components: type: integer GeoViewLayer: oneOf: - - $ref: '#/components/schemas/GeoCircleViewLayer' - - $ref: '#/components/schemas/GeoHeatMapViewLayer' - - $ref: '#/components/schemas/GeoPointMapViewLayer' - - $ref: '#/components/schemas/GeoTrackMapViewLayer' + - $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 + - heatmap + - circleMap + - pointMap + - trackMap type: string required: - - type + - type type: object GeoViewProperties: properties: allowPanAndZoom: default: true - description: If true, map zoom and pan controls are enabled on the dashboard - view + 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 @@ -8158,8 +1646,8 @@ components: format: double type: number required: - - lat - - lon + - lat + - lon type: object colors: description: Colors define color encoding of data into a visualization @@ -8168,8 +1656,9 @@ components: type: array detectCoordinateFields: default: true - description: If true, search results get automatically regroupped so that - lon,lat and value are treated as columns + 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' @@ -8192,14 +1681,14 @@ components: type: string shape: enum: - - chronograf-v2 + - chronograf-v2 type: string showNoteWhenEmpty: description: If true, will display note when empty type: boolean type: enum: - - geo + - geo type: string useS2CellID: description: If true, S2 column is used to calculate lat/lon @@ -8211,83 +1700,83 @@ components: minimum: 1 type: number required: - - type - - shape - - queries - - note - - showNoteWhenEmpty - - center - - zoom - - allowPanAndZoom - - detectCoordinateFields - - layers + - 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 + - $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: + - $ref: '#/components/schemas/NotificationEndpointBase' + - properties: + authMethod: + enum: + - none + - basic + - bearer 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 + 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' + - $ref: '#/components/schemas/NotificationRuleBase' + - $ref: '#/components/schemas/HTTPNotificationRuleBase' HTTPNotificationRuleBase: properties: type: enum: - - http + - http type: string url: type: string required: - - type + - type type: object HealthCheck: properties: @@ -8303,14 +1792,14 @@ components: type: string status: enum: - - pass - - fail + - pass + - fail type: string version: type: string required: - - name - - status + - name + - status type: object HeatmapViewProperties: properties: @@ -8346,7 +1835,7 @@ components: type: array shape: enum: - - chronograf-v2 + - chronograf-v2 type: string showNoteWhenEmpty: description: If true, will display note when empty @@ -8355,7 +1844,7 @@ components: type: string type: enum: - - heatmap + - heatmap type: string xAxisLabel: type: string @@ -8400,23 +1889,23 @@ components: yTotalTicks: type: integer required: - - type - - queries - - colors - - shape - - note - - showNoteWhenEmpty - - xColumn - - yColumn - - xDomain - - yDomain - - xAxisLabel - - yAxisLabel - - xPrefix - - yPrefix - - xSuffix - - ySuffix - - binSize + - type + - queries + - colors + - shape + - note + - showNoteWhenEmpty + - xColumn + - yColumn + - xDomain + - yDomain + - xAxisLabel + - yAxisLabel + - xPrefix + - yPrefix + - xSuffix + - ySuffix + - binSize type: object HistogramViewProperties: properties: @@ -8444,8 +1933,8 @@ components: type: string position: enum: - - overlaid - - stacked + - overlaid + - stacked type: string queries: items: @@ -8453,14 +1942,14 @@ components: type: array shape: enum: - - chronograf-v2 + - chronograf-v2 type: string showNoteWhenEmpty: description: If true, will display note when empty type: boolean type: enum: - - histogram + - histogram type: string xAxisLabel: type: string @@ -8472,18 +1961,18 @@ components: type: number type: array required: - - type - - queries - - colors - - shape - - note - - showNoteWhenEmpty - - xColumn - - fillColumns - - xDomain - - xAxisLabel - - position - - binCount + - type + - queries + - colors + - shape + - note + - showNoteWhenEmpty + - xColumn + - fillColumns + - xDomain + - xAxisLabel + - position + - binCount type: object Identifier: description: A valid Flux identifier @@ -8521,22 +2010,11 @@ components: value: type: string type: object - InvalidRequestError: - properties: - code: - description: returns error code 400 - enum: - - invalid - readOnly: true - type: string - message: - description: message is a human-readable message. - readOnly: true - type: string IsOnboarding: properties: allowed: - description: True means that the influxdb instance has NOT had initial setup; + description: >- + True means that the influxdb instance has NOT had initial setup; false means that the database has been setup. type: boolean type: object @@ -8553,8 +2031,9 @@ components: properties: additionalProperties: type: string - description: Key/Value pairs associated with this label. Keys can be removed - by sending an update with an empty value. + description: >- + Key/Value pairs associated with this label. Keys can be removed by + sending an update with an empty value. example: color: ffb3b3 description: this is a description @@ -8569,15 +2048,16 @@ components: properties: additionalProperties: type: string - description: Key/Value pairs associated with this label. Keys can be removed - by sending an update with an empty value. + description: >- + Key/Value pairs associated with this label. Keys can be removed by + sending an update with an empty value. example: color: ffb3b3 description: this is a description type: object required: - - orgID - - name + - orgID + - name type: object LabelMapping: properties: @@ -8598,8 +2078,9 @@ components: properties: additionalProperties: type: string - description: Key/Value pairs associated with this label. Keys can be removed - by sending an update with an empty value. + description: >- + Key/Value pairs associated with this label. Keys can be removed by + sending an update with an empty value. example: color: ffb3b3 description: this is a description @@ -8623,7 +2104,7 @@ components: description: Flux query script to be analyzed type: string required: - - query + - query type: object LatLonColumn: description: Object type for key and column definitions @@ -8635,8 +2116,8 @@ components: description: Key to determine whether the column is tag/field type: string required: - - key - - column + - key + - column type: object LatLonColumns: description: Object type to define lat/lon columns @@ -8646,24 +2127,24 @@ components: lon: $ref: '#/components/schemas/LatLonColumn' required: - - lat - - lon + - lat + - lon type: object LesserThreshold: allOf: - - $ref: '#/components/schemas/ThresholdBase' - - properties: - type: - enum: - - lesser - type: string - value: - format: float - type: number - required: - - type - - value - type: object + - $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: @@ -8675,22 +2156,22 @@ components: description: Max bucket retention duration in nanoseconds. 0 is unlimited. type: integer required: - - maxBuckets - - maxRetentionDuration + - maxBuckets + - maxRetentionDuration type: object check: properties: maxChecks: type: integer required: - - maxChecks + - maxChecks type: object dashboard: properties: maxDashboards: type: integer required: - - maxDashboards + - maxDashboards type: object features: properties: @@ -8705,7 +2186,7 @@ components: example: http,pagerduty type: string required: - - blockNotificationEndpoints + - blockNotificationEndpoints type: object notificationRule: properties: @@ -8716,8 +2197,8 @@ components: maxNotifications: type: integer required: - - maxNotifications - - blockNotificationRules + - maxNotifications + - blockNotificationRules type: object orgID: type: string @@ -8745,75 +2226,27 @@ components: description: Write limit in kb/sec. 0 is unlimited. type: integer required: - - readKBs - - concurrentReadRequests - - writeKBs - - concurrentWriteRequests - - cardinality + - readKBs + - concurrentReadRequests + - writeKBs + - concurrentWriteRequests + - cardinality type: object task: properties: maxTasks: type: integer required: - - maxTasks + - maxTasks type: object required: - - rate - - bucket - - task - - dashboard - - check - - notificationRule - - notificationEndpoint - type: object - LimitEvent: - properties: - orgID: - type: string - timestamp: - format: date-time - readOnly: true - type: string - type: - enum: - - limited_quota - - limited_write - - limited_query - - limited_cardinality - type: string - type: object - LimitEvents: - properties: - events: - items: - $ref: '#/components/schemas/LimitEvent' - type: array - links: - $ref: '#/components/schemas/Links' - type: object - LimitStatus: - properties: - status: - enum: - - ok - - exceeded - type: string - required: - - status - type: object - LimitStatuses: - properties: - cardinality: - $ref: '#/components/schemas/LimitStatus' - read: - $ref: '#/components/schemas/LimitStatus' - write: - $ref: '#/components/schemas/LimitStatus' - required: - - read - - write - - cardinality + - rate + - bucket + - task + - dashboard + - check + - notificationRule + - notificationEndpoint type: object LinePlusSingleStatProperties: properties: @@ -8836,10 +2269,10 @@ components: type: array hoverDimension: enum: - - auto - - x - - "y" - - xy + - auto + - x + - 'y' + - xy type: string legendColorizeRows: type: boolean @@ -8854,8 +2287,8 @@ components: type: string position: enum: - - overlaid - - stacked + - overlaid + - stacked type: string prefix: type: string @@ -8867,7 +2300,7 @@ components: type: boolean shape: enum: - - chronograf-v2 + - chronograf-v2 type: string showNoteWhenEmpty: description: If true, will display note when empty @@ -8880,7 +2313,7 @@ components: type: string type: enum: - - line-plus-single-stat + - line-plus-single-stat type: string xColumn: type: string @@ -8903,34 +2336,35 @@ components: yTotalTicks: type: integer required: - - type - - queries - - shape - - axes - - colors - - note - - showNoteWhenEmpty - - prefix - - suffix - - decimalPlaces - - position + - 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 + - internal error + - not found + - conflict + - invalid + - empty value + - unavailable readOnly: true type: string err: - description: Err is a stack of errors that occurred during processing of - the request. Useful for debugging. + description: >- + Err is a stack of errors that occurred during processing of the + request. Useful for debugging. readOnly: true type: string line: @@ -8943,21 +2377,22 @@ components: readOnly: true type: string op: - description: Op describes the logical code operation during error. Useful - for debugging. + description: >- + Op describes the logical code operation during error. Useful for + debugging. readOnly: true type: string required: - - code - - message - - op - - err + - code + - message + - op + - err LineProtocolLengthError: properties: code: description: Code is the machine-readable error code. enum: - - invalid + - invalid readOnly: true type: string maxLength: @@ -8970,9 +2405,9 @@ components: readOnly: true type: string required: - - code - - message - - maxLength + - code + - message + - maxLength Link: description: URI of resource. format: uri @@ -8987,7 +2422,7 @@ components: self: $ref: '#/components/schemas/Link' required: - - self + - self type: object LogEvent: properties: @@ -9007,8 +2442,9 @@ components: type: string type: object LogicalExpression: - description: Represents the rule conditions that collectively evaluate to either - true or false + description: >- + Represents the rule conditions that collectively evaluate to either true + or false properties: left: $ref: '#/components/schemas/Expression' @@ -9031,7 +2467,7 @@ components: properties: type: enum: - - map + - map type: string values: additionalProperties: @@ -9043,43 +2479,42 @@ components: type: string shape: enum: - - chronograf-v2 + - chronograf-v2 type: string type: enum: - - markdown + - markdown type: string required: - - type - - shape - - note + - type + - shape + - note type: object MeasurementSchema: description: The schema definition for a single measurement example: bucketID: ba3c5e7f9b0a0010 columns: - - name: time - type: timestamp - - 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" + - name: time + type: timestamp + - 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" + updatedAt: 2021-01-21T00:48:40.993Z properties: bucketID: - description: ID of the bucket that the measurement schema is associated - with. + description: ID of the bucket that the measurement schema is associated with. type: string columns: description: An ordered collection of column definitions @@ -9097,19 +2532,18 @@ components: nullable: false type: string orgID: - description: ID of organization that the measurement schema is associated - with. + description: ID of organization that the measurement schema is associated with. type: string updatedAt: format: date-time readOnly: true type: string required: - - id - - name - - columns - - createdAt - - updatedAt + - id + - name + - columns + - createdAt + - updatedAt type: object MeasurementSchemaColumn: description: Definition of a measurement column @@ -9124,25 +2558,25 @@ components: type: $ref: '#/components/schemas/ColumnSemanticType' required: - - name - - type + - name + - type type: object MeasurementSchemaCreateRequest: description: Create a new measurement schema example: columns: - - name: time - type: timestamp - - name: host - type: tag - - name: region - type: tag - - dataType: float - name: usage_user - type: field - - dataType: float - name: usage_user - type: field + - name: time + type: timestamp + - 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: @@ -9153,55 +2587,55 @@ components: name: type: string required: - - name - - columns + - 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" + - 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 + - measurementSchemas type: object MeasurementSchemaUpdateRequest: description: Update an existing measurement schema example: columns: - - name: time - type: timestamp - - name: host - type: tag - - name: region - type: tag - - dataType: float - name: usage_user - type: field - - dataType: float - name: usage_user - type: field + - name: time + type: timestamp + - 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 @@ -9209,7 +2643,7 @@ components: $ref: '#/components/schemas/MeasurementSchemaColumn' type: array required: - - columns + - columns type: object MemberAssignment: description: Object property assignment @@ -9248,10 +2682,10 @@ components: type: array hoverDimension: enum: - - auto - - x - - "y" - - xy + - auto + - x + - 'y' + - xy type: string legendColorizeRows: type: boolean @@ -9270,7 +2704,7 @@ components: type: array shape: enum: - - chronograf-v2 + - chronograf-v2 type: string showNoteWhenEmpty: description: If true, will display note when empty @@ -9279,7 +2713,7 @@ components: type: string type: enum: - - mosaic + - mosaic type: string xAxisLabel: type: string @@ -9324,34 +2758,34 @@ components: ySuffix: type: string required: - - type - - queries - - colors - - shape - - note - - showNoteWhenEmpty - - xColumn - - ySeriesColumns - - fillColumns - - xDomain - - yDomain - - xAxisLabel - - yAxisLabel - - xPrefix - - yPrefix - - xSuffix - - ySuffix + - 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' + - $ref: '#/components/schemas/Expression' + - $ref: '#/components/schemas/Block' NodeType: description: Type of AST node type: string NotificationEndpoint: allOf: - - $ref: '#/components/schemas/NotificationEndpointDiscriminator' + - $ref: '#/components/schemas/NotificationEndpointDiscriminator' NotificationEndpointBase: properties: createdAt: @@ -9394,8 +2828,8 @@ components: default: active description: The status of the endpoint. enum: - - active - - inactive + - active + - inactive type: string type: $ref: '#/components/schemas/NotificationEndpointType' @@ -9406,8 +2840,8 @@ components: userID: type: string required: - - type - - name + - type + - name type: object NotificationEndpointDiscriminator: discriminator: @@ -9418,16 +2852,16 @@ components: telegram: '#/components/schemas/TelegramNotificationEndpoint' propertyName: type oneOf: - - $ref: '#/components/schemas/SlackNotificationEndpoint' - - $ref: '#/components/schemas/PagerDutyNotificationEndpoint' - - $ref: '#/components/schemas/HTTPNotificationEndpoint' - - $ref: '#/components/schemas/TelegramNotificationEndpoint' + - $ref: '#/components/schemas/SlackNotificationEndpoint' + - $ref: '#/components/schemas/PagerDutyNotificationEndpoint' + - $ref: '#/components/schemas/HTTPNotificationEndpoint' + - $ref: '#/components/schemas/TelegramNotificationEndpoint' NotificationEndpointType: enum: - - slack - - pagerduty - - http - - telegram + - slack + - pagerduty + - http + - telegram type: string NotificationEndpointUpdate: properties: @@ -9437,8 +2871,8 @@ components: type: string status: enum: - - active - - inactive + - active + - inactive type: string type: object NotificationEndpoints: @@ -9451,7 +2885,7 @@ components: type: array NotificationRule: allOf: - - $ref: '#/components/schemas/NotificationRuleDiscriminator' + - $ref: '#/components/schemas/NotificationRuleDiscriminator' NotificationRuleBase: properties: createdAt: @@ -9476,9 +2910,9 @@ components: type: string lastRunStatus: enum: - - failed - - success - - canceled + - failed + - success + - canceled readOnly: true type: string latestCompleted: @@ -9487,12 +2921,14 @@ components: readOnly: true type: string limit: - description: Don't notify me more than times every - seconds. If set, limitEvery cannot be empty. + 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. + description: >- + Don't notify me more than times every seconds. + If set, limit cannot be empty. type: integer links: example: @@ -9557,11 +2993,11 @@ components: readOnly: true type: string required: - - orgID - - status - - name - - statusRules - - endpointID + - orgID + - status + - name + - statusRules + - endpointID type: object NotificationRuleDiscriminator: discriminator: @@ -9573,11 +3009,11 @@ components: 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' + - $ref: '#/components/schemas/SlackNotificationRule' + - $ref: '#/components/schemas/SMTPNotificationRule' + - $ref: '#/components/schemas/PagerDutyNotificationRule' + - $ref: '#/components/schemas/HTTPNotificationRule' + - $ref: '#/components/schemas/TelegramNotificationRule' NotificationRuleUpdate: properties: description: @@ -9586,8 +3022,8 @@ components: type: string status: enum: - - active - - inactive + - active + - inactive type: string type: object NotificationRules: @@ -9598,24 +3034,6 @@ components: items: $ref: '#/components/schemas/NotificationRule' type: array - OAuthClientConfig: - properties: - clientID: - type: string - domain: - format: uri - type: string - redirectURL: - format: uri - type: string - state: - type: string - required: - - clientID - - domain - - redirectURL - - state - type: object ObjectExpression: description: Allows the declaration of an anonymous object within a declaration properties: @@ -9645,364 +3063,31 @@ components: username: type: string required: - - username - - org - - bucket + - username + - org + - bucket type: object OnboardingResponse: properties: auth: - allOf: - - properties: - description: - description: A description of the token. - type: string - status: - default: active - description: If inactive the token is inactive and requests using - the token will be rejected. - enum: - - active - - inactive - type: string - - properties: - createdAt: - format: date-time - readOnly: true - type: string - 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: Name of the org token is scoped to. - readOnly: true - type: string - orgID: - description: ID of org that authorization is scoped to. - type: string - permissions: - description: List of permissions for an auth. An auth must have at - least one Permission. - items: - properties: - action: - enum: - - read - - write - type: string - resource: - properties: - id: - description: If ID is set that is a permission for a specific - resource. if it is not set it is a permission for all - resources of that resource type. - nullable: true - type: string - name: - description: Optional name of the resource if the resource - has a name field. - nullable: true - type: string - org: - description: Optional name of the organization of the organization - with orgID. - nullable: true - type: string - orgID: - description: If orgID is set that is a permission for all - resources owned my that org. if it is not set it is a - permission for all resources of that resource type. - nullable: true - type: string - type: - enum: - - authorizations - - buckets - - dashboards - - orgs - - tasks - - telegrafs - - users - - variables - - secrets - - labels - - views - - documents - - notificationRules - - notificationEndpoints - - checks - - dbrp - - flows - - annotations - - functions - type: string - required: - - type - type: object - required: - - action - - resource - minItems: 1 - type: array - token: - description: Passed via the Authorization Header and Token Authentication - type. - readOnly: true - type: string - updatedAt: - format: date-time - readOnly: true - type: string - user: - description: Name of user that created and owns the token. - readOnly: true - type: string - userID: - description: ID of user that created and owns the token. - readOnly: true - type: string - type: object - required: - - orgID - - permissions + $ref: '#/components/schemas/Authorization' bucket: - properties: - createdAt: - format: date-time - readOnly: true - type: string - description: - type: string - id: - readOnly: true - type: string - labels: - items: - 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. Keys - can be removed by sending an update with an empty value. - example: - color: ffb3b3 - description: this is a description - type: object - type: object - type: array - 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: URL to retrieve labels for this bucket - members: - $ref: '#/components/schemas/Link' - description: URL to retrieve members that can read this bucket - org: - $ref: '#/components/schemas/Link' - description: URL to retrieve parent organization for this bucket - owners: - $ref: '#/components/schemas/Link' - description: URL to retrieve owners that can read and write to this - bucket. - self: - $ref: '#/components/schemas/Link' - description: URL for this bucket - write: - $ref: '#/components/schemas/Link' - description: URL to write line protocol for this bucket - readOnly: true - type: object - name: - type: string - orgID: - type: string - retentionRules: - description: Rules to expire or retain data. No rules means data never - expires. - items: - properties: - everySeconds: - description: Duration in seconds for how long data will be kept - in the database. 0 means infinite. - example: 86400 - format: int64 - minimum: 0 - type: integer - shardGroupDurationSeconds: - description: Shard duration measured in seconds. - format: int64 - type: integer - type: - default: expire - enum: - - expire - type: string - required: - - type - - everySeconds - type: object - type: array - rp: - type: string - schemaType: - default: implicit - enum: - - implicit - - explicit - type: string - type: - default: user - enum: - - user - - system - readOnly: true - type: string - updatedAt: - format: date-time - readOnly: true - type: string - required: - - name - - retentionRules + $ref: '#/components/schemas/Bucket' org: - properties: - createdAt: - format: date-time - readOnly: true - 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 + $ref: '#/components/schemas/Organization' user: - properties: - id: - readOnly: true - type: string - links: - example: - self: /api/v2/users/1 - properties: - self: - format: uri - type: string - readOnly: true - type: object - name: - type: string - oauthID: - type: string - status: - default: active - description: If inactive the user is inactive. - enum: - - active - - inactive - type: string - required: - - name + $ref: '#/components/schemas/UserResponse' type: object OptionStatement: description: A single variable declaration properties: assignment: oneOf: - - $ref: '#/components/schemas/VariableAssignment' - - $ref: '#/components/schemas/MemberAssignment' + - $ref: '#/components/schemas/VariableAssignment' + - $ref: '#/components/schemas/MemberAssignment' type: $ref: '#/components/schemas/NodeType' type: object - OrgSetting: - properties: - key: - type: string - value: - type: string - type: object - OrgSettings: - properties: - orgID: - description: the influxDB ID of the created organization - type: string - settings: - items: - $ref: '#/components/schemas/OrgSetting' - type: array - type: object Organization: properties: createdAt: @@ -10049,33 +3134,15 @@ components: default: active description: If inactive the organization is inactive. enum: - - active - - inactive + - active + - inactive type: string updatedAt: format: date-time readOnly: true type: string required: - - name - OrganizationRequest: - properties: - bucket: - description: the name of the bucket to be created - type: string - limit: - $ref: '#/components/schemas/Limit' - org: - description: the name of the organization to be added - type: string - retentionSeconds: - description: length of time to retain data in seconds - type: integer - username: - description: username of the Quartz user to be added in IDPE - example: user@email.com - type: string - type: object + - name Organizations: properties: links: @@ -10112,31 +3179,31 @@ components: type: object PagerDutyNotificationEndpoint: allOf: - - $ref: '#/components/schemas/NotificationEndpointBase' - - properties: - clientURL: - type: string - routingKey: - type: string - required: - - routingKey - type: object + - $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' + - $ref: '#/components/schemas/NotificationRuleBase' + - $ref: '#/components/schemas/PagerDutyNotificationRuleBase' PagerDutyNotificationRuleBase: properties: messageTemplate: type: string type: enum: - - pagerduty + - pagerduty type: string required: - - type - - messageTemplate + - type + - messageTemplate type: object ParenExpression: description: Represents an expression wrapped in parenthesis @@ -10151,7 +3218,7 @@ components: password: type: string required: - - password + - password PatchBucketRequest: description: Updates to an existing bucket resource. properties: @@ -10175,7 +3242,8 @@ components: description: Updates to a rule to expire or retain data. properties: everySeconds: - description: Duration in seconds for how long data will be kept in the database. + description: >- + Duration in seconds for how long data will be kept in the database. 0 means infinite. example: 86400 format: int64 @@ -10188,10 +3256,10 @@ components: type: default: expire enum: - - expire + - expire type: string required: - - type + - type type: object PatchRetentionRules: description: Updates to rules to expire or retain data. No rules means no updates. @@ -10202,14 +3270,14 @@ components: properties: action: enum: - - read - - write + - read + - write type: string resource: $ref: '#/components/schemas/Resource' required: - - action - - resource + - action + - resource PipeExpression: description: Call expression with pipe argument properties: @@ -10221,8 +3289,9 @@ components: $ref: '#/components/schemas/NodeType' type: object PipeLiteral: - description: Represents a specialized literal value, indicating the left hand - value of a pipe expression + description: >- + Represents a specialized literal value, indicating the left hand value + of a pipe expression properties: type: $ref: '#/components/schemas/NodeType' @@ -10243,18 +3312,18 @@ components: $ref: '#/components/schemas/SchemaType' default: implicit required: - - orgID - - name - - retentionRules + - orgID + - name + - retentionRules PostCheck: allOf: - - $ref: '#/components/schemas/CheckDiscriminator' + - $ref: '#/components/schemas/CheckDiscriminator' PostNotificationEndpoint: allOf: - - $ref: '#/components/schemas/NotificationEndpointDiscriminator' + - $ref: '#/components/schemas/NotificationEndpointDiscriminator' PostNotificationRule: allOf: - - $ref: '#/components/schemas/NotificationRuleDiscriminator' + - $ref: '#/components/schemas/NotificationRuleDiscriminator' PostOrganizationRequest: properties: description: @@ -10262,7 +3331,7 @@ components: name: type: string required: - - name + - name type: object Property: description: The value associated with a key @@ -10276,8 +3345,8 @@ components: type: object PropertyKey: oneOf: - - $ref: '#/components/schemas/Identifier' - - $ref: '#/components/schemas/StringLiteral' + - $ref: '#/components/schemas/Identifier' + - $ref: '#/components/schemas/StringLiteral' Query: description: Query influx using the Flux language properties: @@ -10286,14 +3355,17 @@ components: extern: $ref: '#/components/schemas/File' now: - description: Specifies the time that should be reported as "now" in the - query. Default is the server's now time. + description: >- + Specifies the time that should be reported as "now" in the query. + Default is the server's now time. format: date-time type: string params: additionalProperties: true - description: | - Enumeration of key/value pairs that respresent parameters to be injected into query (can only specify either this field or extern and not both) + description: > + Enumeration of key/value pairs that respresent parameters to be + injected into query (can only specify either this field or extern + and not both) type: object query: description: Query script to execute. @@ -10301,21 +3373,21 @@ components: type: description: The type of query. Must be "flux". enum: - - flux + - flux type: string required: - - query + - query type: object QueryEditMode: enum: - - builder - - advanced + - builder + - advanced type: string QueryVariableProperties: properties: type: enum: - - query + - query type: string values: properties: @@ -10326,58 +3398,44 @@ components: 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 - ReadStream: - properties: - createdAt: - format: date-time - type: string - description: - type: string - id: - type: string - stream: - type: string - updatedAt: - format: date-time - type: string - type: object + - $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" + example: 2019-03-13T10:09:33.891196-04:00 format: date-time type: string status: enum: - - ready + - 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 + description: >- + Expressions begin and end with `/` and are regular expressions with + syntax accepted by RE2 properties: type: $ref: '#/components/schemas/NodeType' @@ -10401,9 +3459,9 @@ components: Resource: properties: id: - description: If ID is set that is a permission for a specific resource. - if it is not set it is a permission for all resources of that resource - type. + description: >- + If ID is set that is a permission for a specific resource. if it is + not set it is a permission for all resources of that resource type. nullable: true type: string name: @@ -10411,51 +3469,51 @@ components: nullable: true type: string org: - description: Optional name of the organization of the organization with - orgID. + description: Optional name of the organization of the organization with orgID. nullable: true type: string orgID: - description: If orgID is set that is a permission for all resources owned - my that org. if it is not set it is a permission for all resources of - that resource type. + description: >- + If orgID is set that is a permission for all resources owned my that + org. if it is not set it is a permission for all resources of that + resource type. nullable: true type: string type: enum: - - authorizations - - buckets - - dashboards - - orgs - - tasks - - telegrafs - - users - - variables - - secrets - - labels - - views - - documents - - notificationRules - - notificationEndpoints - - checks - - dbrp - - flows - - annotations - - functions + - authorizations + - buckets + - dashboards + - orgs + - tasks + - telegrafs + - users + - variables + - secrets + - labels + - views + - documents + - notificationRules + - notificationEndpoints + - checks + - dbrp + - flows + - annotations + - functions type: string required: - - type + - type type: object ResourceMember: allOf: - - $ref: '#/components/schemas/UserResponse' - - properties: - role: - default: member - enum: - - member - type: string - type: object + - $ref: '#/components/schemas/UserResponse' + - properties: + role: + default: member + enum: + - member + type: string + type: object ResourceMembers: properties: links: @@ -10471,14 +3529,14 @@ components: type: object ResourceOwner: allOf: - - $ref: '#/components/schemas/UserResponse' - - properties: - role: - default: owner - enum: - - owner - type: string - type: object + - $ref: '#/components/schemas/UserResponse' + - properties: + role: + default: owner + enum: + - owner + type: string + type: object ResourceOwners: properties: links: @@ -10495,7 +3553,8 @@ components: RetentionRule: properties: everySeconds: - description: Duration in seconds for how long data will be kept in the database. + description: >- + Duration in seconds for how long data will be kept in the database. 0 means infinite. example: 86400 format: int64 @@ -10508,11 +3567,11 @@ components: type: default: expire enum: - - expire + - expire type: string required: - - type - - everySeconds + - type + - everySeconds type: object RetentionRules: description: Rules to expire or retain data. No rules means data never expires. @@ -10610,12 +3669,12 @@ components: RuleStatusLevel: description: The state to record if check matches a criteria. enum: - - UNKNOWN - - OK - - INFO - - CRIT - - WARN - - ANY + - UNKNOWN + - OK + - INFO + - CRIT + - WARN + - ANY type: string Run: properties: @@ -10666,11 +3725,11 @@ components: type: string status: enum: - - scheduled - - started - - failed - - success - - canceled + - scheduled + - started + - failed + - success + - canceled readOnly: true type: string taskID: @@ -10679,8 +3738,9 @@ components: RunManually: properties: scheduledFor: - description: Time used for run's "now" option, RFC3339. Default is the - server's now time. + description: >- + Time used for run's "now" option, RFC3339. Default is the server's + now time. format: date-time nullable: true type: string @@ -10695,8 +3755,8 @@ components: type: object SMTPNotificationRule: allOf: - - $ref: '#/components/schemas/NotificationRuleBase' - - $ref: '#/components/schemas/SMTPNotificationRuleBase' + - $ref: '#/components/schemas/NotificationRuleBase' + - $ref: '#/components/schemas/SMTPNotificationRuleBase' SMTPNotificationRuleBase: properties: bodyTemplate: @@ -10707,12 +3767,12 @@ components: type: string type: enum: - - smtp + - smtp type: string required: - - type - - subjectTemplate - - to + - type + - subjectTemplate + - to type: object ScatterViewProperties: properties: @@ -10750,7 +3810,7 @@ components: type: array shape: enum: - - chronograf-v2 + - chronograf-v2 type: string showNoteWhenEmpty: description: If true, will display note when empty @@ -10763,7 +3823,7 @@ components: type: string type: enum: - - scatter + - scatter type: string xAxisLabel: type: string @@ -10808,29 +3868,29 @@ components: yTotalTicks: type: integer required: - - type - - queries - - colors - - shape - - note - - showNoteWhenEmpty - - xColumn - - yColumn - - fillColumns - - symbolColumns - - xDomain - - yDomain - - xAxisLabel - - yAxisLabel - - xPrefix - - yPrefix - - xSuffix - - ySuffix + - type + - queries + - colors + - shape + - note + - showNoteWhenEmpty + - xColumn + - yColumn + - fillColumns + - symbolColumns + - xDomain + - yDomain + - xAxisLabel + - yAxisLabel + - xPrefix + - yPrefix + - xSuffix + - ySuffix type: object SchemaType: enum: - - implicit - - explicit + - implicit + - explicit type: string Script: properties: @@ -10860,36 +3920,33 @@ components: description: invocation endpoint address type: string required: - - name - - orgID - - script + - name + - orgID + - script ScriptCreateRequest: properties: description: - description: A description of the script. type: string language: $ref: '#/components/schemas/ScriptLanguage' name: - description: The name of the script. The name must be unique within the + description: >- + The name of the script. The name must be unique within the organization. type: string - orgID: - description: The ID of the organization that owns the script. - type: string script: description: The script to execute. type: string required: - - name - - orgID - - script - - language - - description + - name + - script + - language + - description type: object ScriptHTTPResponseData: - description: The data sent in the response body when a script is invoked by - an HTTP request. User defined and dynamic. + description: >- + The data sent in the response body when a script is invoked by an HTTP + request. User defined and dynamic. type: string ScriptInvocationParams: properties: @@ -10898,7 +3955,7 @@ components: type: object ScriptLanguage: enum: - - flux + - flux type: string ScriptUpdateRequest: properties: @@ -10926,17 +3983,17 @@ components: type: object SecretKeysResponse: allOf: - - $ref: '#/components/schemas/SecretKeys' - - properties: - links: - properties: - org: - type: string - self: - type: string - readOnly: true - type: object - type: object + - $ref: '#/components/schemas/SecretKeys' + - properties: + links: + properties: + org: + type: string + self: + type: string + readOnly: true + type: object + type: object Secrets: additionalProperties: type: string @@ -10952,7 +4009,7 @@ components: type: array shape: enum: - - chronograf-v2 + - chronograf-v2 type: string showAll: type: boolean @@ -10961,15 +4018,15 @@ components: type: boolean type: enum: - - simple-table + - simple-table type: string required: - - type - - showAll - - queries - - shape - - note - - showNoteWhenEmpty + - type + - showAll + - queries + - shape + - note + - showNoteWhenEmpty type: object SingleStatViewProperties: properties: @@ -10990,7 +4047,7 @@ components: type: array shape: enum: - - chronograf-v2 + - chronograf-v2 type: string showNoteWhenEmpty: description: If true, will display note when empty @@ -11005,38 +4062,39 @@ components: type: string type: enum: - - single-stat + - single-stat type: string required: - - type - - queries - - colors - - shape - - note - - showNoteWhenEmpty - - prefix - - tickPrefix - - suffix - - tickSuffix - - decimalPlaces + - 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 + - $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' + - $ref: '#/components/schemas/NotificationRuleBase' + - $ref: '#/components/schemas/SlackNotificationRuleBase' SlackNotificationRuleBase: properties: channel: @@ -11045,11 +4103,11 @@ components: type: string type: enum: - - slack + - slack type: string required: - - type - - messageTemplate + - type + - messageTemplate type: object Stack: properties: @@ -11114,14 +4172,14 @@ components: 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' + - $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: @@ -11154,33 +4212,6 @@ components: previousLevel: $ref: '#/components/schemas/RuleStatusLevel' type: object - Stream: - properties: - description: - type: string - stream: - type: string - type: object - StreamDeleteFilter: - properties: - stream: - type: string - type: object - StreamList: - items: - $ref: '#/components/schemas/ReadStream' - type: array - StreamListFilter: - allOf: - - $ref: '#/components/schemas/BasicFilter' - - properties: - allStreams: - type: boolean - streamIncludes: - items: - type: string - type: array - type: object StringLiteral: description: Expressions begin and end with double quote marks properties: @@ -11199,7 +4230,8 @@ components: decimalPlaces: $ref: '#/components/schemas/DecimalPlaces' fieldOptions: - description: fieldOptions represent the fields retrieved by the query with + description: >- + fieldOptions represent the fields retrieved by the query with customization options items: $ref: '#/components/schemas/RenamableField' @@ -11212,7 +4244,7 @@ components: type: array shape: enum: - - chronograf-v2 + - chronograf-v2 type: string showNoteWhenEmpty: description: If true, will display note when empty @@ -11220,43 +4252,47 @@ components: tableOptions: properties: fixFirstColumn: - description: fixFirstColumn indicates whether the first column of the - table should be locked + 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 + 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 + description: >- + Wrapping describes the text wrapping style to be used in table + views enum: - - truncate - - wrap - - single-line + - truncate + - wrap + - single-line type: string type: object timeFormat: - description: timeFormat describes the display format for time values according - to moment.js date formatting + description: >- + timeFormat describes the display format for time values according to + moment.js date formatting type: string type: enum: - - table + - table type: string required: - - type - - queries - - colors - - shape - - note - - showNoteWhenEmpty - - tableOptions - - fieldOptions - - timeFormat - - decimalPlaces + - type + - queries + - colors + - shape + - note + - showNoteWhenEmpty + - tableOptions + - fieldOptions + - timeFormat + - decimalPlaces type: object TagRule: properties: @@ -11264,10 +4300,10 @@ components: type: string operator: enum: - - equal - - notequal - - equalregex - - notequalregex + - equal + - notequal + - equalregex + - notequalregex type: string value: type: string @@ -11275,16 +4311,18 @@ components: Task: properties: authorizationID: - description: The ID of the authorization used when this task communicates - with the query engine. + description: >- + The ID of the authorization used when this task communicates with + the query engine. type: string createdAt: format: date-time readOnly: true type: string cron: - description: A task repetition schedule in the form '* * * * * *'; parsed - from Flux. + description: >- + A task repetition schedule in the form '* * * * * *'; parsed from + Flux. type: string description: description: An optional description of the task. @@ -11305,9 +4343,9 @@ components: type: string lastRunStatus: enum: - - failed - - success - - canceled + - failed + - success + - canceled readOnly: true type: string latestCompleted: @@ -11342,9 +4380,10 @@ components: description: The name of the task. type: string offset: - description: Duration to delay after the schedule, before executing the - task; parsed from flux, if set to zero it will remove this option and - use 0 as the default. + description: >- + Duration to delay after the schedule, before executing the task; + parsed from flux, if set to zero it will remove this option and use + 0 as the default. type: string org: description: The name of the organization that owns this Task. @@ -11358,7 +4397,8 @@ components: status: $ref: '#/components/schemas/TaskStatusType' type: - description: The type of task, this can be used for filtering tasks on list + description: >- + The type of task, this can be used for filtering tasks on list actions. type: string updatedAt: @@ -11366,10 +4406,10 @@ components: readOnly: true type: string required: - - id - - name - - orgID - - flux + - id + - name + - orgID + - flux type: object TaskCreateRequest: properties: @@ -11388,12 +4428,12 @@ components: status: $ref: '#/components/schemas/TaskStatusType' required: - - flux + - flux type: object TaskStatusType: enum: - - active - - inactive + - active + - inactive type: string TaskUpdateRequest: properties: @@ -11430,32 +4470,32 @@ components: type: object Telegraf: allOf: - - $ref: '#/components/schemas/TelegrafRequest' - - properties: - id: - readOnly: true - type: string - labels: - $ref: '#/components/schemas/Labels' - readOnly: true - links: - example: - lables: /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 + - $ref: '#/components/schemas/TelegrafRequest' + - properties: + id: + readOnly: true + type: string + labels: + $ref: '#/components/schemas/Labels' + readOnly: true + links: + example: + lables: /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: @@ -11506,52 +4546,58 @@ components: type: object TelegramNotificationEndpoint: allOf: - - $ref: '#/components/schemas/NotificationEndpointBase' - - properties: - channel: - description: 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 + - $ref: '#/components/schemas/NotificationEndpointBase' + - properties: + channel: + description: >- + 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' + - $ref: '#/components/schemas/NotificationRuleBase' + - $ref: '#/components/schemas/TelegramNotificationRuleBase' TelegramNotificationRuleBase: properties: disableWebPagePreview: - description: Disables preview of web links in the sent messages when "true". + 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" . + description: >- + Parse mode of the message text per + https://core.telegram.org/bots/api#formatting-options . Defaults to + "MarkdownV2" . enum: - - MarkdownV2 - - HTML - - Markdown + - MarkdownV2 + - HTML + - Markdown type: string type: - description: The discriminator between other types of notification rules - is "telegram". + description: >- + The discriminator between other types of notification rules is + "telegram". enum: - - telegram + - telegram type: string required: - - type - - messageTemplate - - channel + - type + - messageTemplate + - channel type: object Template: items: @@ -11574,45 +4620,45 @@ components: actions: items: oneOf: - - properties: - action: - enum: - - skipKind - type: string - properties: + - properties: + action: + enum: + - skipKind + type: string 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' + required: + - kind + type: object + type: object + - properties: + action: + enum: + - skipResource + type: string properties: - kind: - $ref: '#/components/schemas/TemplateKind' - resourceTemplateName: - type: string - required: - - kind - - resourceTemplateName - type: object - type: object + properties: + kind: + $ref: '#/components/schemas/TemplateKind' + resourceTemplateName: + type: string + required: + - kind + - resourceTemplateName + type: object + type: object type: array dryRun: type: boolean envRefs: additionalProperties: oneOf: - - type: string - - type: integer - - type: number - - type: boolean + - type: string + - type: integer + - type: number + - type: boolean type: object orgID: type: string @@ -11624,7 +4670,7 @@ components: url: type: string required: - - url + - url type: object type: array secrets: @@ -11675,16 +4721,18 @@ components: items: properties: defaultValue: - description: Default value that will be provided for the reference when - no value is provided + 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 + - type: string + - type: integer + - type: number + - type: boolean envRefKey: - description: Key identified as environment reference and is the key identified + description: >- + Key identified as environment reference and is the key identified in the template type: string resourceField: @@ -11694,13 +4742,13 @@ components: description: Value provided to fulfill reference nullable: true oneOf: - - type: string - - type: integer - - type: number - - type: boolean + - type: string + - type: integer + - type: number + - type: boolean required: - - resourceField - - envRefKey + - resourceField + - envRefKey type: object type: array TemplateExportByID: @@ -11731,13 +4779,14 @@ components: 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 + 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 + - id + - kind type: object type: array stackID: @@ -11771,8 +4820,8 @@ components: name: type: string required: - - name - - kind + - name + - kind type: object type: array stackID: @@ -11780,20 +4829,20 @@ components: type: object TemplateKind: enum: - - Bucket - - Check - - CheckDeadman - - CheckThreshold - - Dashboard - - Label - - NotificationEndpoint - - NotificationEndpointHTTP - - NotificationEndpointPagerDuty - - NotificationEndpointSlack - - NotificationRule - - Task - - Telegraf - - Variable + - Bucket + - Check + - CheckDeadman + - CheckThreshold + - Dashboard + - Label + - NotificationEndpoint + - NotificationEndpointHTTP + - NotificationEndpointPagerDuty + - NotificationEndpointSlack + - NotificationRule + - Task + - Telegraf + - Variable type: string TemplateSummary: properties: @@ -12195,19 +5244,19 @@ components: 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 + - $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: @@ -12272,19 +5321,19 @@ components: 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 + - $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: @@ -12369,19 +5418,19 @@ components: 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 + - $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: @@ -12448,9 +5497,9 @@ components: range: '#/components/schemas/RangeThreshold' propertyName: type oneOf: - - $ref: '#/components/schemas/GreaterThreshold' - - $ref: '#/components/schemas/LesserThreshold' - - $ref: '#/components/schemas/RangeThreshold' + - $ref: '#/components/schemas/GreaterThreshold' + - $ref: '#/components/schemas/LesserThreshold' + - $ref: '#/components/schemas/RangeThreshold' ThresholdBase: properties: allValues: @@ -12460,38 +5509,38 @@ components: $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 + - $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: @@ -12507,18 +5556,6 @@ components: type: $ref: '#/components/schemas/NodeType' type: object - UnauthorizedRequestError: - properties: - code: - description: returns error code 401 - enum: - - unauthorized - readOnly: true - type: string - message: - description: message is a human-readable message. - readOnly: true - type: string UnsignedIntegerLiteral: description: Represents integer numbers properties: @@ -12540,18 +5577,18 @@ components: type: string role: enum: - - owner - - member + - owner + - member type: string status: default: active description: If inactive the user is inactive. enum: - - active - - inactive + - active + - inactive type: string required: - - name + - name UserResponse: properties: id: @@ -12574,11 +5611,11 @@ components: default: active description: If inactive the user is inactive. enum: - - active - - inactive + - active + - inactive type: string required: - - name + - name Users: properties: links: @@ -12633,9 +5670,9 @@ components: format: date-time type: string required: - - name - - orgID - - arguments + - name + - orgID + - arguments type: object VariableAssignment: description: Represents the declaration of a variable @@ -12649,43 +5686,43 @@ components: type: object VariableProperties: oneOf: - - $ref: '#/components/schemas/QueryVariableProperties' - - $ref: '#/components/schemas/ConstantVariableProperties' - - $ref: '#/components/schemas/MapVariableProperties' + - $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 + - 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: @@ -12708,24 +5745,24 @@ components: properties: $ref: '#/components/schemas/ViewProperties' required: - - name - - properties + - 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' + - $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: @@ -12740,18 +5777,18 @@ components: type: object WritePrecision: enum: - - ms - - s - - us - - ns + - ms + - s + - us + - ns type: string XYGeom: enum: - - line - - step - - stacked - - bar - - monotoneX + - line + - step + - stacked + - bar + - monotoneX type: string XYViewProperties: properties: @@ -12774,10 +5811,10 @@ components: $ref: '#/components/schemas/XYGeom' hoverDimension: enum: - - auto - - x - - "y" - - xy + - auto + - x + - 'y' + - xy type: string legendColorizeRows: type: boolean @@ -12792,8 +5829,8 @@ components: type: string position: enum: - - overlaid - - stacked + - overlaid + - stacked type: string queries: items: @@ -12803,7 +5840,7 @@ components: type: boolean shape: enum: - - chronograf-v2 + - chronograf-v2 type: string showNoteWhenEmpty: description: If true, will display note when empty @@ -12814,7 +5851,7 @@ components: type: string type: enum: - - xy + - xy type: string xColumn: type: string @@ -12837,39 +5874,88 @@ components: yTotalTicks: type: integer required: - - type - - geom - - queries - - shape - - axes - - colors - - note - - showNoteWhenEmpty - - position + - type + - geom + - queries + - shape + - axes + - colors + - note + - showNoteWhenEmpty + - position type: object - responses: - NoContent: - description: No content - ServerError: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Non 2XX error response from server. securitySchemes: + BasicAuthentication: + type: http + scheme: basic + description: > + ### Basic authentication scheme + + + Use HTTP Basic Auth with clients that support the InfluxDB 1.x + convention of username and password (that don't support the + `Authorization: Token` scheme): + - **username**: InfluxDB Cloud username + - **password**: InfluxDB Cloud API token + + ### Example + + + `curl --get "https://europe-west1-1.gcp.cloud2.influxdata.com/query" + --user "YOUR_USERNAME":"YOUR_TOKEN_OR_PASSWORD"` + + For more information and examples, see how to [authenticate with a + username and password + scheme](https://docs.influxdata.com/influxdb/cloud/reference/api/influxdb-1x/). + QuerystringAuthentication: + type: apiKey + in: query + name: u=&p= + description: > + ### Querystring authentication scheme + + + Use InfluxDB 1.x API parameters to provide credentials through the query + string. + + + Username and password schemes require the following credentials: + + - **username**: InfluxDB Cloud username + + - **password**: InfluxDB Cloud API token + + + ### Example + + + `curl --get "https://europe-west1-1.gcp.cloud2.influxdata.com/query" + --data-urlencode "u=YOUR_USERNAME" + --data-urlencode "p=YOUR_TOKEN_OR_PASSWORD"` + + For more information and examples, see how to [authenticate with a + username and password + scheme](https://docs.influxdata.com/influxdb/cloud/reference/api/influxdb-1x/). TokenAuthentication: type: http scheme: token bearerFormat: InfluxDB Token String - description: | + description: > ### Token authentication scheme - InfluxDB API tokens ensure secure interaction between users and data. A token belongs to an organization and identifies InfluxDB permissions within the organization. - Include your API token in an `Authentication: Token YOUR_API_TOKEN` HTTP header with each request. + InfluxDB API tokens ensure secure interaction between users and data. A + token belongs to an organization and identifies InfluxDB permissions + within the organization. + + + Include your API token in an `Authentication: Token YOUR_API_TOKEN` HTTP + header with each request. + ### Example + `curl https://us-east-1-1.aws.cloud2.influxdata.com/ --header "Authentication: Token YOUR_API_TOKEN"` @@ -12877,43 +5963,6574 @@ components: - [Use tokens in API requests](https://docs.influxdata.com/influxdb/cloud/api-guide/api_intro/#authentication). - [Manage API tokens](https://docs.influxdata.com/influxdb/cloud/security/tokens). - [`/authorizations`](#tag/Authorizations) endpoint. - BasicAuthentication: - type: http - scheme: basic - description: | - ### Basic authentication scheme +info: + title: Influx Cloud API Service + description: > + The InfluxDB v2 API provides a programmatic interface for all interactions + with InfluxDB. Access the InfluxDB API using the `/api/v2/` endpoint. +openapi: 3.0.0 +paths: + /api/v2/: + get: + operationId: GetRoutes + parameters: + - $ref: '#/components/parameters/TraceSpan' + responses: + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Routes' + description: All routes + summary: List all top level routes + tags: + - Routes + /api/v2/authorizations: + get: + operationId: GetAuthorizations + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: Only show authorizations that belong to a user ID. + in: query + name: userID + schema: + type: string + - description: Only show authorizations that belong to a user name. + in: query + name: user + schema: + type: string + - description: Only show authorizations that belong to an organization ID. + in: query + name: orgID + schema: + type: string + - description: Only show authorizations that belong to a organization name. + in: query + name: org + schema: + type: string + - description: Find a token by value. + in: query + name: token + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Authorizations' + description: A list of authorizations + default: + $ref: '#/components/responses/ServerError' + description: Unexpected error + summary: List all authorizations + tags: + - Authorizations + post: + operationId: PostAuthorizations + parameters: + - $ref: '#/components/parameters/TraceSpan' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Authorization' + description: Authorization to create + required: true + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/Authorization' + description: Authorization created + '400': + $ref: '#/components/responses/ServerError' + description: Invalid request + default: + $ref: '#/components/responses/ServerError' + description: Unexpected error + summary: Create an authorization + tags: + - Authorizations + /api/v2/authorizations/{authID}: + delete: + operationId: DeleteAuthorizationsID + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The identifier of the authorization to delete. + in: path + name: authID + required: true + schema: + type: string + responses: + '204': + description: Authorization deleted + default: + $ref: '#/components/responses/ServerError' + description: Unexpected error + summary: Delete an authorization + tags: + - Authorizations + get: + operationId: GetAuthorizationsID + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The identifier of the authorization to get. + in: path + name: authID + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Authorization' + description: Authorization details + default: + $ref: '#/components/responses/ServerError' + description: Unexpected error + summary: Retrieve an authorization + tags: + - Authorizations + patch: + description: Update an authorization's status to `active` or `inactive`. + operationId: PatchAuthorizationsID + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The identifier of the authorization to update. + in: path + name: authID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AuthorizationUpdateRequest' + description: The updated Authorization object. + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Authorization' + description: The updated authorization. + default: + $ref: '#/components/responses/ServerError' + description: Unexpected error + summary: Update authorization status + tags: + - Authorizations + /api/v2/buckets: + get: + operationId: GetBuckets + parameters: + - $ref: '#/components/parameters/TraceSpan' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Limit' + - $ref: '#/components/parameters/After' + - description: The name of the organization. + in: query + name: org + schema: + type: string + - description: The organization ID. + in: query + name: orgID + schema: + type: string + - description: Only returns buckets with a specific name. + in: query + name: name + schema: + type: string + - description: Only returns buckets with a specific ID. + in: query + name: id + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Buckets' + description: A list of buckets + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: List all buckets + tags: + - Buckets + post: + operationId: PostBuckets + parameters: + - $ref: '#/components/parameters/TraceSpan' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PostBucketRequest' + description: Bucket to create + required: true + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/Bucket' + description: Bucket created + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Request body failed validation + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Create a bucket + tags: + - Buckets + /api/v2/buckets/{bucketID}: + delete: + operationId: DeleteBucketsID + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The ID of the bucket to delete. + in: path + name: bucketID + 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 bucket + tags: + - Buckets + get: + operationId: GetBucketsID + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The bucket ID. + in: path + name: bucketID + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Bucket' + description: Bucket details + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Retrieve a bucket + tags: + - Buckets + patch: + 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: Bucket update to apply + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Bucket' + description: An updated bucket + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Update a bucket + tags: + - Buckets + /api/v2/buckets/{bucketID}/labels: + get: + operationId: GetBucketsIDLabels + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The bucket ID. + in: path + name: bucketID + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/LabelsResponse' + description: A list of all labels for a bucket + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: List all labels for a bucket + tags: + - Buckets + post: + operationId: PostBucketsIDLabels + 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/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 bucket + tags: + - Buckets + /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: + operationId: GetBucketsIDMembers + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The bucket ID. + in: path + name: bucketID + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ResourceMembers' + description: A list of bucket members + 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: + operationId: PostBucketsIDMembers + 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/AddResourceMemberRequestBody' + description: User to add as member + required: true + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/ResourceMember' + description: Member added to bucket + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Add a member to a bucket + tags: + - Buckets + /api/v2/buckets/{bucketID}/members/{userID}: + delete: + operationId: DeleteBucketsIDMembersID + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The ID of the member to remove. + in: path + name: userID + required: true + schema: + type: string + - description: The bucket ID. + in: path + name: bucketID + 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 bucket + tags: + - Buckets + /api/v2/buckets/{bucketID}/owners: + get: + operationId: GetBucketsIDOwners + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The bucket ID. + in: path + name: bucketID + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ResourceOwners' + description: A list of bucket owners + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: List all owners of a bucket + tags: + - Buckets + post: + operationId: PostBucketsIDOwners + 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/AddResourceMemberRequestBody' + description: User to add as owner + required: true + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/ResourceOwner' + description: Bucket owner added + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Add an owner to a bucket + tags: + - Buckets + /api/v2/buckets/{bucketID}/owners/{userID}: + delete: + 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 bucket ID. + in: path + name: bucketID + 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 bucket + tags: + - Buckets + /api/v2/buckets/{bucketID}/schema/measurements: + get: + operationId: getMeasurementSchemas + parameters: + - description: The name of the organization. + in: query + name: org + schema: + type: string + - description: The identifier of the organization. + in: query + name: orgID + schema: + type: string + - description: The name of the measurement to return schemas for. + in: query + name: name + schema: + type: string + - description: The identifier of the 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 + '404': + $ref: '#/components/responses/ServerError' + description: Bucket not found + summary: List all measurement schemas of a bucket + tags: + - Bucket Schemas + post: + operationId: createMeasurementSchema + parameters: + - description: The name of the organization. + in: query + name: org + schema: + type: string + - description: The identifier of the organization. + in: query + name: orgID + schema: + type: string + - description: The identifier of the bucket. + in: path + name: bucketID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MeasurementSchemaCreateRequest' + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/MeasurementSchema' + description: The created 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: Client error with create request + summary: Create a measurement schema for a bucket + tags: + - Bucket Schemas + summary: Bucket schemas + /api/v2/buckets/{bucketID}/schema/measurements/{measurementID}: + get: + operationId: getMeasurementSchema + parameters: + - description: The name of the organization. + in: query + name: org + schema: + type: string + - description: The identifier of the organization. + in: query + name: orgID + schema: + type: string + - description: The identifier of the bucket. + in: path + name: bucketID + required: true + schema: + type: string + - description: The identifier of the measurement. + 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 + summary: Retrieve measurement schema information + tags: + - Bucket Schemas + patch: + operationId: updateMeasurementSchema + parameters: + - description: The name of the organization. + in: query + name: org + schema: + type: string + - description: The identifier of the organization. + in: query + name: orgID + schema: + type: string + - description: The identifier of the bucket. + in: path + name: bucketID + required: true + schema: + type: string + - description: The identifier of the measurement. + in: path + name: measurementID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MeasurementSchemaUpdateRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/MeasurementSchema' + description: The updated 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: Client error updating measurement schema + summary: Update a measurement schema + tags: + - Bucket Schemas + summary: Bucket Schema + /api/v2/checks: + get: + operationId: GetChecks + parameters: + - $ref: '#/components/parameters/TraceSpan' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Limit' + - description: Only show checks that belong to a specific organization ID. + in: query + name: orgID + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Checks' + description: A list of checks + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: List all checks + tags: + - Checks + post: + operationId: CreateCheck + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PostCheck' + description: Check to create + required: true + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/Check' + description: Check created + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Add new check + tags: + - Checks + /api/v2/checks/{checkID}: + delete: + operationId: DeleteChecksID + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The check ID. + in: path + name: checkID + required: true + schema: + type: string + responses: + '204': + description: Delete has been accepted + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: The check was not found + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Delete a check + tags: + - Checks + get: + operationId: GetChecksID + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The check ID. + in: path + name: checkID + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Check' + description: The check requested + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Retrieve a check + tags: + - Checks + patch: + operationId: PatchChecksID + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The check ID. + in: path + name: checkID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CheckPatch' + description: Check update to apply + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Check' + description: An updated check + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: The check was not found + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Update a check + tags: + - Checks + put: + operationId: PutChecksID + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The check ID. + in: path + name: checkID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Check' + description: Check update to apply + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Check' + description: An updated check + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: The check was not found + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Update a check + tags: + - Checks + /api/v2/checks/{checkID}/labels: + get: + operationId: GetChecksIDLabels + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The check ID. + in: path + name: checkID + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/LabelsResponse' + description: A list of all labels for a check + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: List all labels for a check + tags: + - Checks + post: + operationId: PostChecksIDLabels + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The check ID. + in: path + name: checkID + 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 was added to the check + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Add a label to a check + tags: + - Checks + /api/v2/checks/{checkID}/labels/{labelID}: + delete: + operationId: DeleteChecksIDLabelsID + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The check ID. + in: path + name: checkID + 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: Check or label not found + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Delete label from a check + tags: + - Checks + /api/v2/checks/{checkID}/query: + get: + operationId: GetChecksIDQuery + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The check ID. + in: path + name: checkID + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/FluxResponse' + description: The check query requested + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Invalid request + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Check not found + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Retrieve a check query + tags: + - Checks + /api/v2/dashboards: + get: + operationId: GetDashboards + parameters: + - $ref: '#/components/parameters/TraceSpan' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Descending' + - description: The non-zero number of dashboards to return + in: query + name: limit + schema: + default: 20 + maximum: 100 + minimum: -1 + type: integer + - description: >- + A user identifier. Returns only dashboards where this user has the + `owner` role. + in: query + name: owner + schema: + type: string + - description: The column to sort by. + in: query + name: sortBy + schema: + enum: + - ID + - CreatedAt + - UpdatedAt + type: string + - description: >- + A list of dashboard identifiers. Returns only the listed dashboards. + If both `id` and `owner` are specified, only `id` is used. + in: query + name: id + schema: + items: + type: string + type: array + - description: The identifier of the organization. + in: query + name: orgID + schema: + type: string + - description: The name of the organization. + in: query + name: org + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Dashboards' + description: All dashboards + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: List all dashboards + tags: + - Dashboards + post: + operationId: PostDashboards + parameters: + - $ref: '#/components/parameters/TraceSpan' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateDashboardRequest' + description: Dashboard to create + required: true + responses: + '201': + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/Dashboard' + - $ref: '#/components/schemas/DashboardWithViewProperties' + description: Added dashboard + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Create a dashboard + tags: + - Dashboards + /api/v2/dashboards/{dashboardID}: + delete: + operationId: DeleteDashboardsID + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The ID of the dashboard to update. + in: path + name: dashboardID + required: true + schema: + type: string + responses: + '204': + description: Delete has been accepted + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Dashboard not found + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Delete a dashboard + tags: + - Dashboards + get: + operationId: GetDashboardsID + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The ID of the dashboard to update. + in: path + name: dashboardID + required: true + schema: + type: string + - description: >- + Includes the cell view properties in the response if set to + `properties` + in: query + name: include + required: false + schema: + enum: + - properties + type: string + responses: + '200': + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/Dashboard' + - $ref: '#/components/schemas/DashboardWithViewProperties' + description: Retrieve a single dashboard + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Dashboard not found + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Retrieve a Dashboard + tags: + - Dashboards + patch: + operationId: PatchDashboardsID + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The ID of the dashboard to update. + in: path + name: dashboardID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + cells: + $ref: '#/components/schemas/CellWithViewProperties' + description: >- + optional, when provided will replace all existing cells with + the cells provided + description: + description: optional, when provided will replace the description + type: string + name: + description: optional, when provided will replace the name + type: string + title: PatchDashboardRequest + type: object + description: Patching of a dashboard + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Dashboard' + description: Updated dashboard + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Dashboard not found + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Update a dashboard + tags: + - Dashboards + /api/v2/dashboards/{dashboardID}/cells: + post: + operationId: PostDashboardsIDCells + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The ID of the dashboard to update. + in: path + name: dashboardID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateCell' + description: Cell that will be added + required: true + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/Cell' + description: Cell successfully added + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Dashboard not found + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Create a dashboard cell + tags: + - Cells + - Dashboards + put: + description: >- + Replaces all cells in a dashboard. This is used primarily to update the + positional information of all cells. + operationId: PutDashboardsIDCells + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The ID of the dashboard to update. + in: path + name: dashboardID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Cells' + required: true + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/Dashboard' + description: Replaced dashboard cells + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Dashboard not found + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Replace cells in a dashboard + tags: + - Cells + - Dashboards + /api/v2/dashboards/{dashboardID}/cells/{cellID}: + delete: + operationId: DeleteDashboardsIDCellsID + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The ID of the dashboard to delete. + in: path + name: dashboardID + required: true + schema: + type: string + - description: The ID of the cell to delete. + in: path + name: cellID + required: true + schema: + type: string + responses: + '204': + description: Cell successfully deleted + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Cell or dashboard not found + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Delete a dashboard cell + tags: + - Cells + - Dashboards + patch: + description: >- + Updates the non positional information related to a cell. Updates to a + single cell's positional data could cause grid conflicts. + operationId: PatchDashboardsIDCellsID + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The ID of the dashboard to update. + in: path + name: dashboardID + required: true + schema: + type: string + - description: The ID of the cell to update. + in: path + name: cellID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CellUpdate' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Cell' + description: Updated dashboard cell + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Cell or dashboard not found + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Update the non-positional information related to a cell + tags: + - Cells + - Dashboards + /api/v2/dashboards/{dashboardID}/cells/{cellID}/view: + get: + operationId: GetDashboardsIDCellsIDView + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The dashboard ID. + in: path + name: dashboardID + required: true + schema: + type: string + - description: The cell ID. + in: path + name: cellID + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/View' + description: A dashboard cells view + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Cell or dashboard not found + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Retrieve the view for a cell + tags: + - Cells + - Dashboards + - Views + patch: + operationId: PatchDashboardsIDCellsIDView + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The ID of the dashboard to update. + in: path + name: dashboardID + required: true + schema: + type: string + - description: The ID of the cell to update. + in: path + name: cellID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/View' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/View' + description: Updated cell view + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Cell or dashboard not found + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Update the view for a cell + tags: + - Cells + - Dashboards + - Views + /api/v2/dashboards/{dashboardID}/labels: + get: + operationId: GetDashboardsIDLabels + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The dashboard ID. + in: path + name: dashboardID + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/LabelsResponse' + description: A list of all labels for a dashboard + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: List all labels for a dashboard + tags: + - Dashboards + post: + operationId: PostDashboardsIDLabels + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The dashboard ID. + in: path + name: dashboardID + 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 dashboard + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Add a label to a dashboard + tags: + - Dashboards + /api/v2/dashboards/{dashboardID}/labels/{labelID}: + delete: + operationId: DeleteDashboardsIDLabelsID + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The dashboard ID. + in: path + name: dashboardID + 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: Dashboard not found + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Delete a label from a dashboard + tags: + - Dashboards + /api/v2/dashboards/{dashboardID}/members: + get: + operationId: GetDashboardsIDMembers + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The dashboard ID. + in: path + name: dashboardID + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ResourceMembers' + description: A list of users who have member privileges for a dashboard + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: List all dashboard members + tags: + - Dashboards + post: + operationId: PostDashboardsIDMembers + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The dashboard ID. + in: path + name: dashboardID + 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: Added to dashboard members + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Add a member to a dashboard + tags: + - Dashboards + /api/v2/dashboards/{dashboardID}/members/{userID}: + delete: + operationId: DeleteDashboardsIDMembersID + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The ID of the member to remove. + in: path + name: userID + required: true + schema: + type: string + - description: The dashboard ID. + in: path + name: dashboardID + 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 dashboard + tags: + - Dashboards + /api/v2/dashboards/{dashboardID}/owners: + get: + operationId: GetDashboardsIDOwners + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The dashboard ID. + in: path + name: dashboardID + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ResourceOwners' + description: A list of users who have owner privileges for a dashboard + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: List all dashboard owners + tags: + - Dashboards + post: + operationId: PostDashboardsIDOwners + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The dashboard ID. + in: path + name: dashboardID + 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: Added to dashboard owners + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Add an owner to a dashboard + tags: + - Dashboards + /api/v2/dashboards/{dashboardID}/owners/{userID}: + delete: + operationId: DeleteDashboardsIDOwnersID + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The ID of the owner to remove. + in: path + name: userID + required: true + schema: + type: string + - description: The dashboard ID. + in: path + name: dashboardID + 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 dashboard + tags: + - Dashboards + /api/v2/dbrps: + get: + operationId: GetDBRPs + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: Specifies the organization ID to filter on + in: query + name: orgID + schema: + type: string + - description: Specifies the organization name to filter on + in: query + name: org + schema: + type: string + - description: Specifies the mapping ID to filter on + in: query + name: id + schema: + type: string + - description: Specifies the bucket ID to filter on + in: query + name: bucketID + schema: + type: string + - description: Specifies filtering on default + in: query + name: default + schema: + type: boolean + - description: Specifies the database to filter on + in: query + name: db + schema: + type: string + - description: Specifies the retention policy to filter on + in: query + name: rp + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DBRPs' + description: Success. Returns a list of database retention policy mappings. + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Bad request. The request has one or more invalid parameters. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: List database retention policy mappings + tags: + - DBRPs + post: + operationId: PostDBRP + parameters: + - $ref: '#/components/parameters/TraceSpan' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DBRPCreate' + description: The database retention policy mapping to add + required: true + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/DBRP' + description: Created. Returns the created database retention policy mapping. + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Bad request. The mapping in the request has one or more invalid IDs. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Add a database retention policy mapping + tags: + - DBRPs + /api/v2/dbrps/{dbrpID}: + delete: + operationId: DeleteDBRPID + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: Specifies the organization ID of the mapping + in: query + name: orgID + schema: + type: string + - description: Specifies the organization name of the mapping + in: query + name: org + schema: + type: string + - description: The database retention policy mapping + in: path + name: dbrpID + required: true + schema: + type: string + responses: + '204': + description: Delete has been accepted + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: if any of the IDs passed is invalid + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Delete a database retention policy + tags: + - DBRPs + get: + operationId: GetDBRPsID + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: Specifies the organization ID of the mapping + in: query + name: orgID + schema: + type: string + - description: Specifies the organization name of the mapping + in: query + name: org + schema: + type: string + - description: The database retention policy mapping ID + in: path + name: dbrpID + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DBRPGet' + description: The database retention policy requested + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: if any of the IDs passed is invalid + 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: Specifies the organization ID of the mapping + in: query + name: orgID + schema: + type: string + - description: Specifies the organization name of the mapping + in: query + name: org + schema: + type: string + - description: The database retention policy mapping. + in: path + name: dbrpID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DBRPUpdate' + description: Database retention policy update to apply + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DBRPGet' + description: An updated mapping + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: if any of the IDs passed is invalid + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: The mapping was not found + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Update a database retention policy mapping + tags: + - DBRPs + /api/v2/delete: + post: + operationId: PostDelete + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: Specifies the organization to delete data from. + in: query + name: org + schema: + description: Only points from this organization are deleted. + type: string + - description: Specifies the bucket to delete data from. + in: query + name: bucket + schema: + description: Only points from this bucket are deleted. + type: string + - description: Specifies the organization ID of the resource. + in: query + name: orgID + schema: + type: string + - description: Specifies the bucket ID to delete data from. + in: query + name: bucketID + schema: + description: Only points from this bucket ID are deleted. + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DeletePredicateRequest' + description: Deletes data from an InfluxDB bucket. + required: true + responses: + '204': + description: delete has been accepted + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Invalid request. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: no token was sent or does not have sufficient permissions. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: the bucket or organization is not found. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: internal server error + summary: Delete data + tags: + - Delete + /api/v2/experimental/sampledata/buckets: + get: + operationId: GetDemoDataBuckets + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DemoDataBuckets' + description: A list of demo data buckets + default: + $ref: '#/components/responses/ServerError' + description: Unexpected error + summary: List of Demo Data Buckets + tags: + - DemoDataBuckets + /api/v2/experimental/sampledata/buckets/{bucketID}/members: + delete: + operationId: DeleteDemoDataBucketMembers + parameters: + - description: bucket id + in: path + name: bucketID + required: true + schema: + type: string + responses: + '200': + description: if sampledata route is not available gateway responds with 200 + '204': + description: A list of demo data buckets + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: List of Demo Data Buckets + tags: + - DemoDataBuckets + post: + operationId: GetDemoDataBucketMembers + parameters: + - description: bucket id + in: path + name: bucketID + required: true + schema: + type: string + responses: + '200': + description: if sampledata route is not available gateway responds with 200 + '204': + description: A list of demo data buckets + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: List of Demo Data Buckets + tags: + - DemoDataBuckets + /api/v2/flags: + get: + operationId: GetFlags + parameters: + - $ref: '#/components/parameters/TraceSpan' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Flags' + description: Feature flags for the currently authenticated user + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Return the feature flags for the currently authenticated user + tags: + - Users + /api/v2/labels: + get: + operationId: GetLabels + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The organization ID. + in: query + name: orgID + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/LabelsResponse' + description: A list of labels + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: List all labels + tags: + - Labels + post: + operationId: PostLabels + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LabelCreateRequest' + description: Label to create + required: true + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/LabelResponse' + description: Added label + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Create a label + tags: + - Labels + /api/v2/labels/{labelID}: + delete: + operationId: DeleteLabelsID + parameters: + - $ref: '#/components/parameters/TraceSpan' + - 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: Label not found + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Delete a label + tags: + - Labels + get: + operationId: GetLabelsID + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The ID of the label to update. + in: path + name: labelID + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/LabelResponse' + description: A label + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Retrieve a label + tags: + - Labels + patch: + operationId: PatchLabelsID + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The ID of the label to update. + in: path + name: labelID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LabelUpdate' + description: Label update + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/LabelResponse' + description: Updated label + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Label not found + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Update a label + tags: + - Labels + /api/v2/maps/mapToken: + get: + operationId: getMapboxToken + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Token' + description: A temp token for Mapbox + '401': + $ref: '#/components/responses/ServerError' + '500': + $ref: '#/components/responses/ServerError' + default: + $ref: '#/components/responses/ServerError' + /api/v2/me: + get: + operationId: GetMe + parameters: + - $ref: '#/components/parameters/TraceSpan' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/UserResponse' + description: The currently authenticated user. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Retrieve the currently authenticated user + tags: + - Users + /api/v2/me/password: + put: + operationId: PutMePassword + parameters: + - $ref: '#/components/parameters/TraceSpan' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PasswordResetBody' + description: New password + required: true + responses: + '204': + description: Password successfully updated + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unsuccessful authentication + security: + - BasicAuthentication: [] + summary: Update a password + tags: + - Users + /api/v2/notificationEndpoints: + get: + operationId: GetNotificationEndpoints + parameters: + - $ref: '#/components/parameters/TraceSpan' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Limit' + - description: >- + Only show notification endpoints that belong to specific + organization ID. + in: query + name: orgID + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationEndpoints' + description: A list of notification endpoints + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: List all notification endpoints + tags: + - NotificationEndpoints + post: + operationId: CreateNotificationEndpoint + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PostNotificationEndpoint' + description: Notification endpoint to create + required: true + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationEndpoint' + description: Notification endpoint created + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Add a notification endpoint + tags: + - NotificationEndpoints + /api/v2/notificationEndpoints/{endpointID}: + delete: + operationId: DeleteNotificationEndpointsID + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The notification endpoint ID. + in: path + name: endpointID + required: true + schema: + type: string + responses: + '204': + description: Delete has been accepted + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: The endpoint was not found + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Delete a notification endpoint + tags: + - NotificationEndpoints + get: + operationId: GetNotificationEndpointsID + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The notification endpoint ID. + in: path + name: endpointID + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationEndpoint' + description: The notification endpoint requested + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Retrieve a notification endpoint + tags: + - NotificationEndpoints + patch: + operationId: PatchNotificationEndpointsID + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The notification endpoint ID. + in: path + name: endpointID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationEndpointUpdate' + description: Check update to apply + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationEndpoint' + description: An updated notification endpoint + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: The notification endpoint was not found + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Update a notification endpoint + tags: + - NotificationEndpoints + put: + operationId: PutNotificationEndpointsID + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The notification endpoint ID. + in: path + name: endpointID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationEndpoint' + description: A new notification endpoint to replace the existing endpoint with + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationEndpoint' + description: An updated notification endpoint + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: The notification endpoint was not found + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Update a notification endpoint + tags: + - NotificationEndpoints + /api/v2/notificationEndpoints/{endpointID}/labels: + get: + operationId: GetNotificationEndpointsIDLabels + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The notification endpoint ID. + in: path + name: endpointID + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/LabelsResponse' + description: A list of all labels for a notification endpoint + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: List all labels for a notification endpoint + tags: + - NotificationEndpoints + post: + operationId: PostNotificationEndpointIDLabels + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The notification endpoint ID. + in: path + name: endpointID + 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 was added to the notification endpoint + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Add a label to a notification endpoint + tags: + - NotificationEndpoints + /api/v2/notificationEndpoints/{endpointID}/labels/{labelID}: + delete: + operationId: DeleteNotificationEndpointsIDLabelsID + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The notification endpoint ID. + in: path + name: endpointID + 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: Endpoint or label not found + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Delete a label from a notification endpoint + tags: + - NotificationEndpoints + /api/v2/notificationRules: + get: + operationId: GetNotificationRules + parameters: + - $ref: '#/components/parameters/TraceSpan' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Limit' + - description: >- + Only show notification rules that belong to a specific organization + ID. + in: query + name: orgID + required: true + schema: + type: string + - description: Only show notifications that belong to the specific check ID. + in: query + name: checkID + schema: + type: string + - description: >- + Only return notification rules that "would match" statuses which + contain the tag key value pairs provided. + in: query + name: tag + schema: + example: env:prod + pattern: ^[a-zA-Z0-9_]+:[a-zA-Z0-9_]+$ + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationRules' + description: A list of notification rules + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: List all notification rules + tags: + - NotificationRules + post: + operationId: CreateNotificationRule + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PostNotificationRule' + description: Notification rule to create + required: true + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationRule' + description: Notification rule created + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Add a notification rule + tags: + - NotificationRules + /api/v2/notificationRules/{ruleID}: + delete: + operationId: DeleteNotificationRulesID + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The notification rule ID. + in: path + name: ruleID + required: true + schema: + type: string + responses: + '204': + description: Delete has been accepted + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: The check was not found + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Delete a notification rule + tags: + - NotificationRules + get: + operationId: GetNotificationRulesID + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The notification rule ID. + in: path + name: ruleID + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationRule' + description: The notification rule requested + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Retrieve a notification rule + tags: + - NotificationRules + patch: + operationId: PatchNotificationRulesID + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The notification rule ID. + in: path + name: ruleID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationRuleUpdate' + description: Notification rule update to apply + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationRule' + description: An updated notification rule + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: The notification rule was not found + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Update a notification rule + tags: + - NotificationRules + put: + operationId: PutNotificationRulesID + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The notification rule ID. + in: path + name: ruleID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationRule' + description: Notification rule update to apply + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationRule' + description: An updated notification rule + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: The notification rule was not found + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Update a notification rule + tags: + - NotificationRules + /api/v2/notificationRules/{ruleID}/labels: + get: + operationId: GetNotificationRulesIDLabels + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The notification rule ID. + in: path + name: ruleID + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/LabelsResponse' + description: A list of all labels for a notification rule + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: List all labels for a notification rule + tags: + - NotificationRules + post: + operationId: PostNotificationRuleIDLabels + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The notification rule ID. + in: path + name: ruleID + 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 was added to the notification rule + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Add a label to a notification rule + tags: + - NotificationRules + /api/v2/notificationRules/{ruleID}/labels/{labelID}: + delete: + operationId: DeleteNotificationRulesIDLabelsID + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The notification rule ID. + in: path + name: ruleID + 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: Rule or label not found + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Delete label from a notification rule + tags: + - NotificationRules + /api/v2/notificationRules/{ruleID}/query: + get: + operationId: GetNotificationRulesIDQuery + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The notification rule ID. + in: path + name: ruleID + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/FluxResponse' + description: The notification rule query requested + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Invalid request + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Notification rule not found + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Retrieve a notification rule query + tags: + - Rules + /api/v2/orgs: + get: + operationId: GetOrgs + parameters: + - $ref: '#/components/parameters/TraceSpan' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Limit' + - $ref: '#/components/parameters/Descending' + - description: Filter organizations to a specific organization name. + in: query + name: org + schema: + type: string + - description: Filter organizations to a specific organization ID. + in: query + name: orgID + schema: + type: string + - description: Filter organizations to a specific user ID. + in: query + name: userID + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Organizations' + description: A list of organizations + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: List all organizations + tags: + - Organizations + post: + operationId: PostOrgs + parameters: + - $ref: '#/components/parameters/TraceSpan' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PostOrganizationRequest' + description: Organization to create + required: true + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/Organization' + description: Organization created + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Create an organization + tags: + - Organizations + /api/v2/orgs/{orgID}: + delete: + 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: Delete has been accepted + '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: Delete an organization + tags: + - Organizations + get: + operationId: GetOrgsID + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The ID of the organization to get. + in: path + name: orgID + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Organization' + description: Organization details + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Retrieve an organization + tags: + - Organizations + patch: + operationId: PatchOrgsID + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The ID of the organization to get. + in: path + name: orgID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchOrganizationRequest' + description: Organization update to apply + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Organization' + description: Organization updated + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Update an organization + tags: + - Organizations + /api/v2/orgs/{orgID}/limits: + get: + parameters: + - description: The identifier 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: The Limits defined for the organization. + default: + $ref: '#/components/responses/ServerError' + description: unexpected error + summary: Retrieve limits for an organization + tags: + - Limits + /api/v2/orgs/{orgID}/members: + get: + operationId: GetOrgsIDMembers + 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/ResourceMembers' + description: A list of organization members + '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 members of an organization + tags: + - Organizations + post: + operationId: PostOrgsIDMembers + 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/AddResourceMemberRequestBody' + description: User to add as member + required: true + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/ResourceMember' + description: Added to organization created + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Add a member to an organization + tags: + - Organizations + /api/v2/orgs/{orgID}/members/{userID}: + delete: + operationId: DeleteOrgsIDMembersID + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The ID of the member to remove. + in: path + name: userID + required: true + schema: + type: string + - description: The organization ID. + in: path + name: orgID + 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 an organization + tags: + - Organizations + /api/v2/orgs/{orgID}/owners: + get: + operationId: GetOrgsIDOwners + 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/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: + operationId: PostOrgsIDOwners + 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/AddResourceMemberRequestBody' + description: User to add as owner + required: true + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/ResourceOwner' + description: Organization owner added + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Add an owner to an organization + tags: + - Organizations + /api/v2/orgs/{orgID}/owners/{userID}: + delete: + operationId: DeleteOrgsIDOwnersID + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The ID of the owner to remove. + in: path + name: userID + required: true + schema: + type: string + - description: The organization ID. + in: path + name: orgID + 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 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/ServerError' + 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: + parameters: + - description: The identifier of the organization. + in: path + name: orgID + required: true + schema: + type: string + - description: start time + in: query + name: start + required: true + schema: + type: timestamp + - description: stop time + in: query + name: stop + required: false + schema: + type: timestamp + - 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: >- + The Content-Encoding entity header is used to compress the + media-type. When present, its value indicates which encodings + were applied to the entity-body + schema: + default: identity + description: >- + Specifies that the response in the body is encoded with gzip + or not encoded with identity. + enum: + - gzip + - identity + type: string + default: + $ref: '#/components/responses/ServerError' + description: unexpected error + summary: Retrieve usage for an organization + tags: + - Usage + /ping: + get: + operationId: GetPing + responses: + '204': + description: OK + headers: + X-Influxdb-Build: + description: The type of InfluxDB build. + schema: + type: string + X-Influxdb-Version: + description: The version of InfluxDB. + schema: + type: integer + servers: + - url: '' + summary: Checks the status of InfluxDB instance and version of InfluxDB. + tags: + - Ping + head: + operationId: HeadPing + responses: + '204': + description: OK + headers: + X-Influxdb-Build: + description: The type of InfluxDB build. + schema: + type: string + X-Influxdb-Version: + description: The version of InfluxDB. + schema: + type: integer + servers: + - url: '' + summary: Checks the status of InfluxDB instance and version of InfluxDB. + tags: + - Ping + /api/v2/query: + post: + description: > + Retrieves data from InfluxDB buckets. - Use HTTP Basic Auth with clients that support the InfluxDB 1.x convention of username and password (that don't support the `Authorization: Token` scheme): - - **username**: InfluxDB Cloud username - - **password**: InfluxDB Cloud API token - ### Example + To query data, you need the following: - `curl --get "https://europe-west1-1.gcp.cloud2.influxdata.com/query" - --user "YOUR_USERNAME":"YOUR_TOKEN_OR_PASSWORD"` + - **organization** – _See [View + organizations](https://docs.influxdata.com/influxdb/cloud/organizations/view-orgs/#view-your-organization-id) + for instructions on viewing your organization ID._ - For more information and examples, see how to [authenticate with a username and password scheme](https://docs.influxdata.com/influxdb/cloud/reference/api/influxdb-1x/). - QuerystringAuthentication: - type: apiKey - in: query - name: u=&p= - description: | - ### Querystring authentication scheme + - **API token** – _See [View + tokens](https://docs.influxdata.com/influxdb/cloud/security/tokens/view-tokens/) + for instructions on viewing your API token._ + - **InfluxDB URL** – _See [InfluxDB + URLs](https://docs.influxdata.com/influxdb/cloud/reference/urls/)_. - Use InfluxDB 1.x API parameters to provide credentials through the query string. + - **Flux query** – _See [Flux](https://docs.influxdata.com/flux/v0.x/)._ - Username and password schemes require the following credentials: - - **username**: InfluxDB Cloud username - - **password**: InfluxDB Cloud API token - ### Example + For more information and examples, see [Query with the InfluxDB + API](https://docs.influxdata.com/influxdb/cloud/query-data/execute-queries/influx-api/). + operationId: PostQuery + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: >- + The Accept-Encoding request HTTP header advertises which content + encoding, usually a compression algorithm, the client is able to + understand. + in: header + name: Accept-Encoding + schema: + default: identity + description: >- + Specifies that the query response in the body should be encoded + with gzip or not encoded with identity. + enum: + - gzip + - identity + type: string + - in: header + name: Content-Type + schema: + enum: + - application/json + - application/vnd.flux + type: string + - description: >- + Specifies the name of the organization executing the query. Takes + either the ID or Name. If both `orgID` and `org` are specified, + `org` takes precedence. + in: query + name: org + schema: + type: string + - description: >- + Specifies the ID of the organization executing the query. If both + `orgID` and `org` are specified, `org` takes precedence. + in: query + name: orgID + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Query' + application/vnd.flux: + example: | + from(bucket: "example-bucket") + |> range(start: -5m) + |> filter(fn: (r) => r._measurement == "example-measurement") + schema: + type: string + description: Flux query or specification to execute + responses: + '200': + content: + application/vnd.influx.arrow: + schema: + format: binary + type: string + text/csv: + schema: + example: > + result,table,_start,_stop,_time,region,host,_value + mean,0,2018-05-08T20:50:00Z,2018-05-08T20:51:00Z,2018-05-08T20:50:00Z,east,A,15.43 + mean,0,2018-05-08T20:50:00Z,2018-05-08T20:51:00Z,2018-05-08T20:50:20Z,east,B,59.25 + mean,0,2018-05-08T20:50:00Z,2018-05-08T20:51:00Z,2018-05-08T20:50:40Z,east,C,52.62 + type: string + description: Success. Returns query results. + headers: + Content-Encoding: + description: >- + The Content-Encoding entity header is used to compress the + media-type. When present, its value indicates which encodings + were applied to the entity-body + schema: + default: identity + description: >- + Specifies that the response in the body is encoded with gzip + or not encoded with identity. + enum: + - gzip + - identity + type: string + Trace-Id: + description: >- + The Trace-Id header reports the request's trace ID, if one was + generated. + schema: + description: Specifies the request's trace ID. + type: string + '429': + description: >- + Token is temporarily over quota. The Retry-After header describes + when to try the read 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 data + tags: + - Query + /api/v2/query/analyze: + post: + 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: + schema: + $ref: '#/components/schemas/AnalyzeQueryResponse' + description: Query analyze results. Errors will be empty if the query is valid. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Internal server error + headers: + X-Influx-Error: + description: Error string describing the problem + schema: + type: string + X-Influx-Reference: + description: Reference code unique to the error type + schema: + type: integer + summary: Analyze a Flux query + tags: + - Query + /api/v2/query/ast: + post: + description: Analyzes flux query and generates a query specification. + 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: Analyzed Flux query to generate abstract syntax tree. + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ASTResponse' + description: Abstract syntax tree of the flux query. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Any response other than 200 is an internal server error + summary: Generate an Abstract Syntax Tree (AST) from a query + tags: + - Query + /api/v2/query/suggestions: + get: + operationId: GetQuerySuggestions + parameters: + - $ref: '#/components/parameters/TraceSpan' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/FluxSuggestions' + description: Suggestions for next functions in call chain + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Any response other than 200 is an internal server error + summary: Retrieve query suggestions + tags: + - Query + /api/v2/query/suggestions/{name}: + get: + operationId: GetQuerySuggestionsName + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The name of the branching suggestion. + in: path + name: name + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/FluxSuggestion' + description: Suggestions for next functions in call chain + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Any response other than 200 is an internal server error + summary: Retrieve query suggestions 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 + /api/v2/scripts: + get: + operationId: GetScripts + parameters: + - description: The number of scripts to return. + in: query + name: limit + required: false + schema: + type: integer + - description: The offset for pagination. + in: query + name: offset + required: false + schema: + type: integer + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Scripts' + description: The list of scripts. + default: + $ref: '#/components/responses/ServerError' + description: Unexpected error + summary: List scripts + tags: + - Invocable Scripts + post: + operationId: PostScripts + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ScriptCreateRequest' + description: The script to create. + required: true + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/Script' + description: The created script. + default: + $ref: '#/components/responses/ServerError' + description: Unexpected error + summary: Create a script + tags: + - Invocable Scripts + /api/v2/scripts/{scriptID}: + delete: + description: Deletes a script and all associated records. + operationId: DeleteScriptsID + parameters: + - description: The ID of the script to delete. + in: path + name: scriptID + required: true + schema: + type: string + responses: + '204': + description: The script is deleted. + default: + $ref: '#/components/responses/ServerError' + description: Unexpected error + summary: Delete a script + tags: + - Invocable Scripts + get: + description: Uses script ID to retrieve details of an invocable script. + operationId: GetScriptsID + parameters: + - description: The script ID. + in: path + name: scriptID + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Script' + description: The requested script object. + default: + $ref: '#/components/responses/ServerError' + description: Unexpected error + summary: Retrieve a script + tags: + - Invocable Scripts + patch: + description: > + Updates properties (`name`, `description`, and `script`) of an invocable + script. + operationId: PatchScriptsID + parameters: + - description: The script ID. + in: path + name: scriptID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ScriptUpdateRequest' + description: Script update to apply + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Script' + description: The updated script. + default: + $ref: '#/components/responses/ServerError' + description: Unexpected error + summary: Update a script + tags: + - Invocable Scripts + /api/v2/scripts/{scriptID}/invoke: + post: + description: >- + Invokes a script and substitutes `params` keys referenced in the script + with `params` key-values sent in the request body. + operationId: PostScriptsIDInvoke + parameters: + - in: path + name: scriptID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ScriptInvocationParams' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ScriptHTTPResponseData' + description: The result of the script execution. + default: + $ref: '#/components/responses/ServerError' + description: Unexpected error + summary: Invoke a script + tags: + - Invocable Scripts + /api/v2/setup: + get: + description: >- + Check if setup is allowed. Returns `true` if no default user, + organization, or bucket have been created. + operationId: GetSetup + parameters: + - $ref: '#/components/parameters/TraceSpan' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/IsOnboarding' + description: Setup is allowed, true or false + summary: Retrieve setup status + tags: + - Setup + post: + description: >- + Post an onboarding request to create an initial user, organization, and + bucket. + operationId: PostSetup + parameters: + - $ref: '#/components/parameters/TraceSpan' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/OnboardingRequest' + description: Source to create + required: true + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/OnboardingResponse' + description: The created default user, bucket, and organization + default: + $ref: '#/components/responses/ServerError' + description: Unexpected error + summary: Create an initial user, organization, and bucket + tags: + - Setup + /api/v2/setup/user: + post: + description: >- + Post an onboarding request to create a new user, organization, and + bucket. + operationId: PostSetupUser + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/OnboardingRequest' + description: Source to create + required: true + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/OnboardingResponse' + description: The created default user, bucket, and organization. + default: + $ref: '#/components/responses/ServerError' + description: Unexpected error + summary: Create a new user, organization, and bucket + tags: + - Setup + /api/v2/signin: + post: + description: >- + Authenticates ***Basic Auth*** credentials for a user. If successful, + creates a new UI session for the user. + operationId: PostSignin + parameters: + - $ref: '#/components/parameters/TraceSpan' + responses: + '204': + description: Success. User authenticated. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unauthorized access. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: User account is disabled. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unsuccessful authentication. + security: + - BasicAuthentication: [] + summary: Create a user session. + tags: + - Signin + /api/v2/signout: + post: + description: Expires the current UI session for the user. + operationId: PostSignout + parameters: + - $ref: '#/components/parameters/TraceSpan' + responses: + '204': + description: Session successfully expired + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unauthorized access + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unsuccessful session expiry + summary: Expire the current UI session + tags: + - Signout + /api/v2/stacks: + get: + operationId: ListStacks + parameters: + - description: The organization ID of the stacks + in: query + name: orgID + required: true + schema: + type: string + - description: A collection of names to filter the list by. + in: query + name: name + schema: + type: string + - description: A collection of stackIDs to filter the list by. + 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. Returns the list of stacks. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: List installed templates + tags: + - Templates + post: + 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. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Create a new 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: + operationId: GetTasks + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: Returns task with a specific name. + in: query + name: name + schema: + type: string + - description: Return tasks after a specified ID. + in: query + name: after + schema: + type: string + - description: Filter tasks to a specific user ID. + in: query + name: user + schema: + type: string + - description: Filter tasks to a specific organization name. + in: query + name: org + schema: + type: string + - description: Filter tasks to a specific organization ID. + in: query + name: orgID + schema: + type: string + - description: Filter tasks by a status--"inactive" or "active". + in: query + name: status + schema: + enum: + - active + - inactive + type: string + - description: The non-zero number of tasks to return + in: query + name: limit + schema: + default: 100 + maximum: 500 + minimum: -1 + type: integer + - description: Type of task, unset by default. + in: query + name: type + required: false + schema: + default: '' + enum: + - basic + - system + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Tasks' + description: A list of tasks + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: List all tasks + tags: + - Tasks + post: + operationId: PostTasks + parameters: + - $ref: '#/components/parameters/TraceSpan' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TaskCreateRequest' + description: Task to create + required: true + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/Task' + description: Task created + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Create a new task + tags: + - Tasks + /api/v2/tasks/{taskID}: + delete: + description: Deletes a task and all associated records + operationId: DeleteTasksID + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The ID of the task to delete. + in: path + name: taskID + required: true + schema: + type: string + responses: + '204': + description: Task deleted + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Delete a task + tags: + - Tasks + get: + operationId: GetTasksID + 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/Task' + description: Task details + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Retrieve a task + tags: + - Tasks + patch: + description: Update a task. This will cancel all queued runs. + operationId: PatchTasksID + 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/TaskUpdateRequest' + description: Task update to apply + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Task' + description: Task updated + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Update a task + tags: + - Tasks + /api/v2/tasks/{taskID}/labels: + get: + operationId: GetTasksIDLabels + 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/LabelsResponse' + description: A list of all labels for a task + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: List all labels for a task + tags: + - Tasks + post: + operationId: PostTasksIDLabels + 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/LabelMapping' + description: Label to add + required: true + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/LabelResponse' + description: A list of all labels for a task + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Add a label to a task + tags: + - Tasks + /api/v2/tasks/{taskID}/labels/{labelID}: + delete: + operationId: DeleteTasksIDLabelsID + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The task ID. + in: path + name: taskID + 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: Task not found + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Delete a label from a task + tags: + - Tasks + /api/v2/tasks/{taskID}/logs: + get: + 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: + schema: + $ref: '#/components/schemas/Logs' + description: All logs for a task + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Retrieve all logs for a task + tags: + - Tasks + /api/v2/tasks/{taskID}/members: + get: + 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: A list of users who have member privileges for a task + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: List all task members + tags: + - Tasks + post: + 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: User to add as member + required: true + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/ResourceMember' + description: 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: + 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: + operationId: GetTasksIDOwners + 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/ResourceOwners' + description: A list of users who have owner privileges for a task + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: List all owners of a task + tags: + - Tasks + post: + 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: User to add as owner + required: true + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/ResourceOwner' + description: Added to task owners + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Add an owner to a task + tags: + - Tasks + /api/v2/tasks/{taskID}/owners/{userID}: + delete: + 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: + operationId: GetTasksIDRuns + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The ID of the task to get runs for. + in: path + name: taskID + required: true + schema: + type: string + - description: Returns runs after a specific ID. + in: query + name: after + schema: + type: string + - description: The number of runs to return + in: query + name: limit + schema: + default: 100 + maximum: 500 + minimum: 1 + type: integer + - description: Filter runs to those scheduled after this time, RFC3339 + in: query + name: afterTime + schema: + format: date-time + type: string + - description: Filter runs to those scheduled before this time, RFC3339 + in: query + name: beforeTime + schema: + format: date-time + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Runs' + description: A list of task runs + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: List runs for a task + tags: + - Tasks + post: + 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: Run scheduled to start + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Manually start a task run, overriding the current schedule + tags: + - Tasks + /api/v2/tasks/{taskID}/runs/{runID}: + delete: + operationId: DeleteTasksIDRunsID + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The task ID. + in: path + name: taskID + required: true + schema: + type: string + - description: The run ID. + in: path + name: runID + 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: Cancel a running task + tags: + - Tasks + get: + operationId: GetTasksIDRunsID + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The task ID. + in: path + name: taskID + required: true + schema: + type: string + - description: The run ID. + in: path + name: runID + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Run' + description: The run record + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Retrieve a single run for a task + tags: + - Tasks + /api/v2/tasks/{taskID}/runs/{runID}/logs: + get: + operationId: GetTasksIDRunsIDLogs + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: ID of task to get logs for. + in: path + name: taskID + required: true + schema: + type: string + - description: ID of run to get logs for. + in: path + name: runID + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Logs' + description: All logs for a run + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Retrieve all logs for a run + tags: + - Tasks + /api/v2/tasks/{taskID}/runs/{runID}/retry: + post: + operationId: PostTasksIDRunsIDRetry + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The task ID. + in: path + name: taskID + required: true + schema: + type: string + - description: The run ID. + in: path + name: runID + required: true + schema: + type: string + requestBody: + content: + application/json; charset=utf-8: + schema: + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Run' + description: Run that has been queued + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Retry a task run + tags: + - Tasks + /api/v2/telegraf/plugins: + get: + operationId: GetTelegrafPlugins + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The type of plugin desired. + in: query + name: type + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TelegrafPlugins' + description: A list of Telegraf plugins. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: List all Telegraf plugins + tags: + - 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/TelegrafRequest' + 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/TelegrafRequest' + 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 or performs a dry-run of template in an organization. + operationId: ApplyTemplate + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TemplateApply' + application/x-jsonnet: + schema: + $ref: '#/components/schemas/TemplateApply' + text/yml: + schema: + $ref: '#/components/schemas/TemplateApply' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TemplateSummary' + description: > + Success. The package dry-run succeeded. No new resources were + created. Returns a diff and summary of the dry-run. 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 package applied successfully. Returns a diff and + summary of the run. The summary contains newly created resources. + The diff compares the initial state to the state after the package + applied. This corresponds to `"dryRun": true`. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Apply or dry-run a template + tags: + - Templates + /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: + get: + operationId: GetUsers + parameters: + - $ref: '#/components/parameters/TraceSpan' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Users' + description: A list of users + default: + $ref: '#/components/responses/ServerError' + description: Unexpected error + summary: List all users + tags: + - Users + post: + operationId: PostUsers + parameters: + - $ref: '#/components/parameters/TraceSpan' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/User' + description: User to create + required: true + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/UserResponse' + description: User created + default: + $ref: '#/components/responses/ServerError' + description: Unexpected error + summary: Create a user + tags: + - Users + /api/v2/users/{userID}: + delete: + operationId: DeleteUsersID + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The ID of the user to delete. + in: path + name: userID + required: true + schema: + type: string + responses: + '204': + description: User deleted + default: + $ref: '#/components/responses/ServerError' + description: Unexpected error + summary: Delete a user + tags: + - Users + get: + operationId: GetUsersID + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The user ID. + in: path + name: userID + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/UserResponse' + description: User details + default: + $ref: '#/components/responses/ServerError' + description: Unexpected error + summary: Retrieve a user + tags: + - Users + patch: + operationId: PatchUsersID + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The ID of the user to update. + in: path + name: userID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/User' + description: User update to apply + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/UserResponse' + description: User updated + default: + $ref: '#/components/responses/ServerError' + description: Unexpected error + summary: Update a user + tags: + - Users + /api/v2/users/{userID}/password: + post: + operationId: PostUsersIDPassword + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The user ID. + in: path + name: userID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PasswordResetBody' + description: New password + required: true + responses: + '204': + description: Password successfully updated + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unsuccessful authentication + security: + - BasicAuthentication: [] + summary: Update a password + tags: + - Users + /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/ServerError' + description: Invalid request + default: + $ref: '#/components/responses/ServerError' + 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/ServerError' + 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/ServerError' + 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/ServerError' + description: Variable not found + default: + $ref: '#/components/responses/ServerError' + 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/ServerError' + 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/ServerError' + 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. - `curl --get "https://europe-west1-1.gcp.cloud2.influxdata.com/query" - --data-urlencode "u=YOUR_USERNAME" - --data-urlencode "p=YOUR_TOKEN_OR_PASSWORD"` - For more information and examples, see how to [authenticate with a username and password scheme](https://docs.influxdata.com/influxdb/cloud/reference/api/influxdb-1x/). + To write data into InfluxDB, you need the following: + + + - **organization name or ID** – _See [View + organizations](https://docs.influxdata.com/influxdb/cloud/organizations/view-orgs/#view-your-organization-id) + for instructions on viewing your organization ID._ + + - **bucket** – _See [View + buckets](https://docs.influxdata.com/influxdb/cloud/organizations/buckets/view-buckets/) + for + instructions on viewing your bucket ID._ + - **API token** – _See [View + tokens](https://docs.influxdata.com/influxdb/cloud/security/tokens/view-tokens/) + for instructions on viewing your API token._ + - **InfluxDB URL** – _See [InfluxDB + URLs](https://docs.influxdata.com/influxdb/cloud/reference/urls/)_. + + - data in [line + protocol](https://docs.influxdata.com/influxdb/cloud/reference/syntax/line-protocol) + format. + + + For more information and examples, see [Write data with the InfluxDB + API](https://docs.influxdata.com/influxdb/cloud/write-data/developer-tools/api). + operationId: PostWrite + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: >- + When present, the header value tells the database that compression + is applied to the line protocol in the request body. + in: header + name: Content-Encoding + schema: + default: identity + description: >- + The header value specifies that the line protocol in the request + body is encoded with gzip or not encoded with identity. + enum: + - gzip + - identity + type: string + - description: >- + The header value indicates the format of the data in the request + body. + in: header + name: Content-Type + schema: + default: text/plain; charset=utf-8 + description: > + `text/plain` specifies line protocol. `UTF-8` is the default + character set. + enum: + - text/plain + - text/plain; charset=utf-8 + - application/vnd.influx.arrow + type: string + - description: >- + The header value indicates the size of the entity-body, in bytes, + sent to the database. If the length is greater than the database's + `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 header value specifies the response format. + in: header + name: Accept + schema: + default: application/json + description: The response format for errors. + enum: + - application/json + type: string + - description: >- + The parameter value specifies the destination organization for + writes. The database writes all points in the batch to this + organization. If you provide both `orgID` and `org` parameters, + `org` takes precedence. + in: query + name: org + required: true + schema: + description: Organization name or ID. + type: string + - description: >- + The parameter value specifies the ID of the destination organization + for writes. If both `orgID` and `org` are specified, `org` takes + precedence. + in: query + name: orgID + schema: + type: string + - description: The destination bucket for writes. + in: query + name: bucket + required: true + schema: + description: All points within batch are written to this bucket. + type: string + - description: The precision for the unix timestamps within the body line-protocol. + in: query + name: precision + schema: + $ref: '#/components/schemas/WritePrecision' + requestBody: + content: + text/plain: + schema: + format: byte + type: string + description: Data in line protocol format. + required: true + responses: + '204': + description: >- + InfluxDB validated the request data format and accepted the data for + writing to the bucket. `204` doesn't indicate a successful write + operation since writes are asynchronous. See [how to check for write + errors](https://docs.influxdata.com/influxdb/cloud/write-data/troubleshoot). + '400': + content: + application/json: + examples: + measurementSchemaFieldTypeConflict: + summary: Field type conflict thrown by an explicit bucket schema + value: + code: invalid + message: >- + partial write error (2 written): unable to parse + 'air_sensor,service=S1,sensor=L1 + temperature="90.5",humidity=70.0 1632850122': schema: + field type for field "temperature" not permitted by + schema; got String but expected Float + schema: + $ref: '#/components/schemas/LineProtocolError' + description: >- + Bad request. The line protocol data in the request is malformed. The + response body contains the first malformed line in the data. + InfluxDB rejected the batch and did not write any data. + '401': + content: + application/json: + examples: + tokenNotAuthorized: + summary: >- + Token is not authorized to access the organization or + resource + value: + code: unauthorized + message: unauthorized access + schema: + $ref: '#/components/schemas/Error' + 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 does not have sufficient permissions to write to this organization and bucket. + '404': + content: + application/json: + examples: + resource-not-found: + summary: Not found error + value: + code: not found + message: bucket "air_sensor" not found + schema: + $ref: '#/components/schemas/Error' + description: >- + Not found. A requested resource was not found. The response body + contains the requested resource type, e.g. `organization name` or + `bucket`, and name. + '413': + content: + text/html: + examples: + dataExceedsSizeLimit: + summary: Cloud response + value: | + + 413 Request Entity Too Large + +

    413 Request Entity Too Large

    +
    +
    nginx
    + + + schema: + type: string + description: >- + Request entity too large. The payload exceeded the 50MB size limit. + InfluxDB rejected the batch and did not write any data. + '429': + description: >- + The 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 + '500': + content: + application/json: + examples: + internalError: + summary: Internal error example + value: + code: internal error + schema: + $ref: '#/components/schemas/Error' + description: Internal server error. + '503': + description: >- + The 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: + $ref: '#/components/responses/ServerError' + summary: Write data + tags: + - Write security: - TokenAuthentication: [] - BasicAuthentication: [] - QuerystringAuthentication: [] +servers: + - url: / +tags: + - name: Authentication + 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) + + + x-traitTag: true + - name: Authorizations + description: > + Create and manage API tokens. An **authorization** associates a list of + permissions to an **organization** and provides a token for API access. To + assign a token to a specific user, scope the authorization to the user ID. + - Bucket Schemas + - Buckets + - Cells + - Checks + - Dashboards + - DBRPs + - Delete + - DemoDataBuckets + - name: Invocable Scripts + description: > + Manage and execute scripts as API endpoints in InfluxDB. + + + An API Invocable Script assigns your custom Flux script to a new InfluxDB + API endpoint for your organization. + + Invocable scripts let you execute your script as an HTTP request to the + endpoint. + + + Invocable scripts accept parameters. Add parameter references in your + script as `params.myparameter`. + + When you `invoke` your script, you send parameters as key-value pairs in + the `params` object. + + InfluxDB executes your script with the key-value pairs as arguments and + returns the result. + + + For more information and examples, see [Invoke custom + scripts](https://docs.influxdata.com/influxdb/cloud/api-guide/api-invocable-scripts). + - Labels + - Limits + - NotificationEndpoints + - NotificationRules + - Organizations + - Ping + - name: Query + description: | + Retrieve data, analyze queries, and get query suggestions. + - name: Quick start + description: Some quickness + x-traitTag: true + - name: Quick start + x-traitTag: true + description: > + See the [**API Quick + Start**](https://docs.influxdata.com/influxdb/cloud/api-guide/api_intro/) + to get up and running authenticating with tokens, writing to buckets, and + querying data. + + + [**InfluxDB API client + libraries**](https://docs.influxdata.com/influxdb/cloud/api-guide/client-libraries/) + are available for popular languages and ready to import into your + application. + - Resources + - name: Response codes + x-traitTag: true + description: > + The InfluxDB API uses 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 | | + + | `204` | No content | For a `POST` request, `204` + indicates that InfluxDB accepted the request and request data is valid. + Asynchronous operations, such as `write`, might not have completed yet. | + + | `400` | Bad request | `Authorization` header is + missing or malformed or the API token does not have permission for the + operation. | + + | `401` | Unauthorized | May indicate one of the + following:
  • `Authorization: Token` header is missing or + malformed
  • API token value is missing from the header
  • API + token does not have permission. For more information about token types and + permissions, see [Manage API + tokens](https://docs.influxdata.com/influxdb/cloud/security/tokens/)
    • + | + + | `404` | Not found | Requested resource was not + found. `message` in the response body provides details about the requested + resource. | + + | `413` | Request entity too large | Request payload exceeds the + size limit. | + + | `422` | Unprocessible 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. | + - Routes + - Rules + - Secrets + - Setup + - Signin + - Signout + - Tasks + - Telegraf Plugins + - Telegrafs + - Templates + - Usage + - Users + - Variables + - Views + - name: Write + description: | + Write time series data to buckets. +x-tagGroups: + - name: Overview + tags: + - Quick start + - Authentication + - Response codes + - name: Data I/O endpoints + tags: + - Write + - Query + - name: Resource endpoints + tags: + - Buckets + - Dashboards + - Tasks + - Resources + - name: Security and access endpoints + tags: + - Authorizations + - Organizations + - Users + - name: System information endpoints + tags: + - Ping + - Routes + - name: All endpoints + tags: + - Authorizations + - Bucket Schemas + - Buckets + - Cells + - Checks + - Dashboards + - DBRPs + - Delete + - DemoDataBuckets + - Invocable Scripts + - Labels + - Limits + - NotificationEndpoints + - NotificationRules + - Organizations + - Ping + - Query + - Resources + - Routes + - Rules + - Secrets + - Setup + - Signin + - Signout + - Tasks + - Telegraf Plugins + - Telegrafs + - Templates + - Usage + - Users + - Variables + - Views + - Write diff --git a/api-docs/generate-api-docs.sh b/api-docs/generate-api-docs.sh index fe2396000..317bb86e2 100755 --- a/api-docs/generate-api-docs.sh +++ b/api-docs/generate-api-docs.sh @@ -3,7 +3,7 @@ set -e # Get list of versions from directory names -versions="$(ls -d -- */ | grep -v 'node_modules' | grep -v 'plugins')" +versions="$(ls -d -- */ | grep -v 'node_modules' | grep -v 'openapi')" for version in $versions do @@ -46,12 +46,18 @@ weight: 304 # npm_config_yes=true npx overrides the prompt # and (vs. npx --yes) is compatible with npm@6 and npm@7. + openapiCLI="@redocly/openapi-cli" redocCLI="redoc-cli@0.12.3" npm --version + # Use Redoc's openapi-cli to regenerate the spec with custom decorations. + INFLUXDB_VERSION=$version npm_config_yes=true npx $openapiCLI bundle $version/ref.yml \ + --config=./.redocly.yaml \ + -o $version/ref.yml + # Use Redoc to generate the v2 API html - npm_config_yes=true npx $redocCLI bundle $version/swagger.yml \ + npm_config_yes=true npx $redocCLI bundle $version/ref.yml \ -t template.hbs \ --title="InfluxDB $titleVersion API documentation" \ --options.sortPropsAlphabetically \ diff --git a/api-docs/getswagger.sh b/api-docs/getswagger.sh index 0a23ad8cc..089527ca1 100755 --- a/api-docs/getswagger.sh +++ b/api-docs/getswagger.sh @@ -1,15 +1,15 @@ #!/bin/bash -e -# This script provides a simple way grab the latest fully resolved swagger files +# This script provides a simple way grab the latest fully resolved openapi (OAS, OpenAPI Specification) contract files # from the influxdata/openapi repo. # # Specify a context to retrieve (cloud, oss, v1compat, all). # Optionally specify: # - an OSS version as the second argument or using the -o flag. -# The version specifies where to write the updated swagger. +# The version specifies where to write the updated openapi. # The default version is the latest OSS version directory in the api-docs directory. # - a base URL using the -b flag. -# The baseURL specifies where to retrieve the swagger files from. +# The baseURL specifies where to retrieve the openapi files from. # The default baseUrl is the master branch of the influxdata/openapi repo. # For local development, pass your openapi directory using the file:/// protocol. # @@ -88,17 +88,17 @@ function showArgs { } function updateCloud { - echo "Updating Cloud swagger..." - curl ${verbose} ${baseUrl}/contracts/ref/cloud.yml -s -o cloud/swagger.yml + echo "Updating Cloud openapi..." + curl ${verbose} ${baseUrl}/contracts/ref/cloud.yml -s -o cloud/ref.yml } function updateOSS { - echo "Updating OSS ${ossVersion} swagger..." - mkdir -p ${ossVersion} && curl ${verbose} ${baseUrl}/contracts/ref/oss.yml -s -o $_/swagger.yml + echo "Updating OSS ${ossVersion} openapi..." + mkdir -p ${ossVersion} && curl ${verbose} ${baseUrl}/contracts/ref/oss.yml -s -o $_/ref.yml } function updateV1Compat { - echo "Updating Cloud and ${ossVersion} v1 compatibilty swagger..." + echo "Updating Cloud and ${ossVersion} v1 compatibilty openapi..." curl ${verbose} ${baseUrl}/contracts/swaggerV1Compat.yml -s -o cloud/swaggerV1Compat.yml mkdir -p ${ossVersion} && cp cloud/swaggerV1Compat.yml $_/swaggerV1Compat.yml } diff --git a/api-docs/openapi/content/cloud/info.yml b/api-docs/openapi/content/cloud/info.yml new file mode 100644 index 000000000..940ed8d8f --- /dev/null +++ b/api-docs/openapi/content/cloud/info.yml @@ -0,0 +1,3 @@ +title: Influx Cloud API Service +description: | + The InfluxDB v2 API provides a programmatic interface for all interactions with InfluxDB. Access the InfluxDB API using the `/api/v2/` endpoint. diff --git a/api-docs/openapi/content/cloud/security-schemes.yml b/api-docs/openapi/content/cloud/security-schemes.yml new file mode 100644 index 000000000..64d7105b8 --- /dev/null +++ b/api-docs/openapi/content/cloud/security-schemes.yml @@ -0,0 +1,56 @@ +TokenAuthentication: + type: http + scheme: token + bearerFormat: InfluxDB Token String + description: | + ### Token authentication scheme + + InfluxDB API tokens ensure secure interaction between users and data. A token belongs to an organization and identifies InfluxDB permissions within the organization. + + Include your API token in an `Authentication: Token YOUR_API_TOKEN` HTTP header with each request. + + ### Example + + `curl https://us-east-1-1.aws.cloud2.influxdata.com/ + --header "Authentication: Token YOUR_API_TOKEN"` + + For more information and examples, see the following: + - [Use tokens in API requests](https://docs.influxdata.com/influxdb/cloud/api-guide/api_intro/#authentication). + - [Manage API tokens](https://docs.influxdata.com/influxdb/cloud/security/tokens). + - [`/authorizations`](#tag/Authorizations) endpoint. +BasicAuthentication: + type: http + scheme: basic + description: | + ### Basic authentication scheme + + Use HTTP Basic Auth with clients that support the InfluxDB 1.x convention of username and password (that don't support the `Authorization: Token` scheme): + - **username**: InfluxDB Cloud username + - **password**: InfluxDB Cloud API token + + ### Example + + `curl --get "https://europe-west1-1.gcp.cloud2.influxdata.com/query" + --user "YOUR_USERNAME":"YOUR_TOKEN_OR_PASSWORD"` + + For more information and examples, see how to [authenticate with a username and password scheme](https://docs.influxdata.com/influxdb/cloud/reference/api/influxdb-1x/). +QuerystringAuthentication: + type: apiKey + in: query + name: u=&p= + description: | + ### Querystring authentication scheme + + Use InfluxDB 1.x API parameters to provide credentials through the query string. + + Username and password schemes require the following credentials: + - **username**: InfluxDB Cloud username + - **password**: InfluxDB Cloud API token + + ### Example + + `curl --get "https://europe-west1-1.gcp.cloud2.influxdata.com/query" + --data-urlencode "u=YOUR_USERNAME" + --data-urlencode "p=YOUR_TOKEN_OR_PASSWORD"` + + For more information and examples, see how to [authenticate with a username and password scheme](https://docs.influxdata.com/influxdb/cloud/reference/api/influxdb-1x/). diff --git a/api-docs/openapi/content/cloud/servers.yml b/api-docs/openapi/content/cloud/servers.yml new file mode 100644 index 000000000..f4d7a922c --- /dev/null +++ b/api-docs/openapi/content/cloud/servers.yml @@ -0,0 +1,8 @@ +- url: https://{baseurl} + description: InfluxDB Cloud 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 URL diff --git a/api-docs/openapi/content/cloud/tag-groups.yml b/api-docs/openapi/content/cloud/tag-groups.yml new file mode 100644 index 000000000..975b8831a --- /dev/null +++ b/api-docs/openapi/content/cloud/tag-groups.yml @@ -0,0 +1,26 @@ +- name: Overview + tags: + - Quick start + - Authentication + - Response codes +- name: Data I/O endpoints + tags: + - Write + - Query +- name: Resource endpoints + tags: + - Buckets + - Dashboards + - Tasks + - Resources +- name: Security and access endpoints + tags: + - Authorizations + - Organizations + - Users +- name: System information endpoints + tags: + - Ping + - Routes +- name: All endpoints + tags: [] diff --git a/api-docs/openapi/content/cloud/tags.yml b/api-docs/openapi/content/cloud/tags.yml new file mode 100644 index 000000000..18cd6f263 --- /dev/null +++ b/api-docs/openapi/content/cloud/tags.yml @@ -0,0 +1,58 @@ +- name: Quick start + description: Some quickness + x-traitTag: true +- name: Authentication + 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) + + x-traitTag: true +- name: Invocable Scripts + description: | + Manage and execute scripts as API endpoints in InfluxDB. + + An API Invocable Script assigns your custom Flux script to a new InfluxDB API endpoint for your organization. + Invocable scripts let you execute your script as an HTTP request to the endpoint. + + Invocable scripts accept parameters. Add parameter references in your script as `params.myparameter`. + When you `invoke` your script, you send parameters as key-value pairs in the `params` object. + InfluxDB executes your script with the key-value pairs as arguments and returns the result. + + For more information and examples, see [Invoke custom scripts](https://docs.influxdata.com/influxdb/cloud/api-guide/api-invocable-scripts). +- name: Quick start + x-traitTag: true + description: | + See the [**API Quick Start**](https://docs.influxdata.com/influxdb/cloud/api-guide/api_intro/) to get up and running authenticating with tokens, writing to buckets, and querying data. + + [**InfluxDB API client libraries**](https://docs.influxdata.com/influxdb/cloud/api-guide/client-libraries/) are available for popular languages and ready to import into your application. +- name: Response codes + x-traitTag: true + description: | + The InfluxDB API uses 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 | | + | `204` | No content | For a `POST` request, `204` indicates that InfluxDB accepted the request and request data is valid. Asynchronous operations, such as `write`, might not have completed yet. | + | `400` | Bad request | `Authorization` header is missing or malformed or the API token does not have permission for the operation. | + | `401` | Unauthorized | May indicate one of the following:
  • `Authorization: Token` header is missing or malformed
  • API token value is missing from the header
  • API token does not have permission. For more information about token types and permissions, see [Manage API tokens](https://docs.influxdata.com/influxdb/cloud/security/tokens/)
    • | + | `404` | Not found | Requested resource was not found. `message` in the response body provides details about the requested resource. | + | `413` | Request entity too large | Request payload exceeds the size limit. | + | `422` | Unprocessible 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: Query + description: | + Retrieve data, analyze queries, and get query suggestions. +- name: Write + description: | + Write time series data to buckets. +- name: Authorizations + description: | + Create and manage API tokens. An **authorization** associates a list of permissions to an **organization** and provides a token for API access. To assign a token to a specific user, scope the authorization to the user ID. diff --git a/api-docs/openapi/content/content.js b/api-docs/openapi/content/content.js new file mode 100644 index 000000000..9322b3090 --- /dev/null +++ b/api-docs/openapi/content/content.js @@ -0,0 +1,25 @@ +const path = require('path'); +const { toJSON } = require('../plugins/helpers/content-helper'); + +function getVersion(filename) { + return path.join(__dirname, process.env.INFLUXDB_VERSION, filename); +} + +const info = toJSON(getVersion('info.yml')); + +const securitySchemes = toJSON(getVersion('security-schemes.yml')); + +const servers = toJSON(path.join(__dirname, 'servers.yml')); + +const tags = toJSON(getVersion('tags.yml')); + +const tagGroups = toJSON(getVersion('tag-groups.yml')); + +module.exports = { + info, + securitySchemes, + servers, + tagGroups, + tags, +} + diff --git a/api-docs/openapi/content/servers.yml b/api-docs/openapi/content/servers.yml new file mode 100644 index 000000000..32cf3d7c0 --- /dev/null +++ b/api-docs/openapi/content/servers.yml @@ -0,0 +1 @@ +- url: '/' diff --git a/api-docs/openapi/content/v2.0/info.yml b/api-docs/openapi/content/v2.0/info.yml new file mode 100644 index 000000000..48eb41eae --- /dev/null +++ b/api-docs/openapi/content/v2.0/info.yml @@ -0,0 +1,3 @@ +title: Influx OSS API Service +description: | + The InfluxDB v2 API provides a programmatic interface for all interactions with InfluxDB. Access the InfluxDB API using the `/api/v2/` endpoint. diff --git a/api-docs/openapi/content/v2.0/security-schemes.yml b/api-docs/openapi/content/v2.0/security-schemes.yml new file mode 100644 index 000000000..b7390aca8 --- /dev/null +++ b/api-docs/openapi/content/v2.0/security-schemes.yml @@ -0,0 +1,58 @@ +TokenAuthentication: + type: http + scheme: token + bearerFormat: InfluxDB Token String + description: | + ### Token authentication scheme + + InfluxDB API tokens ensure secure interaction between users and data. A token belongs to an organization and identifies InfluxDB permissions within the organization. + + Include your API token in an `Authentication: Token YOUR_API_TOKEN` HTTP header with each request. + + ### Example + + `curl http://localhost:8086/ping + --header "Authentication: Token YOUR_API_TOKEN"` + + For more information and examples, see the following: + - [Use tokens in API requests](https://docs.influxdata.com/influxdb/v2.0/api-guide/api_intro/#authentication). + - [Manage API tokens](https://docs.influxdata.com/influxdb/v2.0/security/tokens). + - [`/authorizations`](#tag/Authorizations) endpoint. +BasicAuthentication: + type: http + scheme: basic + description: | + ### Basic authentication scheme + + Use HTTP Basic Auth with clients that support the InfluxDB 1.x convention of username and password (that don't support the `Authorization: Token` scheme). + + Username and password schemes require the following credentials: + - **username**: 1.x username (this is separate from the UI login username) + - **password**: 1.x password or InfluxDB API token + + ### Example + + `curl --get "http://localhost:8086/query" + --user "YOUR_1.x_USERNAME":"YOUR_TOKEN_OR_PASSWORD"` + + For more information and examples, see how to [authenticate with a username and password scheme](https://docs.influxdata.com/influxdb/v2.0/reference/api/influxdb-1x/) +QuerystringAuthentication: + type: apiKey + in: query + name: u=&p= + description: | + ### Querystring authentication scheme + + Use InfluxDB 1.x API parameters to provide credentials through the query string. + + Username and password schemes require the following credentials: + - **username**: 1.x username (this is separate from the UI login username) + - **password**: 1.x password or InfluxDB API token + + ### Example + + `curl --get "http://localhost:8086/query" + --data-urlencode "u=YOUR_1.x_USERNAME" + --data-urlencode "p=YOUR_TOKEN_OR_PASSWORD"` + + For more information and examples, see how to [authenticate with a username and password scheme](https://docs.influxdata.com/influxdb/v2.0/reference/api/influxdb-1x/) diff --git a/api-docs/openapi/content/v2.0/tag-groups.yml b/api-docs/openapi/content/v2.0/tag-groups.yml new file mode 100644 index 000000000..da30ad692 --- /dev/null +++ b/api-docs/openapi/content/v2.0/tag-groups.yml @@ -0,0 +1,28 @@ +- name: Overview + tags: + - Quick start + - Authentication + - Response codes +- name: Data I/O endpoints + tags: + - Write + - Query +- name: Resource endpoints + tags: + - Buckets + - Dashboards + - Tasks + - Resources +- name: Security and access endpoints + tags: + - Authorizations + - Organizations + - Users +- name: System information endpoints + tags: + - Health + - Ping + - Ready + - Routes +- name: All endpoints + tags: [] diff --git a/api-docs/openapi/content/v2.0/tags.yml b/api-docs/openapi/content/v2.0/tags.yml new file mode 100644 index 000000000..80c9055dd --- /dev/null +++ b/api-docs/openapi/content/v2.0/tags.yml @@ -0,0 +1,43 @@ +- name: Authentication + 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) + + x-traitTag: true +- name: Quick start + x-traitTag: true + description: | + See the [**API Quick Start**](https://docs.influxdata.com/influxdb/v2.0/api-guide/api_intro/) to get up and running authenticating with tokens, writing to buckets, and querying data. + + [**InfluxDB API client libraries**](https://docs.influxdata.com/influxdb/v2.0/api-guide/client-libraries/) are available for popular languages and ready to import into your application. +- name: Response codes + x-traitTag: true + description: | + The InfluxDB API uses 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 | | + | `204` | No content | For a `POST` request, `204` indicates that InfluxDB accepted the request and request data is valid. Asynchronous operations, such as `write`, might not have completed yet. | + | `400` | Bad request | `Authorization` header is missing or malformed or the API token does not have permission for the operation. | + | `401` | Unauthorized | May indicate one of the following:
  • `Authorization: Token` header is missing or malformed
  • API token value is missing from the header
  • API token does not have permission. For more information about token types and permissions, see [Manage API tokens](https://docs.influxdata.com/influxdb/v2.0/security/tokens/)
    • | + | `404` | Not found | Requested resource was not found. `message` in the response body provides details about the requested resource. | + | `413` | Request entity too large | Request payload exceeds the size limit. | + | `422` | Unprocessible 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: Query + description: | + Retrieve data, analyze queries, and get query suggestions. +- name: Write + description: | + Write time series data to buckets. +- name: Authorizations + description: | + Create and manage API tokens. An **authorization** associates a list of permissions to an **organization** and provides a token for API access. To assign a token to a specific user, scope the authorization to the user ID. diff --git a/api-docs/openapi/plugins/decorators/paths/remove-private-paths.js b/api-docs/openapi/plugins/decorators/paths/remove-private-paths.js new file mode 100644 index 000000000..12d3a7a25 --- /dev/null +++ b/api-docs/openapi/plugins/decorators/paths/remove-private-paths.js @@ -0,0 +1,17 @@ +module.exports = RemovePrivatePaths; + +/** @type {import('@redocly/openapi-cli').OasDecorator} */ +function RemovePrivatePaths() { + return { + PathItem: { + leave(pathItem, ctx) { + const private = /\/.*private/; + if(private.test(ctx.key)) { + delete ctx.parent[ctx.key]; + } + } + } + } +} + + diff --git a/api-docs/openapi/plugins/decorators/paths/strip-version-prefix.js b/api-docs/openapi/plugins/decorators/paths/strip-version-prefix.js new file mode 100644 index 000000000..407893f98 --- /dev/null +++ b/api-docs/openapi/plugins/decorators/paths/strip-version-prefix.js @@ -0,0 +1,28 @@ +module.exports = StripVersionPrefix; + +/** @type {import('@redocly/openapi-cli').OasDecorator} */ +function StripVersionPrefix() { + return { + PathMap: { + leave(paths, ctx) { + const nonversioned = [ + '/health', + '/legacy/authorizations', + '/legacy/authorizations/{authID}', + '/legacy/authorizations/{authID}/password', + '/ping', + '/ready' + ]; + const prefix = '/api/v2'; + nonversioned.forEach(function(nv) { + const path = JSON.stringify(paths[prefix + nv]); + if(path) { + delete paths[prefix + nv]; + paths[nv] = JSON.parse(path); + } + }); + } + } + } +} + diff --git a/api-docs/openapi/plugins/decorators/security/set-security-schemes.js b/api-docs/openapi/plugins/decorators/security/set-security-schemes.js new file mode 100644 index 000000000..78e2b362d --- /dev/null +++ b/api-docs/openapi/plugins/decorators/security/set-security-schemes.js @@ -0,0 +1,18 @@ +module.exports = SetSecuritySchemes; + +/** @type {import('@redocly/openapi-cli').OasDecorator} */ +function SetSecuritySchemes(options) { + return { + Components: { + leave(comps, ctx) { + if(options.data) { + comps.securitySchemes = comps.securitySchemes || {}; + Object.keys(options.data).forEach( + function(scheme) { + comps.securitySchemes[scheme] = options.data[scheme]; + }) + } + } + } + } +} diff --git a/api-docs/plugins/decorators/set-servers-url.js b/api-docs/openapi/plugins/decorators/servers/set-servers.js similarity index 52% rename from api-docs/plugins/decorators/set-servers-url.js rename to api-docs/openapi/plugins/decorators/servers/set-servers.js index 6dae81787..27f988793 100644 --- a/api-docs/plugins/decorators/set-servers-url.js +++ b/api-docs/openapi/plugins/decorators/servers/set-servers.js @@ -1,4 +1,4 @@ -module.exports = SetServersURL; +module.exports = SetServers; /** @type {import('@redocly/openapi-cli').OasDecorator} */ @@ -7,15 +7,12 @@ module.exports = SetServersURL; * The key instructs openapi when to invoke the key's Visitor object. * Object key "Server" is an OAS 3.0 node type. */ -function SetServersURL() { +function SetServers(options) { return { - Operation: { - leave(operation, ctx) { - const operations = ['GetRoutes'] - if(operations.includes(operation.operationId)) { - operation.servers = [{url: '/'}]; - } + DefinitionRoot: { + leave(root) { + root.servers = options.data; } - } + }, } }; diff --git a/api-docs/openapi/plugins/decorators/set-info.js b/api-docs/openapi/plugins/decorators/set-info.js new file mode 100644 index 000000000..3e4592127 --- /dev/null +++ b/api-docs/openapi/plugins/decorators/set-info.js @@ -0,0 +1,15 @@ +module.exports = SetInfo; + +/** @type {import('@redocly/openapi-cli').OasDecorator} */ +function SetInfo(options) { + return { + Info: { + leave(info, ctx) { + if(options.data) { + info.title = options.data.title; + info.description = options.data.description; + } + } + } + } +} diff --git a/api-docs/openapi/plugins/decorators/tags/set-tag-groups.js b/api-docs/openapi/plugins/decorators/tags/set-tag-groups.js new file mode 100644 index 000000000..3a0d84a9c --- /dev/null +++ b/api-docs/openapi/plugins/decorators/tags/set-tag-groups.js @@ -0,0 +1,44 @@ +module.exports = SetTagGroups; + +const { collect, getName, sortName } = require('../../helpers/content-helper.js') +/** + * Returns an object that defines handler functions for: + * - Operation nodes + * - DefinitionRoot (the root openapi) node + * The order of the two functions is significant. + * The Operation handler collects tags from the + * operation ('get', 'post', etc.) in every path. + * The DefinitionRoot handler, executed when + * the parser is leaving the root node, + * sets `x-tagGroups` to the provided `data` + * and sets the value of `All Endpoints` to the collected tags. + */ +/** @type {import('@redocly/openapi-cli').OasDecorator} */ +function SetTagGroups(options) { + let tags = []; + return { + Operation: { + leave(op, ctx, parents) { + tags = collect(tags, op.tags); + } + }, + DefinitionRoot: { + leave(root) { + root.tags = root.tags || []; + root.tags = collect(root.tags, tags) + .sort((a, b) => sortName(a, b)); + + if(!options.data) { return; } + + endpointTags = root.tags + .filter(t => !t['x-traitTag']) + .map(t => getName(t)); + root['x-tagGroups'] = options.data + .map(function(grp) { + grp.tags = grp.name === 'All endpoints' ? endpointTags : grp.tags; + return grp; + }); + } + } + } +}; diff --git a/api-docs/openapi/plugins/decorators/tags/set-tags.js b/api-docs/openapi/plugins/decorators/tags/set-tags.js new file mode 100644 index 000000000..de9eef03a --- /dev/null +++ b/api-docs/openapi/plugins/decorators/tags/set-tags.js @@ -0,0 +1,22 @@ +module.exports = SetTags; + +/** + * Returns an object that defines handler functions for: + * - DefinitionRoot (the root openapi) node + * The DefinitionRoot handler, executed when + * the parser is leaving the root node, + * sets the root `tags` list to the provided `data`. + */ +/** @type {import('@redocly/openapi-cli').OasDecorator} */ +function SetTags(options) { + let tags = []; + return { + DefinitionRoot: { + leave(root) { + if(options.data) { + root.tags = options.data; + } + } + } + } +}; diff --git a/api-docs/openapi/plugins/docs-plugin.js b/api-docs/openapi/plugins/docs-plugin.js new file mode 100644 index 000000000..75492c3f1 --- /dev/null +++ b/api-docs/openapi/plugins/docs-plugin.js @@ -0,0 +1,57 @@ +const ReportTags = require('./rules/report-tags'); +const ValidateServersUrl = require('./rules/validate-servers-url'); +const RemovePrivatePaths = require('./decorators/paths/remove-private-paths'); +const SetInfo = require('./decorators/set-info'); +const SetServers = require('./decorators/servers/set-servers'); +const SetSecuritySchemes = require('./decorators/security/set-security-schemes'); +const SetTags = require('./decorators/tags/set-tags'); +const SetTagGroups = require('./decorators/tags/set-tag-groups'); +const StripVersionPrefix = require('./decorators/paths/strip-version-prefix'); +const {info, securitySchemes, servers, tags, tagGroups } = require('../content/content') + +const id = 'docs'; + +/** @type {import('@redocly/openapi-cli').CustomRulesConfig} */ +const rules = { + oas3: { + 'validate-servers-url': ValidateServersUrl, + 'report-tags': ReportTags, + } +}; + +/** @type {import('@redocly/openapi-cli').CustomRulesConfig} */ +const decorators = { + oas3: { + 'set-servers': () => SetServers({data: servers}), + 'remove-private-paths': RemovePrivatePaths, + 'strip-version-prefix': StripVersionPrefix, + 'set-info': () => SetInfo({data: info}), + 'set-security': () => SetSecurity({data: security}), + 'set-security-schemes': () => SetSecuritySchemes({data: securitySchemes}), + 'set-tags': () => SetTags({data: tags}), + 'set-tag-groups': () => SetTagGroups({data: tagGroups}), + } +}; + +module.exports = { + id, + configs: { + all: { + rules: { + 'no-server-trailing-slash': 'off', + 'docs/validate-servers-url': 'error', + }, + decorators: { + 'docs/set-servers': 'error', + 'docs/remove-private-paths': 'error', + 'docs/strip-version-prefix': 'error', + 'docs/set-info': 'error', + 'docs/set-security-schemes': 'error', + 'docs/set-tags': 'error', + 'docs/set-tag-groups': 'error', + }, + }, + }, + decorators, + rules +}; diff --git a/api-docs/openapi/plugins/helpers/content-helper.js b/api-docs/openapi/plugins/helpers/content-helper.js new file mode 100644 index 000000000..ab195531f --- /dev/null +++ b/api-docs/openapi/plugins/helpers/content-helper.js @@ -0,0 +1,65 @@ +const yaml = require('js-yaml'); +const fs = require('fs'); + +function getName(item) { + if(typeof(item) === 'string') { + return item; + } + if(item.hasOwnProperty('name')) { + return item.name; + } +} + +function sortName(a, b) { + let nameA = getName(a) + nameA = nameA.toUpperCase(); + let nameB = getName(b) + nameB = nameB.toUpperCase(); + if(nameA < nameB) { + return -1; + } + if(nameA > nameB) { + return 1; + } + return 0; +} + +/** + * Returns true if item or item.name exists in collection + */ +function isPresent(collection, item) { + const itemName = getName(item); + return ( + collection.indexOf(itemName) > -1 + || collection.filter(ci => ci.name && ci.name === itemName).length > 0 + ); +} + +/** + * Merges items from Array items to Array collection and removes duplicates from collection. + * + */ +function collect(collection, items) { + if(Array.isArray(items)) { + collection = collection + .concat(items.filter(item => !isPresent(collection, item))); + } + return collection; +} + +function toJSON(yamlPath) { + try { + return yaml.load(fs.readFileSync(yamlPath, 'utf8')); + } catch (e) { + console.log(e); + } +} + +module.exports = { + collect, + getName, + isPresent, + sortName, + toJSON, +} + diff --git a/api-docs/openapi/plugins/rules/report-tags.js b/api-docs/openapi/plugins/rules/report-tags.js new file mode 100644 index 000000000..561e55773 --- /dev/null +++ b/api-docs/openapi/plugins/rules/report-tags.js @@ -0,0 +1,18 @@ +module.exports = ReportTags + + /** + * Reports on tags. + */ +/** @type {import('@redocly/openapi-cli').OasRule} */ +function ReportTags() { + return { + DefinitionRoot: { + Tag(node, ctx) { + ctx.report({ + message: `tags`, + location: ctx.location.pointer + }) + } + } + } +} diff --git a/api-docs/plugins/rules/validate-servers-url.js b/api-docs/openapi/plugins/rules/validate-servers-url.js similarity index 100% rename from api-docs/plugins/rules/validate-servers-url.js rename to api-docs/openapi/plugins/rules/validate-servers-url.js diff --git a/api-docs/package.json b/api-docs/package.json index 1758ebecb..1e81d828d 100755 --- a/api-docs/package.json +++ b/api-docs/package.json @@ -3,5 +3,8 @@ "name": "api-docs", "version": "1.0.0", "description": "InfluxDB API documentation", - "license": "MIT" + "license": "MIT", + "dependencies": { + "js-yaml": "^4.1.0" + } } diff --git a/api-docs/plugins/decorators/replace-servers-url.js b/api-docs/plugins/decorators/replace-servers-url.js deleted file mode 100644 index f7ae41bb2..000000000 --- a/api-docs/plugins/decorators/replace-servers-url.js +++ /dev/null @@ -1,20 +0,0 @@ -module.exports = ReplaceRootURL; - -/** @type {import('@redocly/openapi-cli').OasDecorator} */ - -/** - * Returns an object with keys in [node type, any, ref]. - * The key instructs openapi when to invoke the key's Visitor object. - * Object key "Server" is an OAS 3.0 node type. - */ -function ReplaceRootURL() { - return { - Operation: { - leave(operation, ctx) { - if(Array.isArray(operation.servers)) { - operation.servers.forEach(server => server.url = server.url === '' ? '/' : server.url); - } - } - } - } -}; diff --git a/api-docs/plugins/servers-plugin.js b/api-docs/plugins/servers-plugin.js deleted file mode 100644 index d308d7339..000000000 --- a/api-docs/plugins/servers-plugin.js +++ /dev/null @@ -1,28 +0,0 @@ -const ReplaceServersUrl = require('./decorators/replace-servers-url'); -const SetServersUrl = require('./decorators/set-servers-url'); -const ValidateServersUrl = require('./rules/validate-servers-url'); -const id = 'servers'; - -/** @type {import('@redocly/openapi-cli').CustomRulesConfig} */ -const rules = { - oas3: { - 'validate-servers-url': ValidateServersUrl - } -} - -/** @type {import('@redocly/openapi-cli').CustomRulesConfig} */ -const decorators = { - oas3: { - 'replace-servers-url': ReplaceServersUrl, - 'set-servers-url': SetServersUrl - } -}; - -module.exports = { - id, - configs: { - all: {rules, decorators}, - }, - rules, - decorators -}; diff --git a/api-docs/v2.0/swagger.yml b/api-docs/v2.0/ref.yml similarity index 68% rename from api-docs/v2.0/swagger.yml rename to api-docs/v2.0/ref.yml index 76a806391..5ae5ddc97 100644 --- a/api-docs/v2.0/swagger.yml +++ b/api-docs/v2.0/ref.yml @@ -2,54 +2,137 @@ openapi: 3.0.0 info: title: Influx OSS API Service version: 2.0.0 - description: | - The InfluxDB v2 API provides a programmatic interface for all interactions with InfluxDB. Access the InfluxDB API using the `/api/v2/` endpoint. + description: > + The InfluxDB v2 API provides a programmatic interface for all interactions + with InfluxDB. Access the InfluxDB API using the `/api/v2/` endpoint. servers: -- url: "/" + - url: / tags: - name: Authentication - description: | + 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) + + - [Querystring + authentication](#section/Authentication/QuerystringAuthentication) + x-traitTag: true - - name: Quick start - x-traitTag: true - description: | - See the [**API Quick Start**](https://docs.influxdata.com/influxdb/v2.0/api-guide/api_intro/) to get up and running authenticating with tokens, writing to buckets, and querying data. - - [**InfluxDB API client libraries**](https://docs.influxdata.com/influxdb/v2.0/api-guide/client-libraries/) are available for popular languages and ready to import into your application. - - name: Response codes - x-traitTag: true - description: | - The InfluxDB API uses 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 | | - | `204` | No content | For a `POST` request, `204` indicates that InfluxDB accepted the request and request data is valid. Asynchronous operations, such as `write`, might not have completed yet. | - | `400` | Bad request | `Authorization` header is missing or malformed or the API token does not have permission for the operation. | - | `401` | Unauthorized | May indicate one of the following:
  • `Authorization: Token` header is missing or malformed
  • API token value is missing from the header
  • API token does not have permission. For more information about token types and permissions, see [Manage API tokens](https://docs.influxdata.com/influxdb/v2.0/security/tokens/)
    • | - | `404` | Not found | Requested resource was not found. `message` in the response body provides details about the requested resource. | - | `413` | Request entity too large | Request payload exceeds the size limit. | - | `422` | Unprocessible 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: Authorizations + description: > + Create and manage API tokens. An **authorization** associates a list of + permissions to an **organization** and provides a token for API access. To + assign a token to a specific user, scope the authorization to the user ID. + - Backup + - Buckets + - Cells + - Checks + - Dashboards + - DBRPs + - Delete + - Health + - Labels + - Legacy Authorizations + - NotificationEndpoints + - NotificationRules + - Organizations + - Ping - name: Query description: | Retrieve data, analyze queries, and get query suggestions. + - name: Quick start + x-traitTag: true + description: > + See the [**API Quick + Start**](https://docs.influxdata.com/influxdb/v2.0/api-guide/api_intro/) + to get up and running authenticating with tokens, writing to buckets, and + querying data. + + + [**InfluxDB API client + libraries**](https://docs.influxdata.com/influxdb/v2.0/api-guide/client-libraries/) + are available for popular languages and ready to import into your + application. + - Ready + - RemoteConnections + - Replications + - Resources + - name: Response codes + x-traitTag: true + description: > + The InfluxDB API uses 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 | | + + | `204` | No content | For a `POST` request, `204` + indicates that InfluxDB accepted the request and request data is valid. + Asynchronous operations, such as `write`, might not have completed yet. | + + | `400` | Bad request | `Authorization` header is + missing or malformed or the API token does not have permission for the + operation. | + + | `401` | Unauthorized | May indicate one of the + following:
  • `Authorization: Token` header is missing or + malformed
  • API token value is missing from the header
  • API + token does not have permission. For more information about token types and + permissions, see [Manage API + tokens](https://docs.influxdata.com/influxdb/v2.0/security/tokens/)
    • | + + | `404` | Not found | Requested resource was not + found. `message` in the response body provides details about the requested + resource. | + + | `413` | Request entity too large | Request payload exceeds the + size limit. | + + | `422` | Unprocessible 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. | + - Restore + - Routes + - Rules + - Scraper Targets + - Secrets + - Setup + - Signin + - Signout + - Sources + - Tasks + - Telegraf Plugins + - Telegrafs + - Templates + - Users + - Variables + - Views - name: Write description: | Write time series data to buckets. - - name: Authorizations - description: | - Create and manage API tokens. An **authorization** associates a list of permissions to an **organization** and provides a token for API access. To assign a token to a specific user, scope the authorization to the user ID. x-tagGroups: - name: Overview tags: @@ -84,8 +167,8 @@ x-tagGroups: - Buckets - Cells - Checks - - DBRPs - Dashboards + - DBRPs - Delete - Health - Labels @@ -114,13 +197,14 @@ x-tagGroups: - Templates - Users - Variables + - Views - Write paths: /api/v2/: get: operationId: GetRoutes parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: '#/components/parameters/TraceSpan' responses: default: content: @@ -130,34 +214,36 @@ paths: description: All routes summary: List all top level routes tags: - - Routes + - Routes + servers: + - url: / /api/v2/authorizations: get: operationId: GetAuthorizations parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: Only show authorizations that belong to a user ID. - in: query - name: userID - schema: - type: string - - description: Only show authorizations that belong to a user name. - in: query - name: user - schema: - type: string - - description: Only show authorizations that belong to an organization ID. - in: query - name: orgID - schema: - type: string - - description: Only show authorizations that belong to a organization name. - in: query - name: org - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: Only show authorizations that belong to a user ID. + in: query + name: userID + schema: + type: string + - description: Only show authorizations that belong to a user name. + in: query + name: user + schema: + type: string + - description: Only show authorizations that belong to an organization ID. + in: query + name: orgID + schema: + type: string + - description: Only show authorizations that belong to a organization name. + in: query + name: org + schema: + type: string responses: - "200": + '200': content: application/json: schema: @@ -168,11 +254,11 @@ paths: description: Unexpected error summary: List all authorizations tags: - - Authorizations + - Authorizations post: operationId: PostAuthorizations parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: '#/components/parameters/TraceSpan' requestBody: content: application/json: @@ -181,13 +267,13 @@ paths: description: Authorization to create required: true responses: - "201": + '201': content: application/json: schema: $ref: '#/components/schemas/Authorization' description: Authorization created - "400": + '400': $ref: '#/components/responses/ServerError' description: Invalid request default: @@ -195,39 +281,39 @@ paths: description: Unexpected error summary: Create an authorization tags: - - Authorizations + - Authorizations /api/v2/authorizations/{authID}: delete: operationId: DeleteAuthorizationsID parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The ID of the authorization to delete. - in: path - name: authID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The ID of the authorization to delete. + in: path + name: authID + required: true + schema: + type: string responses: - "204": + '204': description: Authorization deleted default: $ref: '#/components/responses/ServerError' description: Unexpected error summary: Delete an authorization tags: - - Authorizations + - Authorizations get: operationId: GetAuthorizationsID parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The ID of the authorization to get. - in: path - name: authID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The ID of the authorization to get. + in: path + name: authID + required: true + schema: + type: string responses: - "200": + '200': content: application/json: schema: @@ -238,17 +324,17 @@ paths: description: Unexpected error summary: Retrieve an authorization tags: - - Authorizations + - Authorizations patch: operationId: PatchAuthorizationsID parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The ID of the authorization to update. - in: path - name: authID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The ID of the authorization to update. + in: path + name: authID + required: true + schema: + type: string requestBody: content: application/json: @@ -257,7 +343,7 @@ paths: description: Authorization to update required: true responses: - "200": + '200': content: application/json: schema: @@ -268,15 +354,15 @@ paths: description: Unexpected error summary: Update an authorization to be active or inactive tags: - - Authorizations + - Authorizations /api/v2/backup/kv: get: deprecated: true operationId: GetBackupKV parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: '#/components/parameters/TraceSpan' responses: - "200": + '200': content: application/octet-stream: schema: @@ -286,30 +372,34 @@ paths: default: $ref: '#/components/responses/ServerError' description: Unexpected error - summary: Download snapshot of metadata stored in the server's embedded KV store. - Should not be used in versions greater than 2.1.x, as it doesn't include metadata - stored in embedded SQL. + summary: >- + Download snapshot of metadata stored in the server's embedded KV store. + Should not be used in versions greater than 2.1.x, as it doesn't include + metadata stored in embedded SQL. tags: - - Backup + - Backup /api/v2/backup/metadata: get: operationId: GetBackupMetadata parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The Accept-Encoding request HTTP header advertises which content - encoding, usually a compression algorithm, the client is able to understand. - in: header - name: Accept-Encoding - schema: - default: identity - description: Specifies that the query response in the body should be encoded - with gzip or not encoded with identity. - enum: - - gzip - - identity - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: >- + The Accept-Encoding request HTTP header advertises which content + encoding, usually a compression algorithm, the client is able to + understand. + in: header + name: Accept-Encoding + schema: + default: identity + description: >- + Specifies that the query response in the body should be encoded + with gzip or not encoded with identity. + enum: + - gzip + - identity + type: string responses: - "200": + '200': content: multipart/mixed: schema: @@ -317,55 +407,60 @@ paths: description: Snapshot of metadata headers: Content-Encoding: - description: The Content-Encoding entity header is used to compress - the media-type. When present, its value indicates which encodings + description: >- + The Content-Encoding entity header is used to compress the + media-type. When present, its value indicates which encodings were applied to the entity-body schema: default: identity - description: Specifies that the response in the body is encoded with - gzip or not encoded with identity. + description: >- + Specifies that the response in the body is encoded with gzip + or not encoded with identity. enum: - - gzip - - identity + - gzip + - identity type: string default: $ref: '#/components/responses/ServerError' description: Unexpected error summary: Download snapshot of all metadata in the server tags: - - Backup + - Backup /api/v2/backup/shards/{shardID}: get: operationId: GetBackupShardId parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The Accept-Encoding request HTTP header advertises which content - encoding, usually a compression algorithm, the client is able to understand. - in: header - name: Accept-Encoding - schema: - default: identity - description: Specifies that the query response in the body should be encoded - with gzip or not encoded with identity. - enum: - - gzip - - identity - type: string - - description: The shard ID. - in: path - name: shardID - required: true - schema: - format: int64 - type: integer - - description: Earliest time to include in the snapshot. RFC3339 format. - in: query - name: since - schema: - format: date-time - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: >- + The Accept-Encoding request HTTP header advertises which content + encoding, usually a compression algorithm, the client is able to + understand. + in: header + name: Accept-Encoding + schema: + default: identity + description: >- + Specifies that the query response in the body should be encoded + with gzip or not encoded with identity. + enum: + - gzip + - identity + type: string + - description: The shard ID. + in: path + name: shardID + required: true + schema: + format: int64 + type: integer + - description: Earliest time to include in the snapshot. RFC3339 format. + in: query + name: since + schema: + format: date-time + type: string responses: - "200": + '200': content: application/octet-stream: schema: @@ -374,18 +469,20 @@ paths: description: TSM snapshot. headers: Content-Encoding: - description: The Content-Encoding entity header is used to compress - the media-type. When present, its value indicates which encodings + description: >- + The Content-Encoding entity header is used to compress the + media-type. When present, its value indicates which encodings were applied to the entity-body schema: default: identity - description: Specifies that the response in the body is encoded with - gzip or not encoded with identity. + description: >- + Specifies that the response in the body is encoded with gzip + or not encoded with identity. enum: - - gzip - - identity + - gzip + - identity type: string - "404": + '404': content: application/json: schema: @@ -396,37 +493,37 @@ paths: description: Unexpected error summary: Download snapshot of all TSM data in a shard tags: - - Backup + - Backup /api/v2/buckets: get: operationId: GetBuckets parameters: - - $ref: '#/components/parameters/TraceSpan' - - $ref: '#/components/parameters/Offset' - - $ref: '#/components/parameters/Limit' - - $ref: '#/components/parameters/After' - - description: The name of the organization. - in: query - name: org - schema: - type: string - - description: The organization ID. - in: query - name: orgID - schema: - type: string - - description: Only returns buckets with a specific name. - in: query - name: name - schema: - type: string - - description: Only returns buckets with a specific ID. - in: query - name: id - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Limit' + - $ref: '#/components/parameters/After' + - description: The name of the organization. + in: query + name: org + schema: + type: string + - description: The organization ID. + in: query + name: orgID + schema: + type: string + - description: Only returns buckets with a specific name. + in: query + name: name + schema: + type: string + - description: Only returns buckets with a specific ID. + in: query + name: id + schema: + type: string responses: - "200": + '200': content: application/json: schema: @@ -440,11 +537,11 @@ paths: description: Unexpected error summary: List all buckets tags: - - Buckets + - Buckets post: operationId: PostBuckets parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: '#/components/parameters/TraceSpan' requestBody: content: application/json: @@ -453,13 +550,13 @@ paths: description: Bucket to create required: true responses: - "201": + '201': content: application/json: schema: $ref: '#/components/schemas/Bucket' description: Bucket created - "422": + '422': content: application/json: schema: @@ -473,22 +570,22 @@ paths: description: Unexpected error summary: Create a bucket tags: - - Buckets + - Buckets /api/v2/buckets/{bucketID}: delete: operationId: DeleteBucketsID parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The ID of the bucket to delete. - in: path - name: bucketID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The ID of the bucket to delete. + in: path + name: bucketID + required: true + schema: + type: string responses: - "204": + '204': description: Delete has been accepted - "404": + '404': content: application/json: schema: @@ -502,19 +599,19 @@ paths: description: Unexpected error summary: Delete a bucket tags: - - Buckets + - Buckets get: operationId: GetBucketsID parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The bucket ID. - in: path - name: bucketID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The bucket ID. + in: path + name: bucketID + required: true + schema: + type: string responses: - "200": + '200': content: application/json: schema: @@ -528,17 +625,17 @@ paths: description: Unexpected error summary: Retrieve a bucket tags: - - Buckets + - Buckets patch: operationId: PatchBucketsID parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The bucket ID. - in: path - name: bucketID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The bucket ID. + in: path + name: bucketID + required: true + schema: + type: string requestBody: content: application/json: @@ -547,7 +644,7 @@ paths: description: Bucket update to apply required: true responses: - "200": + '200': content: application/json: schema: @@ -561,20 +658,20 @@ paths: description: Unexpected error summary: Update a bucket tags: - - Buckets + - Buckets /api/v2/buckets/{bucketID}/labels: get: operationId: GetBucketsIDLabels parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The bucket ID. - in: path - name: bucketID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The bucket ID. + in: path + name: bucketID + required: true + schema: + type: string responses: - "200": + '200': content: application/json: schema: @@ -588,17 +685,17 @@ paths: description: Unexpected error summary: List all labels for a bucket tags: - - Buckets + - Buckets post: operationId: PostBucketsIDLabels parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The bucket ID. - in: path - name: bucketID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The bucket ID. + in: path + name: bucketID + required: true + schema: + type: string requestBody: content: application/json: @@ -607,7 +704,7 @@ paths: description: Label to add required: true responses: - "201": + '201': content: application/json: schema: @@ -621,28 +718,28 @@ paths: description: Unexpected error summary: Add a label to a bucket tags: - - Buckets + - Buckets /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 + - $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": + '204': description: Delete has been accepted - "404": + '404': content: application/json: schema: @@ -656,20 +753,20 @@ paths: description: Unexpected error summary: Delete a label from a bucket tags: - - Buckets + - Buckets /api/v2/buckets/{bucketID}/members: get: operationId: GetBucketsIDMembers parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The bucket ID. - in: path - name: bucketID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The bucket ID. + in: path + name: bucketID + required: true + schema: + type: string responses: - "200": + '200': content: application/json: schema: @@ -683,17 +780,17 @@ paths: description: Unexpected error summary: List all users with member privileges for a bucket tags: - - Buckets + - Buckets post: operationId: PostBucketsIDMembers parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The bucket ID. - in: path - name: bucketID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The bucket ID. + in: path + name: bucketID + required: true + schema: + type: string requestBody: content: application/json: @@ -702,7 +799,7 @@ paths: description: User to add as member required: true responses: - "201": + '201': content: application/json: schema: @@ -716,26 +813,26 @@ paths: description: Unexpected error summary: Add a member to a bucket tags: - - Buckets + - Buckets /api/v2/buckets/{bucketID}/members/{userID}: delete: operationId: DeleteBucketsIDMembersID parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The ID of the member to remove. - in: path - name: userID - required: true - schema: - type: string - - description: The bucket ID. - in: path - name: bucketID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The ID of the member to remove. + in: path + name: userID + required: true + schema: + type: string + - description: The bucket ID. + in: path + name: bucketID + required: true + schema: + type: string responses: - "204": + '204': description: Member removed default: content: @@ -745,20 +842,20 @@ paths: description: Unexpected error summary: Remove a member from a bucket tags: - - Buckets + - Buckets /api/v2/buckets/{bucketID}/owners: get: operationId: GetBucketsIDOwners parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The bucket ID. - in: path - name: bucketID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The bucket ID. + in: path + name: bucketID + required: true + schema: + type: string responses: - "200": + '200': content: application/json: schema: @@ -772,17 +869,17 @@ paths: description: Unexpected error summary: List all owners of a bucket tags: - - Buckets + - Buckets post: operationId: PostBucketsIDOwners parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The bucket ID. - in: path - name: bucketID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The bucket ID. + in: path + name: bucketID + required: true + schema: + type: string requestBody: content: application/json: @@ -791,7 +888,7 @@ paths: description: User to add as owner required: true responses: - "201": + '201': content: application/json: schema: @@ -805,26 +902,26 @@ paths: description: Unexpected error summary: Add an owner to a bucket tags: - - Buckets + - Buckets /api/v2/buckets/{bucketID}/owners/{userID}: delete: 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 bucket ID. - in: path - name: bucketID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The ID of the owner to remove. + in: path + name: userID + required: true + schema: + type: string + - description: The bucket ID. + in: path + name: bucketID + required: true + schema: + type: string responses: - "204": + '204': description: Owner removed default: content: @@ -834,22 +931,22 @@ paths: description: Unexpected error summary: Remove an owner from a bucket tags: - - Buckets + - Buckets /api/v2/checks: get: operationId: GetChecks parameters: - - $ref: '#/components/parameters/TraceSpan' - - $ref: '#/components/parameters/Offset' - - $ref: '#/components/parameters/Limit' - - description: Only show checks that belong to a specific organization ID. - in: query - name: orgID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Limit' + - description: Only show checks that belong to a specific organization ID. + in: query + name: orgID + required: true + schema: + type: string responses: - "200": + '200': content: application/json: schema: @@ -863,7 +960,7 @@ paths: description: Unexpected error summary: List all checks tags: - - Checks + - Checks post: operationId: CreateCheck requestBody: @@ -874,7 +971,7 @@ paths: description: Check to create required: true responses: - "201": + '201': content: application/json: schema: @@ -888,22 +985,22 @@ paths: description: Unexpected error summary: Add new check tags: - - Checks + - Checks /api/v2/checks/{checkID}: delete: operationId: DeleteChecksID parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The check ID. - in: path - name: checkID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The check ID. + in: path + name: checkID + required: true + schema: + type: string responses: - "204": + '204': description: Delete has been accepted - "404": + '404': content: application/json: schema: @@ -917,19 +1014,19 @@ paths: description: Unexpected error summary: Delete a check tags: - - Checks + - Checks get: operationId: GetChecksID parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The check ID. - in: path - name: checkID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The check ID. + in: path + name: checkID + required: true + schema: + type: string responses: - "200": + '200': content: application/json: schema: @@ -943,17 +1040,17 @@ paths: description: Unexpected error summary: Retrieve a check tags: - - Checks + - Checks patch: operationId: PatchChecksID parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The check ID. - in: path - name: checkID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The check ID. + in: path + name: checkID + required: true + schema: + type: string requestBody: content: application/json: @@ -962,13 +1059,13 @@ paths: description: Check update to apply required: true responses: - "200": + '200': content: application/json: schema: $ref: '#/components/schemas/Check' description: An updated check - "404": + '404': content: application/json: schema: @@ -982,17 +1079,17 @@ paths: description: Unexpected error summary: Update a check tags: - - Checks + - Checks put: operationId: PutChecksID parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The check ID. - in: path - name: checkID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The check ID. + in: path + name: checkID + required: true + schema: + type: string requestBody: content: application/json: @@ -1001,13 +1098,13 @@ paths: description: Check update to apply required: true responses: - "200": + '200': content: application/json: schema: $ref: '#/components/schemas/Check' description: An updated check - "404": + '404': content: application/json: schema: @@ -1021,20 +1118,20 @@ paths: description: Unexpected error summary: Update a check tags: - - Checks + - Checks /api/v2/checks/{checkID}/labels: get: operationId: GetChecksIDLabels parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The check ID. - in: path - name: checkID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The check ID. + in: path + name: checkID + required: true + schema: + type: string responses: - "200": + '200': content: application/json: schema: @@ -1048,17 +1145,17 @@ paths: description: Unexpected error summary: List all labels for a check tags: - - Checks + - Checks post: operationId: PostChecksIDLabels parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The check ID. - in: path - name: checkID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The check ID. + in: path + name: checkID + required: true + schema: + type: string requestBody: content: application/json: @@ -1067,7 +1164,7 @@ paths: description: Label to add required: true responses: - "201": + '201': content: application/json: schema: @@ -1081,28 +1178,28 @@ paths: description: Unexpected error summary: Add a label to a check tags: - - Checks + - Checks /api/v2/checks/{checkID}/labels/{labelID}: delete: operationId: DeleteChecksIDLabelsID parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The check ID. - in: path - name: checkID - required: true - schema: - type: string - - description: The ID of the label to delete. - in: path - name: labelID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The check ID. + in: path + name: checkID + required: true + schema: + type: string + - description: The ID of the label to delete. + in: path + name: labelID + required: true + schema: + type: string responses: - "204": + '204': description: Delete has been accepted - "404": + '404': content: application/json: schema: @@ -1116,32 +1213,32 @@ paths: description: Unexpected error summary: Delete label from a check tags: - - Checks + - Checks /api/v2/checks/{checkID}/query: get: operationId: GetChecksIDQuery parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The check ID. - in: path - name: checkID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The check ID. + in: path + name: checkID + required: true + schema: + type: string responses: - "200": + '200': content: application/json: schema: $ref: '#/components/schemas/FluxResponse' description: The check query requested - "400": + '400': content: application/json: schema: $ref: '#/components/schemas/Error' description: Invalid request - "404": + '404': content: application/json: schema: @@ -1155,50 +1252,52 @@ paths: description: Unexpected error summary: Retrieve a check query tags: - - Checks + - Checks /api/v2/dashboards: get: operationId: GetDashboards parameters: - - $ref: '#/components/parameters/TraceSpan' - - $ref: '#/components/parameters/Offset' - - $ref: '#/components/parameters/Limit' - - $ref: '#/components/parameters/Descending' - - description: A user identifier. Returns only dashboards where this user has - the `owner` role. - in: query - name: owner - schema: - type: string - - description: The column to sort by. - in: query - name: sortBy - schema: - enum: - - ID - - CreatedAt - - UpdatedAt - type: string - - description: A list of dashboard identifiers. Returns only the listed dashboards. - If both `id` and `owner` are specified, only `id` is used. - in: query - name: id - schema: - items: + - $ref: '#/components/parameters/TraceSpan' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Limit' + - $ref: '#/components/parameters/Descending' + - description: >- + A user identifier. Returns only dashboards where this user has the + `owner` role. + in: query + name: owner + schema: + type: string + - description: The column to sort by. + in: query + name: sortBy + schema: + enum: + - ID + - CreatedAt + - UpdatedAt + type: string + - description: >- + A list of dashboard identifiers. Returns only the listed dashboards. + If both `id` and `owner` are specified, only `id` is used. + in: query + name: id + schema: + items: + type: string + type: array + - description: The identifier of the organization. + in: query + name: orgID + schema: + type: string + - description: The name of the organization. + in: query + name: org + schema: type: string - type: array - - description: The identifier of the organization. - in: query - name: orgID - schema: - type: string - - description: The name of the organization. - in: query - name: org - schema: - type: string responses: - "200": + '200': content: application/json: schema: @@ -1212,11 +1311,11 @@ paths: description: Unexpected error summary: List all dashboards tags: - - Dashboards + - Dashboards post: operationId: PostDashboards parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: '#/components/parameters/TraceSpan' requestBody: content: application/json: @@ -1225,13 +1324,13 @@ paths: description: Dashboard to create required: true responses: - "201": + '201': content: application/json: schema: oneOf: - - $ref: '#/components/schemas/Dashboard' - - $ref: '#/components/schemas/DashboardWithViewProperties' + - $ref: '#/components/schemas/Dashboard' + - $ref: '#/components/schemas/DashboardWithViewProperties' description: Added dashboard default: content: @@ -1241,22 +1340,22 @@ paths: description: Unexpected error summary: Create a dashboard tags: - - Dashboards + - Dashboards /api/v2/dashboards/{dashboardID}: delete: operationId: DeleteDashboardsID parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The ID of the dashboard to update. - in: path - name: dashboardID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The ID of the dashboard to update. + in: path + name: dashboardID + required: true + schema: + type: string responses: - "204": + '204': description: Delete has been accepted - "404": + '404': content: application/json: schema: @@ -1270,35 +1369,37 @@ paths: description: Unexpected error summary: Delete a dashboard tags: - - Dashboards + - Dashboards get: operationId: GetDashboardsID parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The ID of the dashboard to update. - in: path - name: dashboardID - required: true - schema: - type: string - - description: Includes the cell view properties in the response if set to `properties` - in: query - name: include - required: false - schema: - enum: - - properties - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The ID of the dashboard to update. + in: path + name: dashboardID + required: true + schema: + type: string + - description: >- + Includes the cell view properties in the response if set to + `properties` + in: query + name: include + required: false + schema: + enum: + - properties + type: string responses: - "200": + '200': content: application/json: schema: oneOf: - - $ref: '#/components/schemas/Dashboard' - - $ref: '#/components/schemas/DashboardWithViewProperties' + - $ref: '#/components/schemas/Dashboard' + - $ref: '#/components/schemas/DashboardWithViewProperties' description: Retrieve a single dashboard - "404": + '404': content: application/json: schema: @@ -1312,17 +1413,17 @@ paths: description: Unexpected error summary: Retrieve a Dashboard tags: - - Dashboards + - Dashboards patch: operationId: PatchDashboardsID parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The ID of the dashboard to update. - in: path - name: dashboardID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The ID of the dashboard to update. + in: path + name: dashboardID + required: true + schema: + type: string requestBody: content: application/json: @@ -1330,8 +1431,9 @@ paths: properties: cells: $ref: '#/components/schemas/CellWithViewProperties' - description: optional, when provided will replace all existing cells - with the cells provided + description: >- + optional, when provided will replace all existing cells with + the cells provided description: description: optional, when provided will replace the description type: string @@ -1343,13 +1445,13 @@ paths: description: Patching of a dashboard required: true responses: - "200": + '200': content: application/json: schema: $ref: '#/components/schemas/Dashboard' description: Updated dashboard - "404": + '404': content: application/json: schema: @@ -1363,18 +1465,18 @@ paths: description: Unexpected error summary: Update a dashboard tags: - - Dashboards + - Dashboards /api/v2/dashboards/{dashboardID}/cells: post: operationId: PostDashboardsIDCells parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The ID of the dashboard to update. - in: path - name: dashboardID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The ID of the dashboard to update. + in: path + name: dashboardID + required: true + schema: + type: string requestBody: content: application/json: @@ -1383,13 +1485,13 @@ paths: description: Cell that will be added required: true responses: - "201": + '201': content: application/json: schema: $ref: '#/components/schemas/Cell' description: Cell successfully added - "404": + '404': content: application/json: schema: @@ -1403,20 +1505,21 @@ paths: description: Unexpected error summary: Create a dashboard cell tags: - - Cells - - Dashboards + - Cells + - Dashboards put: - description: Replaces all cells in a dashboard. This is used primarily to update - the positional information of all cells. + description: >- + Replaces all cells in a dashboard. This is used primarily to update the + positional information of all cells. operationId: PutDashboardsIDCells parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The ID of the dashboard to update. - in: path - name: dashboardID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The ID of the dashboard to update. + in: path + name: dashboardID + required: true + schema: + type: string requestBody: content: application/json: @@ -1424,13 +1527,13 @@ paths: $ref: '#/components/schemas/Cells' required: true responses: - "201": + '201': content: application/json: schema: $ref: '#/components/schemas/Dashboard' description: Replaced dashboard cells - "404": + '404': content: application/json: schema: @@ -1444,29 +1547,29 @@ paths: description: Unexpected error summary: Replace cells in a dashboard tags: - - Cells - - Dashboards + - Cells + - Dashboards /api/v2/dashboards/{dashboardID}/cells/{cellID}: delete: operationId: DeleteDashboardsIDCellsID parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The ID of the dashboard to delete. - in: path - name: dashboardID - required: true - schema: - type: string - - description: The ID of the cell to delete. - in: path - name: cellID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The ID of the dashboard to delete. + in: path + name: dashboardID + required: true + schema: + type: string + - description: The ID of the cell to delete. + in: path + name: cellID + required: true + schema: + type: string responses: - "204": + '204': description: Cell successfully deleted - "404": + '404': content: application/json: schema: @@ -1480,26 +1583,27 @@ paths: description: Unexpected error summary: Delete a dashboard cell tags: - - Cells - - Dashboards + - Cells + - Dashboards patch: - description: Updates the non positional information related to a cell. Updates - to a single cell's positional data could cause grid conflicts. + description: >- + Updates the non positional information related to a cell. Updates to a + single cell's positional data could cause grid conflicts. operationId: PatchDashboardsIDCellsID parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The ID of the dashboard to update. - in: path - name: dashboardID - required: true - schema: - type: string - - description: The ID of the cell to update. - in: path - name: cellID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The ID of the dashboard to update. + in: path + name: dashboardID + required: true + schema: + type: string + - description: The ID of the cell to update. + in: path + name: cellID + required: true + schema: + type: string requestBody: content: application/json: @@ -1507,13 +1611,13 @@ paths: $ref: '#/components/schemas/CellUpdate' required: true responses: - "200": + '200': content: application/json: schema: $ref: '#/components/schemas/Cell' description: Updated dashboard cell - "404": + '404': content: application/json: schema: @@ -1527,33 +1631,33 @@ paths: description: Unexpected error summary: Update the non-positional information related to a cell tags: - - Cells - - Dashboards + - Cells + - Dashboards /api/v2/dashboards/{dashboardID}/cells/{cellID}/view: get: operationId: GetDashboardsIDCellsIDView parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The dashboard ID. - in: path - name: dashboardID - required: true - schema: - type: string - - description: The cell ID. - in: path - name: cellID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The dashboard ID. + in: path + name: dashboardID + required: true + schema: + type: string + - description: The cell ID. + in: path + name: cellID + required: true + schema: + type: string responses: - "200": + '200': content: application/json: schema: $ref: '#/components/schemas/View' description: A dashboard cells view - "404": + '404': content: application/json: schema: @@ -1567,25 +1671,25 @@ paths: description: Unexpected error summary: Retrieve the view for a cell tags: - - Cells - - Dashboards - - Views + - Cells + - Dashboards + - Views patch: operationId: PatchDashboardsIDCellsIDView parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The ID of the dashboard to update. - in: path - name: dashboardID - required: true - schema: - type: string - - description: The ID of the cell to update. - in: path - name: cellID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The ID of the dashboard to update. + in: path + name: dashboardID + required: true + schema: + type: string + - description: The ID of the cell to update. + in: path + name: cellID + required: true + schema: + type: string requestBody: content: application/json: @@ -1593,13 +1697,13 @@ paths: $ref: '#/components/schemas/View' required: true responses: - "200": + '200': content: application/json: schema: $ref: '#/components/schemas/View' description: Updated cell view - "404": + '404': content: application/json: schema: @@ -1613,22 +1717,22 @@ paths: description: Unexpected error summary: Update the view for a cell tags: - - Cells - - Dashboards - - Views + - Cells + - Dashboards + - Views /api/v2/dashboards/{dashboardID}/labels: get: operationId: GetDashboardsIDLabels parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The dashboard ID. - in: path - name: dashboardID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The dashboard ID. + in: path + name: dashboardID + required: true + schema: + type: string responses: - "200": + '200': content: application/json: schema: @@ -1642,17 +1746,17 @@ paths: description: Unexpected error summary: List all labels for a dashboard tags: - - Dashboards + - Dashboards post: operationId: PostDashboardsIDLabels parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The dashboard ID. - in: path - name: dashboardID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The dashboard ID. + in: path + name: dashboardID + required: true + schema: + type: string requestBody: content: application/json: @@ -1661,7 +1765,7 @@ paths: description: Label to add required: true responses: - "201": + '201': content: application/json: schema: @@ -1675,28 +1779,28 @@ paths: description: Unexpected error summary: Add a label to a dashboard tags: - - Dashboards + - Dashboards /api/v2/dashboards/{dashboardID}/labels/{labelID}: delete: operationId: DeleteDashboardsIDLabelsID parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The dashboard ID. - in: path - name: dashboardID - required: true - schema: - type: string - - description: The ID of the label to delete. - in: path - name: labelID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The dashboard ID. + in: path + name: dashboardID + required: true + schema: + type: string + - description: The ID of the label to delete. + in: path + name: labelID + required: true + schema: + type: string responses: - "204": + '204': description: Delete has been accepted - "404": + '404': content: application/json: schema: @@ -1710,20 +1814,20 @@ paths: description: Unexpected error summary: Delete a label from a dashboard tags: - - Dashboards + - Dashboards /api/v2/dashboards/{dashboardID}/members: get: operationId: GetDashboardsIDMembers parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The dashboard ID. - in: path - name: dashboardID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The dashboard ID. + in: path + name: dashboardID + required: true + schema: + type: string responses: - "200": + '200': content: application/json: schema: @@ -1737,17 +1841,17 @@ paths: description: Unexpected error summary: List all dashboard members tags: - - Dashboards + - Dashboards post: operationId: PostDashboardsIDMembers parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The dashboard ID. - in: path - name: dashboardID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The dashboard ID. + in: path + name: dashboardID + required: true + schema: + type: string requestBody: content: application/json: @@ -1756,7 +1860,7 @@ paths: description: User to add as member required: true responses: - "201": + '201': content: application/json: schema: @@ -1770,26 +1874,26 @@ paths: description: Unexpected error summary: Add a member to a dashboard tags: - - Dashboards + - Dashboards /api/v2/dashboards/{dashboardID}/members/{userID}: delete: operationId: DeleteDashboardsIDMembersID parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The ID of the member to remove. - in: path - name: userID - required: true - schema: - type: string - - description: The dashboard ID. - in: path - name: dashboardID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The ID of the member to remove. + in: path + name: userID + required: true + schema: + type: string + - description: The dashboard ID. + in: path + name: dashboardID + required: true + schema: + type: string responses: - "204": + '204': description: Member removed default: content: @@ -1799,20 +1903,20 @@ paths: description: Unexpected error summary: Remove a member from a dashboard tags: - - Dashboards + - Dashboards /api/v2/dashboards/{dashboardID}/owners: get: operationId: GetDashboardsIDOwners parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The dashboard ID. - in: path - name: dashboardID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The dashboard ID. + in: path + name: dashboardID + required: true + schema: + type: string responses: - "200": + '200': content: application/json: schema: @@ -1826,17 +1930,17 @@ paths: description: Unexpected error summary: List all dashboard owners tags: - - Dashboards + - Dashboards post: operationId: PostDashboardsIDOwners parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The dashboard ID. - in: path - name: dashboardID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The dashboard ID. + in: path + name: dashboardID + required: true + schema: + type: string requestBody: content: application/json: @@ -1845,7 +1949,7 @@ paths: description: User to add as owner required: true responses: - "201": + '201': content: application/json: schema: @@ -1859,26 +1963,26 @@ paths: description: Unexpected error summary: Add an owner to a dashboard tags: - - Dashboards + - Dashboards /api/v2/dashboards/{dashboardID}/owners/{userID}: delete: operationId: DeleteDashboardsIDOwnersID parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The ID of the owner to remove. - in: path - name: userID - required: true - schema: - type: string - - description: The dashboard ID. - in: path - name: dashboardID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The ID of the owner to remove. + in: path + name: userID + required: true + schema: + type: string + - description: The dashboard ID. + in: path + name: dashboardID + required: true + schema: + type: string responses: - "204": + '204': description: Owner removed default: content: @@ -1888,55 +1992,55 @@ paths: description: Unexpected error summary: Remove an owner from a dashboard tags: - - Dashboards + - Dashboards /api/v2/dbrps: get: operationId: GetDBRPs parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: Specifies the organization ID to filter on - in: query - name: orgID - schema: - type: string - - description: Specifies the organization name to filter on - in: query - name: org - schema: - type: string - - description: Specifies the mapping ID to filter on - in: query - name: id - schema: - type: string - - description: Specifies the bucket ID to filter on - in: query - name: bucketID - schema: - type: string - - description: Specifies filtering on default - in: query - name: default - schema: - type: boolean - - description: Specifies the database to filter on - in: query - name: db - schema: - type: string - - description: Specifies the retention policy to filter on - in: query - name: rp - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: Specifies the organization ID to filter on + in: query + name: orgID + schema: + type: string + - description: Specifies the organization name to filter on + in: query + name: org + schema: + type: string + - description: Specifies the mapping ID to filter on + in: query + name: id + schema: + type: string + - description: Specifies the bucket ID to filter on + in: query + name: bucketID + schema: + type: string + - description: Specifies filtering on default + in: query + name: default + schema: + type: boolean + - description: Specifies the database to filter on + in: query + name: db + schema: + type: string + - description: Specifies the retention policy to filter on + in: query + name: rp + schema: + type: string responses: - "200": + '200': content: application/json: schema: $ref: '#/components/schemas/DBRPs' description: Success. Returns a list of database retention policy mappings. - "400": + '400': content: application/json: schema: @@ -1950,11 +2054,11 @@ paths: description: Unexpected error summary: List database retention policy mappings tags: - - DBRPs + - DBRPs post: operationId: PostDBRP parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: '#/components/parameters/TraceSpan' requestBody: content: application/json: @@ -1963,19 +2067,18 @@ paths: description: The database retention policy mapping to add required: true responses: - "201": + '201': content: application/json: schema: $ref: '#/components/schemas/DBRP' description: Created. Returns the created database retention policy mapping. - "400": + '400': content: application/json: schema: $ref: '#/components/schemas/Error' - description: Bad request. The mapping in the request has one or more invalid - IDs. + description: Bad request. The mapping in the request has one or more invalid IDs. default: content: application/json: @@ -1984,32 +2087,32 @@ paths: description: Unexpected error summary: Add a database retention policy mapping tags: - - DBRPs + - DBRPs /api/v2/dbrps/{dbrpID}: delete: operationId: DeleteDBRPID parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: Specifies the organization ID of the mapping - in: query - name: orgID - schema: - type: string - - description: Specifies the organization name of the mapping - in: query - name: org - schema: - type: string - - description: The database retention policy mapping - in: path - name: dbrpID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: Specifies the organization ID of the mapping + in: query + name: orgID + schema: + type: string + - description: Specifies the organization name of the mapping + in: query + name: org + schema: + type: string + - description: The database retention policy mapping + in: path + name: dbrpID + required: true + schema: + type: string responses: - "204": + '204': description: Delete has been accepted - "400": + '400': content: application/json: schema: @@ -2023,35 +2126,35 @@ paths: description: Unexpected error summary: Delete a database retention policy tags: - - DBRPs + - DBRPs get: operationId: GetDBRPsID parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: Specifies the organization ID of the mapping - in: query - name: orgID - schema: - type: string - - description: Specifies the organization name of the mapping - in: query - name: org - schema: - type: string - - description: The database retention policy mapping ID - in: path - name: dbrpID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: Specifies the organization ID of the mapping + in: query + name: orgID + schema: + type: string + - description: Specifies the organization name of the mapping + in: query + name: org + schema: + type: string + - description: The database retention policy mapping ID + in: path + name: dbrpID + required: true + schema: + type: string responses: - "200": + '200': content: application/json: schema: $ref: '#/components/schemas/DBRPGet' description: The database retention policy requested - "400": + '400': content: application/json: schema: @@ -2065,27 +2168,27 @@ paths: description: Unexpected error summary: Retrieve a database retention policy mapping tags: - - DBRPs + - DBRPs patch: operationId: PatchDBRPID parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: Specifies the organization ID of the mapping - in: query - name: orgID - schema: - type: string - - description: Specifies the organization name of the mapping - in: query - name: org - schema: - type: string - - description: The database retention policy mapping. - in: path - name: dbrpID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: Specifies the organization ID of the mapping + in: query + name: orgID + schema: + type: string + - description: Specifies the organization name of the mapping + in: query + name: org + schema: + type: string + - description: The database retention policy mapping. + in: path + name: dbrpID + required: true + schema: + type: string requestBody: content: application/json: @@ -2094,19 +2197,19 @@ paths: description: Database retention policy update to apply required: true responses: - "200": + '200': content: application/json: schema: $ref: '#/components/schemas/DBRPGet' description: An updated mapping - "400": + '400': content: application/json: schema: $ref: '#/components/schemas/Error' description: if any of the IDs passed is invalid - "404": + '404': content: application/json: schema: @@ -2120,35 +2223,35 @@ paths: description: Unexpected error summary: Update a database retention policy mapping tags: - - DBRPs + - DBRPs /api/v2/delete: post: operationId: PostDelete parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: Specifies the organization to delete data from. - in: query - name: org - schema: - description: Only points from this organization are deleted. - type: string - - description: Specifies the bucket to delete data from. - in: query - name: bucket - schema: - description: Only points from this bucket are deleted. - type: string - - description: Specifies the organization ID of the resource. - in: query - name: orgID - schema: - type: string - - description: Specifies the bucket ID to delete data from. - in: query - name: bucketID - schema: - description: Only points from this bucket ID are deleted. - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: Specifies the organization to delete data from. + in: query + name: org + schema: + description: Only points from this organization are deleted. + type: string + - description: Specifies the bucket to delete data from. + in: query + name: bucket + schema: + description: Only points from this bucket are deleted. + type: string + - description: Specifies the organization ID of the resource. + in: query + name: orgID + schema: + type: string + - description: Specifies the bucket ID to delete data from. + in: query + name: bucketID + schema: + description: Only points from this bucket ID are deleted. + type: string requestBody: content: application/json: @@ -2157,21 +2260,21 @@ paths: description: Deletes data from an InfluxDB bucket. required: true responses: - "204": + '204': description: delete has been accepted - "400": + '400': content: application/json: schema: $ref: '#/components/schemas/Error' description: Invalid request. - "403": + '403': content: application/json: schema: $ref: '#/components/schemas/Error' description: no token was sent or does not have sufficient permissions. - "404": + '404': content: application/json: schema: @@ -2185,14 +2288,14 @@ paths: description: internal server error summary: Delete data tags: - - Delete + - Delete /api/v2/flags: get: operationId: GetFlags parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: '#/components/parameters/TraceSpan' responses: - "200": + '200': content: application/json: schema: @@ -2206,45 +2309,19 @@ paths: description: Unexpected error summary: Return the feature flags for the currently authenticated user tags: - - Users - /api/v2/health: - get: - operationId: GetHealth - parameters: - - $ref: '#/components/parameters/TraceSpan' - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/HealthCheck' - description: The instance is healthy - "503": - content: - application/json: - schema: - $ref: '#/components/schemas/HealthCheck' - description: The instance is unhealthy - default: - $ref: '#/components/responses/ServerError' - description: Unexpected error - servers: - - url: "" - summary: Get the health of an instance - tags: - - Health + - Users /api/v2/labels: get: operationId: GetLabels parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The organization ID. - in: query - name: orgID - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The organization ID. + in: query + name: orgID + schema: + type: string responses: - "200": + '200': content: application/json: schema: @@ -2258,7 +2335,7 @@ paths: description: Unexpected error summary: List all labels tags: - - Labels + - Labels post: operationId: PostLabels requestBody: @@ -2269,7 +2346,7 @@ paths: description: Label to create required: true responses: - "201": + '201': content: application/json: schema: @@ -2283,22 +2360,22 @@ paths: description: Unexpected error summary: Create a label tags: - - Labels + - Labels /api/v2/labels/{labelID}: delete: operationId: DeleteLabelsID parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The ID of the label to delete. - in: path - name: labelID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The ID of the label to delete. + in: path + name: labelID + required: true + schema: + type: string responses: - "204": + '204': description: Delete has been accepted - "404": + '404': content: application/json: schema: @@ -2312,19 +2389,19 @@ paths: description: Unexpected error summary: Delete a label tags: - - Labels + - Labels get: operationId: GetLabelsID parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The ID of the label to update. - in: path - name: labelID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The ID of the label to update. + in: path + name: labelID + required: true + schema: + type: string responses: - "200": + '200': content: application/json: schema: @@ -2338,17 +2415,17 @@ paths: description: Unexpected error summary: Retrieve a label tags: - - Labels + - Labels patch: operationId: PatchLabelsID parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The ID of the label to update. - in: path - name: labelID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The ID of the label to update. + in: path + name: labelID + required: true + schema: + type: string requestBody: content: application/json: @@ -2357,13 +2434,13 @@ paths: description: Label update required: true responses: - "200": + '200': content: application/json: schema: $ref: '#/components/schemas/LabelResponse' description: Updated label - "404": + '404': content: application/json: schema: @@ -2377,204 +2454,20 @@ paths: description: Unexpected error summary: Update a label tags: - - Labels - /api/v2/legacy/authorizations: - get: - operationId: GetLegacyAuthorizations - parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: Only show legacy authorizations that belong to a user ID. - in: query - name: userID - schema: - type: string - - description: Only show legacy authorizations that belong to a user name. - in: query - name: user - schema: - type: string - - description: Only show legacy authorizations that belong to an organization - ID. - in: query - name: orgID - schema: - type: string - - description: Only show legacy authorizations that belong to a organization - name. - in: query - name: org - schema: - type: string - - description: Only show legacy authorizations with a specified token (auth - name). - in: query - name: token - schema: - type: string - - description: Only show legacy authorizations with a specified auth ID. - in: query - name: authID - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/Authorizations' - description: A list of legacy authorizations - default: - $ref: '#/components/responses/ServerError' - description: Unexpected error - summary: List all legacy authorizations - tags: - - Legacy Authorizations - post: - operationId: PostLegacyAuthorizations - parameters: - - $ref: '#/components/parameters/TraceSpan' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/LegacyAuthorizationPostRequest' - description: Legacy authorization to create - required: true - responses: - "201": - content: - application/json: - schema: - $ref: '#/components/schemas/Authorization' - description: Legacy authorization created - "400": - $ref: '#/components/responses/ServerError' - description: Invalid request - default: - $ref: '#/components/responses/ServerError' - description: Unexpected error - summary: Create a legacy authorization - tags: - - Legacy Authorizations - servers: - - url: /private - /api/v2/legacy/authorizations/{authID}: - delete: - operationId: DeleteLegacyAuthorizationsID - parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The ID of the legacy authorization to delete. - in: path - name: authID - required: true - schema: - type: string - responses: - "204": - description: Legacy authorization deleted - default: - $ref: '#/components/responses/ServerError' - description: Unexpected error - summary: Delete a legacy authorization - tags: - - Legacy Authorizations - get: - operationId: GetLegacyAuthorizationsID - parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The ID of the legacy authorization to get. - in: path - name: authID - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/Authorization' - description: Legacy authorization details - default: - $ref: '#/components/responses/ServerError' - description: Unexpected error - summary: Retrieve a legacy authorization - tags: - - Legacy Authorizations - patch: - operationId: PatchLegacyAuthorizationsID - parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The ID of the legacy authorization to update. - in: path - name: authID - required: true - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AuthorizationUpdateRequest' - description: Legacy authorization to update - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/Authorization' - description: The active or inactive legacy authorization - default: - $ref: '#/components/responses/ServerError' - description: Unexpected error - summary: Update a legacy authorization to be active or inactive - tags: - - Legacy Authorizations - servers: - - url: /private - /api/v2/legacy/authorizations/{authID}/password: - post: - operationId: PostLegacyAuthorizationsIDPassword - parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The ID of the legacy authorization to update. - in: path - name: authID - required: true - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/PasswordResetBody' - description: New password - required: true - responses: - "204": - description: Legacy authorization password set - default: - $ref: '#/components/responses/ServerError' - description: Unexpected error - summary: Set a legacy authorization password - tags: - - Legacy Authorizations - servers: - - url: /private + - Labels /api/v2/maps/mapToken: get: operationId: getMapboxToken responses: - "200": + '200': content: application/json: schema: $ref: '#/components/schemas/Token' description: A temp token for Mapbox - "401": + '401': $ref: '#/components/responses/ServerError' - "500": + '500': $ref: '#/components/responses/ServerError' default: $ref: '#/components/responses/ServerError' @@ -2582,9 +2475,9 @@ paths: get: operationId: GetMe parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: '#/components/parameters/TraceSpan' responses: - "200": + '200': content: application/json: schema: @@ -2598,12 +2491,12 @@ paths: description: Unexpected error summary: Retrieve the currently authenticated user tags: - - Users + - Users /api/v2/me/password: put: operationId: PutMePassword parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: '#/components/parameters/TraceSpan' requestBody: content: application/json: @@ -2612,7 +2505,7 @@ paths: description: New password required: true responses: - "204": + '204': description: Password successfully updated default: content: @@ -2621,26 +2514,27 @@ paths: $ref: '#/components/schemas/Error' description: Unsuccessful authentication security: - - BasicAuthentication: [] + - BasicAuthentication: [] summary: Update a password tags: - - Users + - Users /api/v2/notificationEndpoints: get: operationId: GetNotificationEndpoints parameters: - - $ref: '#/components/parameters/TraceSpan' - - $ref: '#/components/parameters/Offset' - - $ref: '#/components/parameters/Limit' - - description: Only show notification endpoints that belong to specific organization - ID. - in: query - name: orgID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Limit' + - description: >- + Only show notification endpoints that belong to specific + organization ID. + in: query + name: orgID + required: true + schema: + type: string responses: - "200": + '200': content: application/json: schema: @@ -2654,7 +2548,7 @@ paths: description: Unexpected error summary: List all notification endpoints tags: - - NotificationEndpoints + - NotificationEndpoints post: operationId: CreateNotificationEndpoint requestBody: @@ -2665,7 +2559,7 @@ paths: description: Notification endpoint to create required: true responses: - "201": + '201': content: application/json: schema: @@ -2679,22 +2573,22 @@ paths: description: Unexpected error summary: Add a notification endpoint tags: - - NotificationEndpoints + - NotificationEndpoints /api/v2/notificationEndpoints/{endpointID}: delete: operationId: DeleteNotificationEndpointsID parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The notification endpoint ID. - in: path - name: endpointID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The notification endpoint ID. + in: path + name: endpointID + required: true + schema: + type: string responses: - "204": + '204': description: Delete has been accepted - "404": + '404': content: application/json: schema: @@ -2708,19 +2602,19 @@ paths: description: Unexpected error summary: Delete a notification endpoint tags: - - NotificationEndpoints + - NotificationEndpoints get: operationId: GetNotificationEndpointsID parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The notification endpoint ID. - in: path - name: endpointID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The notification endpoint ID. + in: path + name: endpointID + required: true + schema: + type: string responses: - "200": + '200': content: application/json: schema: @@ -2734,17 +2628,17 @@ paths: description: Unexpected error summary: Retrieve a notification endpoint tags: - - NotificationEndpoints + - NotificationEndpoints patch: operationId: PatchNotificationEndpointsID parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The notification endpoint ID. - in: path - name: endpointID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The notification endpoint ID. + in: path + name: endpointID + required: true + schema: + type: string requestBody: content: application/json: @@ -2753,13 +2647,13 @@ paths: description: Check update to apply required: true responses: - "200": + '200': content: application/json: schema: $ref: '#/components/schemas/NotificationEndpoint' description: An updated notification endpoint - "404": + '404': content: application/json: schema: @@ -2773,33 +2667,32 @@ paths: description: Unexpected error summary: Update a notification endpoint tags: - - NotificationEndpoints + - NotificationEndpoints put: operationId: PutNotificationEndpointsID parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The notification endpoint ID. - in: path - name: endpointID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The notification endpoint ID. + in: path + name: endpointID + required: true + schema: + type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NotificationEndpoint' - description: A new notification endpoint to replace the existing endpoint - with + description: A new notification endpoint to replace the existing endpoint with required: true responses: - "200": + '200': content: application/json: schema: $ref: '#/components/schemas/NotificationEndpoint' description: An updated notification endpoint - "404": + '404': content: application/json: schema: @@ -2813,20 +2706,20 @@ paths: description: Unexpected error summary: Update a notification endpoint tags: - - NotificationEndpoints + - NotificationEndpoints /api/v2/notificationEndpoints/{endpointID}/labels: get: operationId: GetNotificationEndpointsIDLabels parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The notification endpoint ID. - in: path - name: endpointID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The notification endpoint ID. + in: path + name: endpointID + required: true + schema: + type: string responses: - "200": + '200': content: application/json: schema: @@ -2840,17 +2733,17 @@ paths: description: Unexpected error summary: List all labels for a notification endpoint tags: - - NotificationEndpoints + - NotificationEndpoints post: operationId: PostNotificationEndpointIDLabels parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The notification endpoint ID. - in: path - name: endpointID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The notification endpoint ID. + in: path + name: endpointID + required: true + schema: + type: string requestBody: content: application/json: @@ -2859,7 +2752,7 @@ paths: description: Label to add required: true responses: - "201": + '201': content: application/json: schema: @@ -2873,28 +2766,28 @@ paths: description: Unexpected error summary: Add a label to a notification endpoint tags: - - NotificationEndpoints + - NotificationEndpoints /api/v2/notificationEndpoints/{endpointID}/labels/{labelID}: delete: operationId: DeleteNotificationEndpointsIDLabelsID parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The notification endpoint ID. - in: path - name: endpointID - required: true - schema: - type: string - - description: The ID of the label to delete. - in: path - name: labelID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The notification endpoint ID. + in: path + name: endpointID + required: true + schema: + type: string + - description: The ID of the label to delete. + in: path + name: labelID + required: true + schema: + type: string responses: - "204": + '204': description: Delete has been accepted - "404": + '404': content: application/json: schema: @@ -2908,36 +2801,38 @@ paths: description: Unexpected error summary: Delete a label from a notification endpoint tags: - - NotificationEndpoints + - NotificationEndpoints /api/v2/notificationRules: get: operationId: GetNotificationRules parameters: - - $ref: '#/components/parameters/TraceSpan' - - $ref: '#/components/parameters/Offset' - - $ref: '#/components/parameters/Limit' - - description: Only show notification rules that belong to a specific organization - ID. - in: query - name: orgID - required: true - schema: - type: string - - description: Only show notifications that belong to the specific check ID. - in: query - name: checkID - schema: - type: string - - description: Only return notification rules that "would match" statuses which - contain the tag key value pairs provided. - in: query - name: tag - schema: - example: env:prod - pattern: ^[a-zA-Z0-9_]+:[a-zA-Z0-9_]+$ - type: string + - $ref: '#/components/parameters/TraceSpan' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Limit' + - description: >- + Only show notification rules that belong to a specific organization + ID. + in: query + name: orgID + required: true + schema: + type: string + - description: Only show notifications that belong to the specific check ID. + in: query + name: checkID + schema: + type: string + - description: >- + Only return notification rules that "would match" statuses which + contain the tag key value pairs provided. + in: query + name: tag + schema: + example: env:prod + pattern: ^[a-zA-Z0-9_]+:[a-zA-Z0-9_]+$ + type: string responses: - "200": + '200': content: application/json: schema: @@ -2951,7 +2846,7 @@ paths: description: Unexpected error summary: List all notification rules tags: - - NotificationRules + - NotificationRules post: operationId: CreateNotificationRule requestBody: @@ -2962,7 +2857,7 @@ paths: description: Notification rule to create required: true responses: - "201": + '201': content: application/json: schema: @@ -2976,22 +2871,22 @@ paths: description: Unexpected error summary: Add a notification rule tags: - - NotificationRules + - NotificationRules /api/v2/notificationRules/{ruleID}: delete: operationId: DeleteNotificationRulesID parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The notification rule ID. - in: path - name: ruleID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The notification rule ID. + in: path + name: ruleID + required: true + schema: + type: string responses: - "204": + '204': description: Delete has been accepted - "404": + '404': content: application/json: schema: @@ -3005,19 +2900,19 @@ paths: description: Unexpected error summary: Delete a notification rule tags: - - NotificationRules + - NotificationRules get: operationId: GetNotificationRulesID parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The notification rule ID. - in: path - name: ruleID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The notification rule ID. + in: path + name: ruleID + required: true + schema: + type: string responses: - "200": + '200': content: application/json: schema: @@ -3031,17 +2926,17 @@ paths: description: Unexpected error summary: Retrieve a notification rule tags: - - NotificationRules + - NotificationRules patch: operationId: PatchNotificationRulesID parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The notification rule ID. - in: path - name: ruleID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The notification rule ID. + in: path + name: ruleID + required: true + schema: + type: string requestBody: content: application/json: @@ -3050,13 +2945,13 @@ paths: description: Notification rule update to apply required: true responses: - "200": + '200': content: application/json: schema: $ref: '#/components/schemas/NotificationRule' description: An updated notification rule - "404": + '404': content: application/json: schema: @@ -3070,17 +2965,17 @@ paths: description: Unexpected error summary: Update a notification rule tags: - - NotificationRules + - NotificationRules put: operationId: PutNotificationRulesID parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The notification rule ID. - in: path - name: ruleID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The notification rule ID. + in: path + name: ruleID + required: true + schema: + type: string requestBody: content: application/json: @@ -3089,13 +2984,13 @@ paths: description: Notification rule update to apply required: true responses: - "200": + '200': content: application/json: schema: $ref: '#/components/schemas/NotificationRule' description: An updated notification rule - "404": + '404': content: application/json: schema: @@ -3109,20 +3004,20 @@ paths: description: Unexpected error summary: Update a notification rule tags: - - NotificationRules + - NotificationRules /api/v2/notificationRules/{ruleID}/labels: get: operationId: GetNotificationRulesIDLabels parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The notification rule ID. - in: path - name: ruleID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The notification rule ID. + in: path + name: ruleID + required: true + schema: + type: string responses: - "200": + '200': content: application/json: schema: @@ -3136,17 +3031,17 @@ paths: description: Unexpected error summary: List all labels for a notification rule tags: - - NotificationRules + - NotificationRules post: operationId: PostNotificationRuleIDLabels parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The notification rule ID. - in: path - name: ruleID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The notification rule ID. + in: path + name: ruleID + required: true + schema: + type: string requestBody: content: application/json: @@ -3155,7 +3050,7 @@ paths: description: Label to add required: true responses: - "201": + '201': content: application/json: schema: @@ -3169,28 +3064,28 @@ paths: description: Unexpected error summary: Add a label to a notification rule tags: - - NotificationRules + - NotificationRules /api/v2/notificationRules/{ruleID}/labels/{labelID}: delete: operationId: DeleteNotificationRulesIDLabelsID parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The notification rule ID. - in: path - name: ruleID - required: true - schema: - type: string - - description: The ID of the label to delete. - in: path - name: labelID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The notification rule ID. + in: path + name: ruleID + required: true + schema: + type: string + - description: The ID of the label to delete. + in: path + name: labelID + required: true + schema: + type: string responses: - "204": + '204': description: Delete has been accepted - "404": + '404': content: application/json: schema: @@ -3204,32 +3099,32 @@ paths: description: Unexpected error summary: Delete label from a notification rule tags: - - NotificationRules + - NotificationRules /api/v2/notificationRules/{ruleID}/query: get: operationId: GetNotificationRulesIDQuery parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The notification rule ID. - in: path - name: ruleID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The notification rule ID. + in: path + name: ruleID + required: true + schema: + type: string responses: - "200": + '200': content: application/json: schema: $ref: '#/components/schemas/FluxResponse' description: The notification rule query requested - "400": + '400': content: application/json: schema: $ref: '#/components/schemas/Error' description: Invalid request - "404": + '404': content: application/json: schema: @@ -3243,32 +3138,32 @@ paths: description: Unexpected error summary: Retrieve a notification rule query tags: - - Rules + - Rules /api/v2/orgs: get: operationId: GetOrgs parameters: - - $ref: '#/components/parameters/TraceSpan' - - $ref: '#/components/parameters/Offset' - - $ref: '#/components/parameters/Limit' - - $ref: '#/components/parameters/Descending' - - description: Filter organizations to a specific organization name. - in: query - name: org - schema: - type: string - - description: Filter organizations to a specific organization ID. - in: query - name: orgID - schema: - type: string - - description: Filter organizations to a specific user ID. - in: query - name: userID - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Limit' + - $ref: '#/components/parameters/Descending' + - description: Filter organizations to a specific organization name. + in: query + name: org + schema: + type: string + - description: Filter organizations to a specific organization ID. + in: query + name: orgID + schema: + type: string + - description: Filter organizations to a specific user ID. + in: query + name: userID + schema: + type: string responses: - "200": + '200': content: application/json: schema: @@ -3282,11 +3177,11 @@ paths: description: Unexpected error summary: List all organizations tags: - - Organizations + - Organizations post: operationId: PostOrgs parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: '#/components/parameters/TraceSpan' requestBody: content: application/json: @@ -3295,7 +3190,7 @@ paths: description: Organization to create required: true responses: - "201": + '201': content: application/json: schema: @@ -3309,22 +3204,22 @@ paths: description: Unexpected error summary: Create an organization tags: - - Organizations + - Organizations /api/v2/orgs/{orgID}: delete: operationId: DeleteOrgsID parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The ID of the organization to delete. - in: path - name: orgID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The ID of the organization to delete. + in: path + name: orgID + required: true + schema: + type: string responses: - "204": + '204': description: Delete has been accepted - "404": + '404': content: application/json: schema: @@ -3338,19 +3233,19 @@ paths: description: Unexpected error summary: Delete an organization tags: - - Organizations + - Organizations get: operationId: GetOrgsID parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The ID of the organization to get. - in: path - name: orgID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The ID of the organization to get. + in: path + name: orgID + required: true + schema: + type: string responses: - "200": + '200': content: application/json: schema: @@ -3364,17 +3259,17 @@ paths: description: Unexpected error summary: Retrieve an organization tags: - - Organizations + - Organizations patch: operationId: PatchOrgsID parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The ID of the organization to get. - in: path - name: orgID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The ID of the organization to get. + in: path + name: orgID + required: true + schema: + type: string requestBody: content: application/json: @@ -3383,7 +3278,7 @@ paths: description: Organization update to apply required: true responses: - "200": + '200': content: application/json: schema: @@ -3397,26 +3292,26 @@ paths: description: Unexpected error summary: Update an organization tags: - - Organizations + - Organizations /api/v2/orgs/{orgID}/members: get: operationId: GetOrgsIDMembers parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The organization ID. - in: path - name: orgID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The organization ID. + in: path + name: orgID + required: true + schema: + type: string responses: - "200": + '200': content: application/json: schema: $ref: '#/components/schemas/ResourceMembers' description: A list of organization members - "404": + '404': content: application/json: schema: @@ -3430,17 +3325,17 @@ paths: description: Unexpected error summary: List all members of an organization tags: - - Organizations + - Organizations post: operationId: PostOrgsIDMembers parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The organization ID. - in: path - name: orgID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The organization ID. + in: path + name: orgID + required: true + schema: + type: string requestBody: content: application/json: @@ -3449,7 +3344,7 @@ paths: description: User to add as member required: true responses: - "201": + '201': content: application/json: schema: @@ -3463,26 +3358,26 @@ paths: description: Unexpected error summary: Add a member to an organization tags: - - Organizations + - Organizations /api/v2/orgs/{orgID}/members/{userID}: delete: operationId: DeleteOrgsIDMembersID parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The ID of the member to remove. - in: path - name: userID - required: true - schema: - type: string - - description: The organization ID. - in: path - name: orgID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The ID of the member to remove. + in: path + name: userID + required: true + schema: + type: string + - description: The organization ID. + in: path + name: orgID + required: true + schema: + type: string responses: - "204": + '204': description: Member removed default: content: @@ -3492,26 +3387,26 @@ paths: description: Unexpected error summary: Remove a member from an organization tags: - - Organizations + - Organizations /api/v2/orgs/{orgID}/owners: get: operationId: GetOrgsIDOwners parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The organization ID. - in: path - name: orgID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The organization ID. + in: path + name: orgID + required: true + schema: + type: string responses: - "200": + '200': content: application/json: schema: $ref: '#/components/schemas/ResourceOwners' description: A list of organization owners - "404": + '404': content: application/json: schema: @@ -3525,17 +3420,17 @@ paths: description: Unexpected error summary: List all owners of an organization tags: - - Organizations + - Organizations post: operationId: PostOrgsIDOwners parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The organization ID. - in: path - name: orgID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The organization ID. + in: path + name: orgID + required: true + schema: + type: string requestBody: content: application/json: @@ -3544,7 +3439,7 @@ paths: description: User to add as owner required: true responses: - "201": + '201': content: application/json: schema: @@ -3558,26 +3453,26 @@ paths: description: Unexpected error summary: Add an owner to an organization tags: - - Organizations + - Organizations /api/v2/orgs/{orgID}/owners/{userID}: delete: operationId: DeleteOrgsIDOwnersID parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The ID of the owner to remove. - in: path - name: userID - required: true - schema: - type: string - - description: The organization ID. - in: path - name: orgID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The ID of the owner to remove. + in: path + name: userID + required: true + schema: + type: string + - description: The organization ID. + in: path + name: orgID + required: true + schema: + type: string responses: - "204": + '204': description: Owner removed default: content: @@ -3587,20 +3482,20 @@ paths: description: Unexpected error summary: Remove an owner from an organization tags: - - Organizations + - 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 + - $ref: '#/components/parameters/TraceSpan' + - description: The organization ID. + in: path + name: orgID + required: true + schema: + type: string responses: - "200": + '200': content: application/json: schema: @@ -3614,17 +3509,17 @@ paths: description: Unexpected error summary: List all secret keys for an organization tags: - - Secrets + - Secrets patch: operationId: PatchOrgsIDSecrets parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The organization ID. - in: path - name: orgID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The organization ID. + in: path + name: orgID + required: true + schema: + type: string requestBody: content: application/json: @@ -3633,7 +3528,7 @@ paths: description: Secret key value pairs to update/add required: true responses: - "204": + '204': description: Keys successfully patched default: content: @@ -3643,45 +3538,45 @@ paths: description: Unexpected error summary: Update secrets in an organization tags: - - Secrets + - 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 + - $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": + '204': description: Keys successfully deleted default: $ref: '#/components/responses/ServerError' description: Unexpected error summary: Delete a secret from an organization tags: - - Secrets + - 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 + - $ref: '#/components/parameters/TraceSpan' + - description: The organization ID. + in: path + name: orgID + required: true + schema: + type: string requestBody: content: application/json: @@ -3690,7 +3585,7 @@ paths: description: Secret key to delete required: true responses: - "204": + '204': description: Keys successfully patched default: content: @@ -3700,12 +3595,12 @@ paths: description: Unexpected error summary: Delete secrets from an organization tags: - - Secrets + - Secrets /ping: get: operationId: GetPing responses: - "204": + '204': description: OK headers: X-Influxdb-Build: @@ -3717,14 +3612,14 @@ paths: schema: type: integer servers: - - url: "" + - url: / summary: Checks the status of InfluxDB instance and version of InfluxDB. tags: - - Ping + - Ping head: operationId: HeadPing responses: - "204": + '204': description: OK headers: X-Influxdb-Build: @@ -3736,58 +3631,73 @@ paths: schema: type: integer servers: - - url: "" + - url: / summary: Checks the status of InfluxDB instance and version of InfluxDB. tags: - - Ping + - Ping /api/v2/query: post: - description: | + description: > Retrieves data from InfluxDB buckets. + To query data, you need the following: - - **organization** – _See [View organizations](https://docs.influxdata.com/influxdb/v2.0/organizations/view-orgs/#view-your-organization-id) for instructions on viewing your organization ID._ - - **API token** – _See [View tokens](https://docs.influxdata.com/influxdb/v2.0/security/tokens/view-tokens/) + + - **organization** – _See [View + organizations](https://docs.influxdata.com/influxdb/v2.0/organizations/view-orgs/#view-your-organization-id) + for instructions on viewing your organization ID._ + + - **API token** – _See [View + tokens](https://docs.influxdata.com/influxdb/v2.0/security/tokens/view-tokens/) for instructions on viewing your API token._ - - **InfluxDB URL** – _See [InfluxDB URLs](https://docs.influxdata.com/influxdb/v2.0/reference/urls/)_. + - **InfluxDB URL** – _See [InfluxDB + URLs](https://docs.influxdata.com/influxdb/v2.0/reference/urls/)_. + - **Flux query** – _See [Flux](https://docs.influxdata.com/flux/v0.x/)._ - For more information and examples, see [Query with the InfluxDB API](https://docs.influxdata.com/influxdb/v2.0/query-data/execute-queries/influx-api/). + + For more information and examples, see [Query with the InfluxDB + API](https://docs.influxdata.com/influxdb/v2.0/query-data/execute-queries/influx-api/). operationId: PostQuery parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The Accept-Encoding request HTTP header advertises which content - encoding, usually a compression algorithm, the client is able to understand. - in: header - name: Accept-Encoding - schema: - default: identity - description: Specifies that the query response in the body should be encoded - with gzip or not encoded with identity. - enum: - - gzip - - identity - type: string - - in: header - name: Content-Type - schema: - enum: - - application/json - - application/vnd.flux - type: string - - description: Specifies the name of the organization executing the query. Takes - either the ID or Name. If both `orgID` and `org` are specified, `org` takes - precedence. - in: query - name: org - schema: - type: string - - description: Specifies the ID of the organization executing the query. If - both `orgID` and `org` are specified, `org` takes precedence. - in: query - name: orgID - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: >- + The Accept-Encoding request HTTP header advertises which content + encoding, usually a compression algorithm, the client is able to + understand. + in: header + name: Accept-Encoding + schema: + default: identity + description: >- + Specifies that the query response in the body should be encoded + with gzip or not encoded with identity. + enum: + - gzip + - identity + type: string + - in: header + name: Content-Type + schema: + enum: + - application/json + - application/vnd.flux + type: string + - description: >- + Specifies the name of the organization executing the query. Takes + either the ID or Name. If both `orgID` and `org` are specified, + `org` takes precedence. + in: query + name: org + schema: + type: string + - description: >- + Specifies the ID of the organization executing the query. If both + `orgID` and `org` are specified, `org` takes precedence. + in: query + name: orgID + schema: + type: string requestBody: content: application/json: @@ -3802,7 +3712,7 @@ paths: |> filter(fn: (r) => r._measurement == "example-measurement") description: Flux query or specification to execute responses: - "200": + '200': content: application/vnd.influx.arrow: schema: @@ -3810,36 +3720,44 @@ paths: type: string text/csv: schema: - example: | - result,table,_start,_stop,_time,region,host,_value mean,0,2018-05-08T20:50:00Z,2018-05-08T20:51:00Z,2018-05-08T20:50:00Z,east,A,15.43 mean,0,2018-05-08T20:50:00Z,2018-05-08T20:51:00Z,2018-05-08T20:50:20Z,east,B,59.25 mean,0,2018-05-08T20:50:00Z,2018-05-08T20:51:00Z,2018-05-08T20:50:40Z,east,C,52.62 + example: > + result,table,_start,_stop,_time,region,host,_value + mean,0,2018-05-08T20:50:00Z,2018-05-08T20:51:00Z,2018-05-08T20:50:00Z,east,A,15.43 + mean,0,2018-05-08T20:50:00Z,2018-05-08T20:51:00Z,2018-05-08T20:50:20Z,east,B,59.25 + mean,0,2018-05-08T20:50:00Z,2018-05-08T20:51:00Z,2018-05-08T20:50:40Z,east,C,52.62 type: string description: Success. Returns query results. headers: Content-Encoding: - description: The Content-Encoding entity header is used to compress - the media-type. When present, its value indicates which encodings + description: >- + The Content-Encoding entity header is used to compress the + media-type. When present, its value indicates which encodings were applied to the entity-body schema: default: identity - description: Specifies that the response in the body is encoded with - gzip or not encoded with identity. + description: >- + Specifies that the response in the body is encoded with gzip + or not encoded with identity. enum: - - gzip - - identity + - gzip + - identity type: string Trace-Id: - description: The Trace-Id header reports the request's trace ID, if - one was generated. + description: >- + The Trace-Id header reports the request's trace ID, if one was + generated. schema: description: Specifies the request's trace ID. type: string - "429": - description: Token is temporarily over quota. The Retry-After header describes + '429': + description: >- + Token is temporarily over quota. The Retry-After header describes when to try the read again. headers: Retry-After: - description: A non-negative decimal integer indicating the seconds to - delay after the response is received. + description: >- + A non-negative decimal integer indicating the seconds to delay + after the response is received. schema: format: int32 type: integer @@ -3851,18 +3769,18 @@ paths: description: Error processing query summary: Query data tags: - - Query + - Query /api/v2/query/analyze: post: operationId: PostQueryAnalyze parameters: - - $ref: '#/components/parameters/TraceSpan' - - in: header - name: Content-Type - schema: - enum: - - application/json - type: string + - $ref: '#/components/parameters/TraceSpan' + - in: header + name: Content-Type + schema: + enum: + - application/json + type: string requestBody: content: application/json: @@ -3870,13 +3788,12 @@ paths: $ref: '#/components/schemas/Query' description: Flux query to analyze responses: - "200": + '200': content: application/json: schema: $ref: '#/components/schemas/AnalyzeQueryResponse' - description: Query analyze results. Errors will be empty if the query is - valid. + description: Query analyze results. Errors will be empty if the query is valid. default: content: application/json: @@ -3894,19 +3811,19 @@ paths: type: integer summary: Analyze a Flux query tags: - - Query + - Query /api/v2/query/ast: post: description: Analyzes flux query and generates a query specification. operationId: PostQueryAst parameters: - - $ref: '#/components/parameters/TraceSpan' - - in: header - name: Content-Type - schema: - enum: - - application/json - type: string + - $ref: '#/components/parameters/TraceSpan' + - in: header + name: Content-Type + schema: + enum: + - application/json + type: string requestBody: content: application/json: @@ -3914,7 +3831,7 @@ paths: $ref: '#/components/schemas/LanguageRequest' description: Analyzed Flux query to generate abstract syntax tree. responses: - "200": + '200': content: application/json: schema: @@ -3928,14 +3845,14 @@ paths: description: Any response other than 200 is an internal server error summary: Generate an Abstract Syntax Tree (AST) from a query tags: - - Query + - Query /api/v2/query/suggestions: get: operationId: GetQuerySuggestions parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: '#/components/parameters/TraceSpan' responses: - "200": + '200': content: application/json: schema: @@ -3949,20 +3866,20 @@ paths: description: Any response other than 200 is an internal server error summary: Retrieve query suggestions tags: - - Query + - Query /api/v2/query/suggestions/{name}: get: operationId: GetQuerySuggestionsName parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The name of the branching suggestion. - in: path - name: name - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The name of the branching suggestion. + in: path + name: name + required: true + schema: + type: string responses: - "200": + '200': content: application/json: schema: @@ -3976,71 +3893,51 @@ paths: description: Any response other than 200 is an internal server error summary: Retrieve query suggestions for a branching suggestion tags: - - Query - /api/v2/ready: - get: - operationId: GetReady - parameters: - - $ref: '#/components/parameters/TraceSpan' - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/Ready' - description: The instance is ready - default: - $ref: '#/components/responses/ServerError' - description: Unexpected error - servers: - - url: "" - summary: Get the readiness of an instance at startup - tags: - - Ready + - Query /api/v2/remotes: get: operationId: GetRemoteConnections parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The organization ID. - in: query - name: orgID - required: true - schema: - type: string - - in: query - name: name - schema: - type: string - - in: query - name: remoteURL - schema: - format: uri - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The organization ID. + in: query + name: orgID + required: true + schema: + type: string + - in: query + name: name + schema: + type: string + - in: query + name: remoteURL + schema: + format: uri + type: string responses: - "200": + '200': content: application/json: schema: $ref: '#/components/schemas/RemoteConnections' description: List of remote connections - "404": + '404': $ref: '#/components/responses/ServerError' default: $ref: '#/components/responses/ServerError' summary: List all remote connections tags: - - RemoteConnections + - RemoteConnections post: operationId: PostRemoteConnection parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: If true, validate the remote connection, but don't save it. - in: query - name: validate - schema: - default: false - type: boolean + - $ref: '#/components/parameters/TraceSpan' + - description: If true, validate the remote connection, but don't save it. + in: query + name: validate + schema: + default: false + type: boolean requestBody: content: application/json: @@ -4048,79 +3945,79 @@ paths: $ref: '#/components/schemas/RemoteConnectionCreationRequest' required: true responses: - "201": + '201': content: application/json: schema: $ref: '#/components/schemas/RemoteConnection' description: Remote connection saved - "204": + '204': description: Remote connection validated, but not saved - "400": + '400': $ref: '#/components/responses/ServerError' default: $ref: '#/components/responses/ServerError' summary: Register a new remote connection tags: - - RemoteConnections + - RemoteConnections /api/v2/remotes/{remoteID}: delete: operationId: DeleteRemoteConnectionByID parameters: - - $ref: '#/components/parameters/TraceSpan' - - in: path - name: remoteID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - in: path + name: remoteID + required: true + schema: + type: string responses: - "204": + '204': description: Remote connection info deleted. - "404": + '404': $ref: '#/components/responses/ServerError' default: $ref: '#/components/responses/ServerError' summary: Delete a remote connection tags: - - RemoteConnections + - RemoteConnections get: operationId: GetRemoteConnectionByID parameters: - - $ref: '#/components/parameters/TraceSpan' - - in: path - name: remoteID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - in: path + name: remoteID + required: true + schema: + type: string responses: - "200": + '200': content: application/json: schema: $ref: '#/components/schemas/RemoteConnection' description: Remote connection - "404": + '404': $ref: '#/components/responses/ServerError' default: $ref: '#/components/responses/ServerError' summary: Retrieve a remote connection tags: - - RemoteConnections + - RemoteConnections patch: operationId: PatchRemoteConnectionByID parameters: - - $ref: '#/components/parameters/TraceSpan' - - in: path - name: remoteID - required: true - schema: - type: string - - description: If true, validate the updated information, but don't save it. - in: query - name: validate - schema: - default: false - type: boolean + - $ref: '#/components/parameters/TraceSpan' + - in: path + name: remoteID + required: true + schema: + type: string + - description: If true, validate the updated information, but don't save it. + in: query + name: validate + schema: + default: false + type: boolean requestBody: content: application/json: @@ -4128,91 +4025,91 @@ paths: $ref: '#/components/schemas/RemoteConnectionUpdateRequest' required: true responses: - "200": + '200': content: application/json: schema: $ref: '#/components/schemas/RemoteConnection' description: Updated information saved - "204": + '204': description: Updated connection validated, but not saved - "400": + '400': $ref: '#/components/responses/ServerError' - "404": + '404': $ref: '#/components/responses/ServerError' default: $ref: '#/components/responses/ServerError' summary: Update a remote connection tags: - - RemoteConnections + - RemoteConnections /api/v2/remotes/{remoteID}/validate: post: operationId: PostValidateRemoteConnectionByID parameters: - - $ref: '#/components/parameters/TraceSpan' - - in: path - name: remoteID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - in: path + name: remoteID + required: true + schema: + type: string responses: - "204": + '204': description: Remote connection is valid - "400": + '400': $ref: '#/components/responses/ServerError' description: Remote connection failed validation default: $ref: '#/components/responses/ServerError' summary: Validate a remote connection tags: - - RemoteConnections + - RemoteConnections /api/v2/replications: get: operationId: GetReplications parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The organization ID. - in: query - name: orgID - required: true - schema: - type: string - - in: query - name: name - schema: - type: string - - in: query - name: remoteID - schema: - type: string - - in: query - name: localBucketID - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The organization ID. + in: query + name: orgID + required: true + schema: + type: string + - in: query + name: name + schema: + type: string + - in: query + name: remoteID + schema: + type: string + - in: query + name: localBucketID + schema: + type: string responses: - "200": + '200': content: application/json: schema: $ref: '#/components/schemas/Replications' description: List of replications - "404": + '404': $ref: '#/components/responses/ServerError' default: $ref: '#/components/responses/ServerError' summary: List all replications tags: - - Replications + - Replications post: operationId: PostReplication parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: If true, validate the replication, but don't save it. - in: query - name: validate - schema: - default: false - type: boolean + - $ref: '#/components/parameters/TraceSpan' + - description: If true, validate the replication, but don't save it. + in: query + name: validate + schema: + default: false + type: boolean requestBody: content: application/json: @@ -4220,79 +4117,79 @@ paths: $ref: '#/components/schemas/ReplicationCreationRequest' required: true responses: - "201": + '201': content: application/json: schema: $ref: '#/components/schemas/Replication' description: Replication saved - "204": + '204': description: Replication validated, but not saved - "400": + '400': $ref: '#/components/responses/ServerError' default: $ref: '#/components/responses/ServerError' summary: Register a new replication tags: - - Replications + - Replications /api/v2/replications/{replicationID}: delete: operationId: DeleteReplicationByID parameters: - - $ref: '#/components/parameters/TraceSpan' - - in: path - name: replicationID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - in: path + name: replicationID + required: true + schema: + type: string responses: - "204": + '204': description: Replication deleted. - "404": + '404': $ref: '#/components/responses/ServerError' default: $ref: '#/components/responses/ServerError' summary: Delete a replication tags: - - Replications + - Replications get: operationId: GetReplicationByID parameters: - - $ref: '#/components/parameters/TraceSpan' - - in: path - name: replicationID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - in: path + name: replicationID + required: true + schema: + type: string responses: - "200": + '200': content: application/json: schema: $ref: '#/components/schemas/Replication' description: Replication - "404": + '404': $ref: '#/components/responses/ServerError' default: $ref: '#/components/responses/ServerError' summary: Retrieve a replication tags: - - Replications + - Replications patch: operationId: PatchReplicationByID parameters: - - $ref: '#/components/parameters/TraceSpan' - - in: path - name: replicationID - required: true - schema: - type: string - - description: If true, validate the updated information, but don't save it. - in: query - name: validate - schema: - default: false - type: boolean + - $ref: '#/components/parameters/TraceSpan' + - in: path + name: replicationID + required: true + schema: + type: string + - description: If true, validate the updated information, but don't save it. + in: query + name: validate + schema: + default: false + type: boolean requestBody: content: application/json: @@ -4300,51 +4197,51 @@ paths: $ref: '#/components/schemas/ReplicationUpdateRequest' required: true responses: - "200": + '200': content: application/json: schema: $ref: '#/components/schemas/Replication' description: Updated information saved - "204": + '204': description: Updated replication validated, but not saved - "400": + '400': $ref: '#/components/responses/ServerError' - "404": + '404': $ref: '#/components/responses/ServerError' default: $ref: '#/components/responses/ServerError' summary: Update a replication tags: - - Replications + - Replications /api/v2/replications/{replicationID}/validate: post: operationId: PostValidateReplicationByID parameters: - - $ref: '#/components/parameters/TraceSpan' - - in: path - name: replicationID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - in: path + name: replicationID + required: true + schema: + type: string responses: - "204": + '204': description: Replication is valid - "400": + '400': $ref: '#/components/responses/ServerError' description: Replication failed validation default: $ref: '#/components/responses/ServerError' summary: Validate a replication tags: - - Replications + - Replications /api/v2/resources: get: operationId: GetResources parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: '#/components/parameters/TraceSpan' responses: - "200": + '200': content: application/json: schema: @@ -4360,26 +4257,26 @@ paths: description: Internal server error summary: List all known resources tags: - - Resources + - Resources /api/v2/restore/bucket/{bucketID}: post: deprecated: true operationId: PostRestoreBucketID parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The bucket ID. - in: path - name: bucketID - required: true - schema: - type: string - - in: header - name: Content-Type - schema: - default: application/octet-stream - enum: - - application/octet-stream - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The bucket ID. + in: path + name: bucketID + required: true + schema: + type: string + - in: header + name: Content-Type + schema: + default: application/octet-stream + enum: + - application/octet-stream + type: string requestBody: content: text/plain: @@ -4389,7 +4286,7 @@ paths: description: Database info serialized as protobuf. required: true responses: - "200": + '200': content: application/json: schema: @@ -4401,12 +4298,12 @@ paths: description: Unexpected error summary: Overwrite storage metadata for a bucket with shard info from a backup. tags: - - Restore + - Restore /api/v2/restore/bucketMetadata: post: operationId: PostRestoreBucketMetadata parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: '#/components/parameters/TraceSpan' requestBody: content: application/json: @@ -4415,7 +4312,7 @@ paths: description: Metadata manifest for a bucket. required: true responses: - "201": + '201': content: application/json: schema: @@ -4426,31 +4323,33 @@ paths: description: Unexpected error summary: Create a new bucket pre-seeded with shard info from a backup. tags: - - Restore + - Restore /api/v2/restore/kv: post: operationId: PostRestoreKV parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: When present, its value indicates to the database 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 - - in: header - name: Content-Type - schema: - default: application/octet-stream - enum: - - application/octet-stream - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: >- + When present, its value indicates to the database 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 + - in: header + name: Content-Type + schema: + default: application/octet-stream + enum: + - application/octet-stream + type: string requestBody: content: text/plain: @@ -4460,55 +4359,58 @@ paths: description: Full KV snapshot. required: true responses: - "200": + '200': content: application/json: schema: properties: token: - description: token is the root token for the instance after restore + description: >- + token is the root token for the instance after restore (this is overwritten during the restore) type: string type: object description: KV store successfully overwritten. - "204": + '204': description: KV store successfully overwritten. default: $ref: '#/components/responses/ServerError' description: Unexpected error summary: Overwrite the embedded KV store on the server with a backed-up snapshot. tags: - - Restore + - Restore /api/v2/restore/shards/{shardID}: post: operationId: PostRestoreShardId parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: When present, its value indicates to the database 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 - - in: header - name: Content-Type - schema: - default: application/octet-stream - enum: - - application/octet-stream - type: string - - description: The shard ID. - in: path - name: shardID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: >- + When present, its value indicates to the database 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 + - in: header + name: Content-Type + schema: + default: application/octet-stream + enum: + - application/octet-stream + type: string + - description: The shard ID. + in: path + name: shardID + required: true + schema: + type: string requestBody: content: text/plain: @@ -4518,38 +4420,40 @@ paths: description: TSM snapshot. required: true responses: - "204": + '204': description: TSM snapshot successfully restored. default: $ref: '#/components/responses/ServerError' description: Unexpected error summary: Restore a TSM snapshot into a shard. tags: - - Restore + - Restore /api/v2/restore/sql: post: operationId: PostRestoreSQL parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: When present, its value indicates to the database 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 - - in: header - name: Content-Type - schema: - default: application/octet-stream - enum: - - application/octet-stream - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: >- + When present, its value indicates to the database 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 + - in: header + name: Content-Type + schema: + default: application/octet-stream + enum: + - application/octet-stream + type: string requestBody: content: text/plain: @@ -4559,44 +4463,47 @@ paths: description: Full SQL snapshot. required: true responses: - "204": + '204': description: SQL store successfully overwritten. default: $ref: '#/components/responses/ServerError' description: Unexpected error - summary: Overwrite the embedded SQL store on the server with a backed-up snapshot. + summary: >- + Overwrite the embedded SQL store on the server with a backed-up + snapshot. tags: - - Restore + - Restore /api/v2/scrapers: get: operationId: GetScrapers parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: Specifies the name of the scraper target. - in: query - name: name - schema: - type: string - - description: List of scraper target IDs to return. If both `id` and `owner` - are specified, only `id` is used. - in: query - name: id - schema: - items: + - $ref: '#/components/parameters/TraceSpan' + - description: Specifies the name of the scraper target. + in: query + name: name + schema: + type: string + - description: >- + List of scraper target IDs to return. If both `id` and `owner` are + specified, only `id` is used. + in: query + name: id + schema: + items: + type: string + type: array + - description: Specifies the organization ID of the scraper target. + in: query + name: orgID + schema: + type: string + - description: Specifies the organization name of the scraper target. + in: query + name: org + schema: type: string - type: array - - description: Specifies the organization ID of the scraper target. - in: query - name: orgID - schema: - type: string - - description: Specifies the organization name of the scraper target. - in: query - name: org - schema: - type: string responses: - "200": + '200': content: application/json: schema: @@ -4604,11 +4511,11 @@ paths: description: All scraper targets summary: List all scraper targets tags: - - Scraper Targets + - Scraper Targets post: operationId: PostScrapers parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: '#/components/parameters/TraceSpan' requestBody: content: application/json: @@ -4617,7 +4524,7 @@ paths: description: Scraper target to create required: true responses: - "201": + '201': content: application/json: schema: @@ -4631,20 +4538,20 @@ paths: description: Internal server error summary: Create a scraper target tags: - - Scraper Targets + - Scraper Targets /api/v2/scrapers/{scraperTargetID}: delete: operationId: DeleteScrapersID parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The identifier of the scraper target. - in: path - name: scraperTargetID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The identifier of the scraper target. + in: path + name: scraperTargetID + required: true + schema: + type: string responses: - "204": + '204': description: Scraper target deleted default: content: @@ -4654,19 +4561,19 @@ paths: description: Internal server error summary: Delete a scraper target tags: - - Scraper Targets + - Scraper Targets get: operationId: GetScrapersID parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The identifier of the scraper target. - in: path - name: scraperTargetID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The identifier of the scraper target. + in: path + name: scraperTargetID + required: true + schema: + type: string responses: - "200": + '200': content: application/json: schema: @@ -4680,17 +4587,17 @@ paths: description: Internal server error summary: Retrieve a scraper target tags: - - Scraper Targets + - Scraper Targets patch: operationId: PatchScrapersID parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The identifier of the scraper target. - in: path - name: scraperTargetID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The identifier of the scraper target. + in: path + name: scraperTargetID + required: true + schema: + type: string requestBody: content: application/json: @@ -4699,7 +4606,7 @@ paths: description: Scraper target update to apply required: true responses: - "200": + '200': content: application/json: schema: @@ -4713,20 +4620,20 @@ paths: description: Internal server error summary: Update a scraper target tags: - - Scraper Targets + - Scraper Targets /api/v2/scrapers/{scraperTargetID}/labels: get: operationId: GetScrapersIDLabels parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The scraper target ID. - in: path - name: scraperTargetID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The scraper target ID. + in: path + name: scraperTargetID + required: true + schema: + type: string responses: - "200": + '200': content: application/json: schema: @@ -4740,17 +4647,17 @@ paths: description: Unexpected error summary: List all labels for a scraper target tags: - - Scraper Targets + - Scraper Targets post: operationId: PostScrapersIDLabels parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The scraper target ID. - in: path - name: scraperTargetID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The scraper target ID. + in: path + name: scraperTargetID + required: true + schema: + type: string requestBody: content: application/json: @@ -4759,7 +4666,7 @@ paths: description: Label to add required: true responses: - "201": + '201': content: application/json: schema: @@ -4773,28 +4680,28 @@ paths: description: Unexpected error summary: Add a label to a scraper target tags: - - Scraper Targets + - Scraper Targets /api/v2/scrapers/{scraperTargetID}/labels/{labelID}: delete: operationId: DeleteScrapersIDLabelsID parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The scraper target ID. - in: path - name: scraperTargetID - required: true - schema: - type: string - - description: The label ID. - in: path - name: labelID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The scraper target ID. + in: path + name: scraperTargetID + required: true + schema: + type: string + - description: The label ID. + in: path + name: labelID + required: true + schema: + type: string responses: - "204": + '204': description: Delete has been accepted - "404": + '404': content: application/json: schema: @@ -4808,20 +4715,20 @@ paths: description: Unexpected error summary: Delete a label from a scraper target tags: - - Scraper Targets + - Scraper Targets /api/v2/scrapers/{scraperTargetID}/members: get: operationId: GetScrapersIDMembers parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The scraper target ID. - in: path - name: scraperTargetID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The scraper target ID. + in: path + name: scraperTargetID + required: true + schema: + type: string responses: - "200": + '200': content: application/json: schema: @@ -4835,17 +4742,17 @@ paths: description: Unexpected error summary: List all users with member privileges for a scraper target tags: - - Scraper Targets + - Scraper Targets post: operationId: PostScrapersIDMembers parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The scraper target ID. - in: path - name: scraperTargetID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The scraper target ID. + in: path + name: scraperTargetID + required: true + schema: + type: string requestBody: content: application/json: @@ -4854,7 +4761,7 @@ paths: description: User to add as member required: true responses: - "201": + '201': content: application/json: schema: @@ -4868,26 +4775,26 @@ paths: description: Unexpected error summary: Add a member to a scraper target tags: - - Scraper Targets + - Scraper Targets /api/v2/scrapers/{scraperTargetID}/members/{userID}: delete: operationId: DeleteScrapersIDMembersID parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The ID of member to remove. - in: path - name: userID - required: true - schema: - type: string - - description: The scraper target ID. - in: path - name: scraperTargetID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The ID of member to remove. + in: path + name: userID + required: true + schema: + type: string + - description: The scraper target ID. + in: path + name: scraperTargetID + required: true + schema: + type: string responses: - "204": + '204': description: Member removed default: content: @@ -4897,20 +4804,20 @@ paths: description: Unexpected error summary: Remove a member from a scraper target tags: - - Scraper Targets + - Scraper Targets /api/v2/scrapers/{scraperTargetID}/owners: get: operationId: GetScrapersIDOwners parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The scraper target ID. - in: path - name: scraperTargetID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The scraper target ID. + in: path + name: scraperTargetID + required: true + schema: + type: string responses: - "200": + '200': content: application/json: schema: @@ -4924,17 +4831,17 @@ paths: description: Unexpected error summary: List all owners of a scraper target tags: - - Scraper Targets + - Scraper Targets post: operationId: PostScrapersIDOwners parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The scraper target ID. - in: path - name: scraperTargetID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The scraper target ID. + in: path + name: scraperTargetID + required: true + schema: + type: string requestBody: content: application/json: @@ -4943,7 +4850,7 @@ paths: description: User to add as owner required: true responses: - "201": + '201': content: application/json: schema: @@ -4957,26 +4864,26 @@ paths: description: Unexpected error summary: Add an owner to a scraper target tags: - - Scraper Targets + - Scraper Targets /api/v2/scrapers/{scraperTargetID}/owners/{userID}: delete: operationId: DeleteScrapersIDOwnersID parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The ID of owner to remove. - in: path - name: userID - required: true - schema: - type: string - - description: The scraper target ID. - in: path - name: scraperTargetID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The ID of owner to remove. + in: path + name: userID + required: true + schema: + type: string + - description: The scraper target ID. + in: path + name: scraperTargetID + required: true + schema: + type: string responses: - "204": + '204': description: Owner removed default: content: @@ -4986,16 +4893,17 @@ paths: description: Unexpected error summary: Remove an owner from a scraper target tags: - - Scraper Targets + - Scraper Targets /api/v2/setup: get: - description: Returns `true` if no default user, organization, or bucket has - been created. + description: >- + Returns `true` if no default user, organization, or bucket has been + created. operationId: GetSetup parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: '#/components/parameters/TraceSpan' responses: - "200": + '200': content: application/json: schema: @@ -5003,12 +4911,12 @@ paths: description: allowed true or false summary: Check if database has default user, org, bucket tags: - - Setup + - Setup post: description: Post an onboarding request to set up initial user, org and bucket. operationId: PostSetup parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: '#/components/parameters/TraceSpan' requestBody: content: application/json: @@ -5017,7 +4925,7 @@ paths: description: Source to create required: true responses: - "201": + '201': content: application/json: schema: @@ -5028,24 +4936,25 @@ paths: description: Unexpected error summary: Set up initial user, org and bucket tags: - - Setup + - Setup /api/v2/signin: post: - description: Authenticates ***Basic Auth*** credentials for a user. If successful, + description: >- + Authenticates ***Basic Auth*** credentials for a user. If successful, creates a new UI session for the user. operationId: PostSignin parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: '#/components/parameters/TraceSpan' responses: - "204": + '204': description: Success. User authenticated. - "401": + '401': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unauthorized access. - "403": + '403': content: application/json: schema: @@ -5058,20 +4967,20 @@ paths: $ref: '#/components/schemas/Error' description: Unsuccessful authentication. security: - - BasicAuthentication: [] + - BasicAuthentication: [] summary: Create a user session. tags: - - Signin + - Signin /api/v2/signout: post: description: Expires the current UI session for the user. operationId: PostSignout parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: '#/components/parameters/TraceSpan' responses: - "204": + '204': description: Session successfully expired - "401": + '401': content: application/json: schema: @@ -5085,19 +4994,19 @@ paths: description: Unsuccessful session expiry summary: Expire the current UI session tags: - - Signout + - Signout /api/v2/sources: get: operationId: GetSources parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The name of the organization. - in: query - name: org - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The name of the organization. + in: query + name: org + schema: + type: string responses: - "200": + '200': content: application/json: schema: @@ -5111,11 +5020,11 @@ paths: description: Unexpected error summary: List all sources tags: - - Sources + - Sources post: operationId: PostSources parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: '#/components/parameters/TraceSpan' requestBody: content: application/json: @@ -5124,7 +5033,7 @@ paths: description: Source to create required: true responses: - "201": + '201': content: application/json: schema: @@ -5138,22 +5047,22 @@ paths: description: Unexpected error summary: Create a source tags: - - Sources + - Sources /api/v2/sources/{sourceID}: delete: operationId: DeleteSourcesID parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The source ID. - in: path - name: sourceID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The source ID. + in: path + name: sourceID + required: true + schema: + type: string responses: - "204": + '204': description: Delete has been accepted - "404": + '404': content: application/json: schema: @@ -5167,25 +5076,25 @@ paths: description: Unexpected error summary: Delete a source tags: - - Sources + - Sources get: operationId: GetSourcesID parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The source ID. - in: path - name: sourceID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The source ID. + in: path + name: sourceID + required: true + schema: + type: string responses: - "200": + '200': content: application/json: schema: $ref: '#/components/schemas/Source' description: A source - "404": + '404': content: application/json: schema: @@ -5199,17 +5108,17 @@ paths: description: Unexpected error summary: Retrieve a source tags: - - Sources + - Sources patch: operationId: PatchSourcesID parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The source ID. - in: path - name: sourceID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The source ID. + in: path + name: sourceID + required: true + schema: + type: string requestBody: content: application/json: @@ -5218,13 +5127,13 @@ paths: description: Source update required: true responses: - "200": + '200': content: application/json: schema: $ref: '#/components/schemas/Source' description: Created Source - "404": + '404': content: application/json: schema: @@ -5238,31 +5147,31 @@ paths: description: Unexpected error summary: Update a Source tags: - - Sources + - Sources /api/v2/sources/{sourceID}/buckets: get: operationId: GetSourcesIDBuckets parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The source ID. - in: path - name: sourceID - required: true - schema: - type: string - - description: The name of the organization. - in: query - name: org - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The source ID. + in: path + name: sourceID + required: true + schema: + type: string + - description: The name of the organization. + in: query + name: org + schema: + type: string responses: - "200": + '200': content: application/json: schema: $ref: '#/components/schemas/Buckets' description: A source - "404": + '404': content: application/json: schema: @@ -5276,27 +5185,27 @@ paths: description: Unexpected error summary: Get buckets in a source tags: - - Sources - - Buckets + - Sources + - Buckets /api/v2/sources/{sourceID}/health: get: operationId: GetSourcesIDHealth parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The source ID. - in: path - name: sourceID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The source ID. + in: path + name: sourceID + required: true + schema: + type: string responses: - "200": + '200': content: application/json: schema: $ref: '#/components/schemas/HealthCheck' description: The source is healthy - "503": + '503': content: application/json: schema: @@ -5310,29 +5219,29 @@ paths: description: Unexpected error summary: Get the health of a source tags: - - Sources + - Sources /api/v2/stacks: get: operationId: ListStacks parameters: - - description: The organization ID of the stacks - in: query - name: orgID - required: true - schema: - type: string - - description: A collection of names to filter the list by. - in: query - name: name - schema: - type: string - - description: A collection of stackIDs to filter the list by. - in: query - name: stackID - schema: - type: string + - description: The organization ID of the stacks + in: query + name: orgID + required: true + schema: + type: string + - description: A collection of names to filter the list by. + in: query + name: name + schema: + type: string + - description: A collection of stackIDs to filter the list by. + in: query + name: stackID + schema: + type: string responses: - "200": + '200': content: application/json: schema: @@ -5351,7 +5260,7 @@ paths: description: Unexpected error summary: List installed templates tags: - - Templates + - Templates post: operationId: CreateStack requestBody: @@ -5374,7 +5283,7 @@ paths: description: The stack to create. required: true responses: - "201": + '201': content: application/json: schema: @@ -5388,25 +5297,25 @@ paths: description: Unexpected error summary: Create a new stack tags: - - Templates + - 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 + - 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": + '204': description: The stack and its associated resources were deleted. default: content: @@ -5416,18 +5325,18 @@ paths: description: Unexpected error summary: Delete a stack and associated resources tags: - - Templates + - Templates get: operationId: ReadStack parameters: - - description: The identifier of the stack. - in: path - name: stack_id - required: true - schema: - type: string + - description: The identifier of the stack. + in: path + name: stack_id + required: true + schema: + type: string responses: - "200": + '200': content: application/json: schema: @@ -5441,16 +5350,16 @@ paths: description: Unexpected error summary: Retrieve a stack tags: - - Templates + - Templates patch: operationId: UpdateStack parameters: - - description: The identifier of the stack. - in: path - name: stack_id - required: true - schema: - type: string + - description: The identifier of the stack. + in: path + name: stack_id + required: true + schema: + type: string requestBody: content: application/json: @@ -5466,8 +5375,8 @@ paths: templateMetaName: type: string required: - - kind - - resourceID + - kind + - resourceID type: object type: array description: @@ -5486,7 +5395,7 @@ paths: description: The stack to update. required: true responses: - "200": + '200': content: application/json: schema: @@ -5500,19 +5409,19 @@ paths: description: Unexpected error summary: Update a stack tags: - - Templates + - 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 + - description: The identifier of the stack. + in: path + name: stack_id + required: true + schema: + type: string responses: - "200": + '200': content: application/json: schema: @@ -5526,65 +5435,65 @@ paths: description: Unexpected error summary: Uninstall a stack tags: - - Templates + - Templates /api/v2/tasks: get: operationId: GetTasks parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: Returns task with a specific name. - in: query - name: name - schema: - type: string - - description: Return tasks after a specified ID. - in: query - name: after - schema: - type: string - - description: Filter tasks to a specific user ID. - in: query - name: user - schema: - type: string - - description: Filter tasks to a specific organization name. - in: query - name: org - schema: - type: string - - description: Filter tasks to a specific organization ID. - in: query - name: orgID - schema: - type: string - - description: Filter tasks by a status--"inactive" or "active". - in: query - name: status - schema: - enum: - - active - - inactive - type: string - - description: The number of tasks to return - in: query - name: limit - schema: - default: 100 - maximum: 500 - minimum: 1 - type: integer - - description: Type of task, unset by default. - in: query - name: type - required: false - schema: - default: "" - enum: - - basic - - system - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: Returns task with a specific name. + in: query + name: name + schema: + type: string + - description: Return tasks after a specified ID. + in: query + name: after + schema: + type: string + - description: Filter tasks to a specific user ID. + in: query + name: user + schema: + type: string + - description: Filter tasks to a specific organization name. + in: query + name: org + schema: + type: string + - description: Filter tasks to a specific organization ID. + in: query + name: orgID + schema: + type: string + - description: Filter tasks by a status--"inactive" or "active". + in: query + name: status + schema: + enum: + - active + - inactive + type: string + - description: The number of tasks to return + in: query + name: limit + schema: + default: 100 + maximum: 500 + minimum: 1 + type: integer + - description: Type of task, unset by default. + in: query + name: type + required: false + schema: + default: '' + enum: + - basic + - system + type: string responses: - "200": + '200': content: application/json: schema: @@ -5598,11 +5507,11 @@ paths: description: Unexpected error summary: List all tasks tags: - - Tasks + - Tasks post: operationId: PostTasks parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: '#/components/parameters/TraceSpan' requestBody: content: application/json: @@ -5611,7 +5520,7 @@ paths: description: Task to create required: true responses: - "201": + '201': content: application/json: schema: @@ -5625,21 +5534,21 @@ paths: description: Unexpected error summary: Create a new task tags: - - Tasks + - Tasks /api/v2/tasks/{taskID}: delete: description: Deletes a task and all associated records operationId: DeleteTasksID parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The ID of the task to delete. - in: path - name: taskID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The ID of the task to delete. + in: path + name: taskID + required: true + schema: + type: string responses: - "204": + '204': description: Task deleted default: content: @@ -5649,19 +5558,19 @@ paths: description: Unexpected error summary: Delete a task tags: - - Tasks + - Tasks get: operationId: GetTasksID parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The task ID. - in: path - name: taskID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The task ID. + in: path + name: taskID + required: true + schema: + type: string responses: - "200": + '200': content: application/json: schema: @@ -5675,18 +5584,18 @@ paths: description: Unexpected error summary: Retrieve a task tags: - - Tasks + - Tasks patch: description: Update a task. This will cancel all queued runs. operationId: PatchTasksID parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The task ID. - in: path - name: taskID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The task ID. + in: path + name: taskID + required: true + schema: + type: string requestBody: content: application/json: @@ -5695,7 +5604,7 @@ paths: description: Task update to apply required: true responses: - "200": + '200': content: application/json: schema: @@ -5709,20 +5618,20 @@ paths: description: Unexpected error summary: Update a task tags: - - Tasks + - Tasks /api/v2/tasks/{taskID}/labels: get: operationId: GetTasksIDLabels parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The task ID. - in: path - name: taskID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The task ID. + in: path + name: taskID + required: true + schema: + type: string responses: - "200": + '200': content: application/json: schema: @@ -5736,17 +5645,17 @@ paths: description: Unexpected error summary: List all labels for a task tags: - - Tasks + - Tasks post: operationId: PostTasksIDLabels parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The task ID. - in: path - name: taskID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The task ID. + in: path + name: taskID + required: true + schema: + type: string requestBody: content: application/json: @@ -5755,7 +5664,7 @@ paths: description: Label to add required: true responses: - "201": + '201': content: application/json: schema: @@ -5769,28 +5678,28 @@ paths: description: Unexpected error summary: Add a label to a task tags: - - Tasks + - Tasks /api/v2/tasks/{taskID}/labels/{labelID}: delete: operationId: DeleteTasksIDLabelsID parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The task ID. - in: path - name: taskID - required: true - schema: - type: string - - description: The label ID. - in: path - name: labelID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The task ID. + in: path + name: taskID + required: true + schema: + type: string + - description: The label ID. + in: path + name: labelID + required: true + schema: + type: string responses: - "204": + '204': description: Delete has been accepted - "404": + '404': content: application/json: schema: @@ -5804,20 +5713,20 @@ paths: description: Unexpected error summary: Delete a label from a task tags: - - Tasks + - Tasks /api/v2/tasks/{taskID}/logs: get: operationId: GetTasksIDLogs parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The task ID. - in: path - name: taskID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The task ID. + in: path + name: taskID + required: true + schema: + type: string responses: - "200": + '200': content: application/json: schema: @@ -5831,20 +5740,20 @@ paths: description: Unexpected error summary: Retrieve all logs for a task tags: - - Tasks + - Tasks /api/v2/tasks/{taskID}/members: get: operationId: GetTasksIDMembers parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The task ID. - in: path - name: taskID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The task ID. + in: path + name: taskID + required: true + schema: + type: string responses: - "200": + '200': content: application/json: schema: @@ -5858,17 +5767,17 @@ paths: description: Unexpected error summary: List all task members tags: - - Tasks + - Tasks post: operationId: PostTasksIDMembers parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The task ID. - in: path - name: taskID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The task ID. + in: path + name: taskID + required: true + schema: + type: string requestBody: content: application/json: @@ -5877,7 +5786,7 @@ paths: description: User to add as member required: true responses: - "201": + '201': content: application/json: schema: @@ -5891,26 +5800,26 @@ paths: description: Unexpected error summary: Add a member to a task tags: - - Tasks + - Tasks /api/v2/tasks/{taskID}/members/{userID}: delete: 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 + - $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": + '204': description: Member removed default: content: @@ -5920,20 +5829,20 @@ paths: description: Unexpected error summary: Remove a member from a task tags: - - Tasks + - Tasks /api/v2/tasks/{taskID}/owners: get: operationId: GetTasksIDOwners parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The task ID. - in: path - name: taskID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The task ID. + in: path + name: taskID + required: true + schema: + type: string responses: - "200": + '200': content: application/json: schema: @@ -5947,17 +5856,17 @@ paths: description: Unexpected error summary: List all owners of a task tags: - - Tasks + - Tasks post: operationId: PostTasksIDOwners parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The task ID. - in: path - name: taskID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The task ID. + in: path + name: taskID + required: true + schema: + type: string requestBody: content: application/json: @@ -5966,7 +5875,7 @@ paths: description: User to add as owner required: true responses: - "201": + '201': content: application/json: schema: @@ -5980,26 +5889,26 @@ paths: description: Unexpected error summary: Add an owner to a task tags: - - Tasks + - Tasks /api/v2/tasks/{taskID}/owners/{userID}: delete: 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 + - $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": + '204': description: Owner removed default: content: @@ -6009,45 +5918,45 @@ paths: description: Unexpected error summary: Remove an owner from a task tags: - - Tasks + - Tasks /api/v2/tasks/{taskID}/runs: get: operationId: GetTasksIDRuns parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The ID of the task to get runs for. - in: path - name: taskID - required: true - schema: - type: string - - description: Returns runs after a specific ID. - in: query - name: after - schema: - type: string - - description: The number of runs to return - in: query - name: limit - schema: - default: 100 - maximum: 500 - minimum: 1 - type: integer - - description: Filter runs to those scheduled after this time, RFC3339 - in: query - name: afterTime - schema: - format: date-time - type: string - - description: Filter runs to those scheduled before this time, RFC3339 - in: query - name: beforeTime - schema: - format: date-time - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The ID of the task to get runs for. + in: path + name: taskID + required: true + schema: + type: string + - description: Returns runs after a specific ID. + in: query + name: after + schema: + type: string + - description: The number of runs to return + in: query + name: limit + schema: + default: 100 + maximum: 500 + minimum: 1 + type: integer + - description: Filter runs to those scheduled after this time, RFC3339 + in: query + name: afterTime + schema: + format: date-time + type: string + - description: Filter runs to those scheduled before this time, RFC3339 + in: query + name: beforeTime + schema: + format: date-time + type: string responses: - "200": + '200': content: application/json: schema: @@ -6061,23 +5970,23 @@ paths: description: Unexpected error summary: List runs for a task tags: - - Tasks + - Tasks post: operationId: PostTasksIDRuns parameters: - - $ref: '#/components/parameters/TraceSpan' - - in: path - name: taskID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - in: path + name: taskID + required: true + schema: + type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/RunManually' responses: - "201": + '201': content: application/json: schema: @@ -6091,26 +6000,26 @@ paths: description: Unexpected error summary: Manually start a task run, overriding the current schedule tags: - - Tasks + - Tasks /api/v2/tasks/{taskID}/runs/{runID}: delete: operationId: DeleteTasksIDRunsID parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The task ID. - in: path - name: taskID - required: true - schema: - type: string - - description: The run ID. - in: path - name: runID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The task ID. + in: path + name: taskID + required: true + schema: + type: string + - description: The run ID. + in: path + name: runID + required: true + schema: + type: string responses: - "204": + '204': description: Delete has been accepted default: content: @@ -6120,25 +6029,25 @@ paths: description: Unexpected error summary: Cancel a running task tags: - - Tasks + - Tasks get: operationId: GetTasksIDRunsID parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The task ID. - in: path - name: taskID - required: true - schema: - type: string - - description: The run ID. - in: path - name: runID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The task ID. + in: path + name: taskID + required: true + schema: + type: string + - description: The run ID. + in: path + name: runID + required: true + schema: + type: string responses: - "200": + '200': content: application/json: schema: @@ -6152,26 +6061,26 @@ paths: description: Unexpected error summary: Retrieve a single run for a task tags: - - Tasks + - Tasks /api/v2/tasks/{taskID}/runs/{runID}/logs: get: operationId: GetTasksIDRunsIDLogs parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: ID of task to get logs for. - in: path - name: taskID - required: true - schema: - type: string - - description: ID of run to get logs for. - in: path - name: runID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: ID of task to get logs for. + in: path + name: taskID + required: true + schema: + type: string + - description: ID of run to get logs for. + in: path + name: runID + required: true + schema: + type: string responses: - "200": + '200': content: application/json: schema: @@ -6185,31 +6094,31 @@ paths: description: Unexpected error summary: Retrieve all logs for a run tags: - - Tasks + - Tasks /api/v2/tasks/{taskID}/runs/{runID}/retry: post: operationId: PostTasksIDRunsIDRetry parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The task ID. - in: path - name: taskID - required: true - schema: - type: string - - description: The run ID. - in: path - name: runID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The task ID. + in: path + name: taskID + required: true + schema: + type: string + - description: The run ID. + in: path + name: runID + required: true + schema: + type: string requestBody: content: application/json; charset=utf-8: schema: type: object responses: - "200": + '200': content: application/json: schema: @@ -6223,19 +6132,19 @@ paths: description: Unexpected error summary: Retry a task run tags: - - Tasks + - Tasks /api/v2/telegraf/plugins: get: operationId: GetTelegrafPlugins parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The type of plugin desired. - in: query - name: type - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The type of plugin desired. + in: query + name: type + schema: + type: string responses: - "200": + '200': content: application/json: schema: @@ -6249,19 +6158,19 @@ paths: description: Unexpected error summary: List all Telegraf plugins tags: - - Telegraf Plugins + - 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 + - $ref: '#/components/parameters/TraceSpan' + - description: The organization ID the Telegraf config belongs to. + in: query + name: orgID + schema: + type: string responses: - "200": + '200': content: application/json: schema: @@ -6275,11 +6184,11 @@ paths: description: Unexpected error summary: List all Telegraf configurations tags: - - Telegrafs + - Telegrafs post: operationId: PostTelegrafs parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: '#/components/parameters/TraceSpan' requestBody: content: application/json: @@ -6288,7 +6197,7 @@ paths: description: Telegraf configuration to create required: true responses: - "201": + '201': content: application/json: schema: @@ -6302,20 +6211,20 @@ paths: description: Unexpected error summary: Create a Telegraf configuration tags: - - Telegrafs + - 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 + - $ref: '#/components/parameters/TraceSpan' + - description: The Telegraf configuration ID. + in: path + name: telegrafID + required: true + schema: + type: string responses: - "204": + '204': description: Delete has been accepted default: content: @@ -6325,29 +6234,29 @@ paths: description: Unexpected error summary: Delete a Telegraf configuration tags: - - Telegrafs + - 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 + - $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": + '200': content: application/json: schema: @@ -6373,17 +6282,17 @@ paths: description: Unexpected error summary: Retrieve a Telegraf configuration tags: - - Telegrafs + - Telegrafs put: operationId: PutTelegrafsID parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The Telegraf config ID. - in: path - name: telegrafID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The Telegraf config ID. + in: path + name: telegrafID + required: true + schema: + type: string requestBody: content: application/json: @@ -6392,7 +6301,7 @@ paths: description: Telegraf configuration update to apply required: true responses: - "200": + '200': content: application/json: schema: @@ -6406,20 +6315,20 @@ paths: description: Unexpected error summary: Update a Telegraf configuration tags: - - Telegrafs + - 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 + - $ref: '#/components/parameters/TraceSpan' + - description: The Telegraf config ID. + in: path + name: telegrafID + required: true + schema: + type: string responses: - "200": + '200': content: application/json: schema: @@ -6433,17 +6342,17 @@ paths: description: Unexpected error summary: List all labels for a Telegraf config tags: - - Telegrafs + - Telegrafs post: operationId: PostTelegrafsIDLabels parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The Telegraf config ID. - in: path - name: telegrafID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The Telegraf config ID. + in: path + name: telegrafID + required: true + schema: + type: string requestBody: content: application/json: @@ -6452,7 +6361,7 @@ paths: description: Label to add required: true responses: - "201": + '201': content: application/json: schema: @@ -6466,28 +6375,28 @@ paths: description: Unexpected error summary: Add a label to a Telegraf config tags: - - Telegrafs + - 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 + - $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": + '204': description: Delete has been accepted - "404": + '404': content: application/json: schema: @@ -6501,20 +6410,20 @@ paths: description: Unexpected error summary: Delete a label from a Telegraf config tags: - - Telegrafs + - 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 + - $ref: '#/components/parameters/TraceSpan' + - description: The Telegraf config ID. + in: path + name: telegrafID + required: true + schema: + type: string responses: - "200": + '200': content: application/json: schema: @@ -6528,17 +6437,17 @@ paths: description: Unexpected error summary: List all users with member privileges for a Telegraf config tags: - - Telegrafs + - Telegrafs post: operationId: PostTelegrafsIDMembers parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The Telegraf config ID. - in: path - name: telegrafID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The Telegraf config ID. + in: path + name: telegrafID + required: true + schema: + type: string requestBody: content: application/json: @@ -6547,7 +6456,7 @@ paths: description: User to add as member required: true responses: - "201": + '201': content: application/json: schema: @@ -6561,26 +6470,26 @@ paths: description: Unexpected error summary: Add a member to a Telegraf config tags: - - Telegrafs + - 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 + - $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": + '204': description: Member removed default: content: @@ -6590,20 +6499,20 @@ paths: description: Unexpected error summary: Remove a member from a Telegraf config tags: - - Telegrafs + - 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 + - $ref: '#/components/parameters/TraceSpan' + - description: The Telegraf configuration ID. + in: path + name: telegrafID + required: true + schema: + type: string responses: - "200": + '200': content: application/json: schema: @@ -6617,17 +6526,17 @@ paths: description: Unexpected error summary: List all owners of a Telegraf configuration tags: - - Telegrafs + - Telegrafs post: operationId: PostTelegrafsIDOwners parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The Telegraf configuration ID. - in: path - name: telegrafID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The Telegraf configuration ID. + in: path + name: telegrafID + required: true + schema: + type: string requestBody: content: application/json: @@ -6636,13 +6545,14 @@ paths: description: User to add as owner required: true responses: - "201": + '201': content: application/json: schema: $ref: '#/components/schemas/ResourceOwner' - description: Telegraf configuration owner was added. Returns a ResourceOwner - that references the User. + description: >- + Telegraf configuration owner was added. Returns a ResourceOwner that + references the User. default: content: application/json: @@ -6651,26 +6561,26 @@ paths: description: Unexpected error summary: Add an owner to a Telegraf configuration tags: - - Telegrafs + - 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 + - $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": + '204': description: Owner removed default: content: @@ -6680,7 +6590,7 @@ paths: description: Unexpected error summary: Remove an owner from a Telegraf config tags: - - Telegrafs + - Telegrafs /api/v2/templates/apply: post: description: Applies or performs a dry-run of template in an organization. @@ -6698,20 +6608,26 @@ paths: $ref: '#/components/schemas/TemplateApply' required: true responses: - "200": + '200': content: application/json: schema: $ref: '#/components/schemas/TemplateSummary' - description: | - Success. The package dry-run succeeded. No new resources were created. Returns a diff and summary of the dry-run. The diff and summary won't contain IDs for resources that didn't exist at the time of the dry-run. - "201": + description: > + Success. The package dry-run succeeded. No new resources were + created. Returns a diff and summary of the dry-run. 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 package applied successfully. Returns a diff and summary of the run. The summary contains newly created resources. The diff compares the initial state to the state after the package applied. This corresponds to `"dryRun": true`. + description: > + Success. The package applied successfully. Returns a diff and + summary of the run. The summary contains newly created resources. + The diff compares the initial state to the state after the package + applied. This corresponds to `"dryRun": true`. default: content: application/json: @@ -6720,7 +6636,7 @@ paths: description: Unexpected error summary: Apply or dry-run a template tags: - - Templates + - Templates /api/v2/templates/export: post: operationId: ExportTemplate @@ -6729,12 +6645,12 @@ paths: application/json: schema: oneOf: - - $ref: '#/components/schemas/TemplateExportByID' - - $ref: '#/components/schemas/TemplateExportByName' + - $ref: '#/components/schemas/TemplateExportByID' + - $ref: '#/components/schemas/TemplateExportByName' description: Export resources as an InfluxDB template. required: false responses: - "200": + '200': content: application/json: schema: @@ -6742,7 +6658,8 @@ paths: application/x-yaml: schema: $ref: '#/components/schemas/Template' - description: The template was created successfully. Returns the newly created + description: >- + The template was created successfully. Returns the newly created template. default: content: @@ -6752,25 +6669,25 @@ paths: description: Unexpected error summary: Export a new template tags: - - Templates + - Templates /api/v2/users: get: operationId: GetUsers parameters: - - $ref: '#/components/parameters/TraceSpan' - - $ref: '#/components/parameters/Offset' - - $ref: '#/components/parameters/Limit' - - $ref: '#/components/parameters/After' - - in: query - name: name - schema: - type: string - - in: query - name: id - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Limit' + - $ref: '#/components/parameters/After' + - in: query + name: name + schema: + type: string + - in: query + name: id + schema: + type: string responses: - "200": + '200': content: application/json: schema: @@ -6781,11 +6698,11 @@ paths: description: Unexpected error summary: List all users tags: - - Users + - Users post: operationId: PostUsers parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: '#/components/parameters/TraceSpan' requestBody: content: application/json: @@ -6794,7 +6711,7 @@ paths: description: User to create required: true responses: - "201": + '201': content: application/json: schema: @@ -6805,39 +6722,39 @@ paths: description: Unexpected error summary: Create a user tags: - - Users + - Users /api/v2/users/{userID}: delete: operationId: DeleteUsersID parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The ID of the user to delete. - in: path - name: userID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The ID of the user to delete. + in: path + name: userID + required: true + schema: + type: string responses: - "204": + '204': description: User deleted default: $ref: '#/components/responses/ServerError' description: Unexpected error summary: Delete a user tags: - - Users + - Users get: operationId: GetUsersID parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The user ID. - in: path - name: userID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The user ID. + in: path + name: userID + required: true + schema: + type: string responses: - "200": + '200': content: application/json: schema: @@ -6848,17 +6765,17 @@ paths: description: Unexpected error summary: Retrieve a user tags: - - Users + - Users patch: operationId: PatchUsersID parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The ID of the user to update. - in: path - name: userID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The ID of the user to update. + in: path + name: userID + required: true + schema: + type: string requestBody: content: application/json: @@ -6867,7 +6784,7 @@ paths: description: User update to apply required: true responses: - "200": + '200': content: application/json: schema: @@ -6878,18 +6795,18 @@ paths: description: Unexpected error summary: Update a user tags: - - Users + - Users /api/v2/users/{userID}/password: post: operationId: PostUsersIDPassword parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The user ID. - in: path - name: userID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The user ID. + in: path + name: userID + required: true + schema: + type: string requestBody: content: application/json: @@ -6898,7 +6815,7 @@ paths: description: New password required: true responses: - "204": + '204': description: Password successfully updated default: content: @@ -6907,33 +6824,33 @@ paths: $ref: '#/components/schemas/Error' description: Unsuccessful authentication security: - - BasicAuthentication: [] + - BasicAuthentication: [] summary: Update a password tags: - - Users + - Users /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 + - $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": + '200': content: application/json: schema: $ref: '#/components/schemas/Variables' description: A list of variables for an organization - "400": + '400': $ref: '#/components/responses/ServerError' description: Invalid request default: @@ -6941,11 +6858,11 @@ paths: description: Internal server error summary: List all variables tags: - - Variables + - Variables post: operationId: PostVariables parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: '#/components/parameters/TraceSpan' requestBody: content: application/json: @@ -6954,7 +6871,7 @@ paths: description: Variable to create required: true responses: - "201": + '201': content: application/json: schema: @@ -6965,45 +6882,45 @@ paths: description: Internal server error summary: Create a variable tags: - - Variables + - 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 + - $ref: '#/components/parameters/TraceSpan' + - description: The variable ID. + in: path + name: variableID + required: true + schema: + type: string responses: - "204": + '204': description: Variable deleted default: $ref: '#/components/responses/ServerError' description: Internal server error summary: Delete a variable tags: - - Variables + - Variables get: operationId: GetVariablesID parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The variable ID. - in: path - name: variableID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The variable ID. + in: path + name: variableID + required: true + schema: + type: string responses: - "200": + '200': content: application/json: schema: $ref: '#/components/schemas/Variable' description: Variable found - "404": + '404': $ref: '#/components/responses/ServerError' description: Variable not found default: @@ -7011,17 +6928,17 @@ paths: description: Internal server error summary: Retrieve a variable tags: - - Variables + - Variables patch: operationId: PatchVariablesID parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The variable ID. - in: path - name: variableID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The variable ID. + in: path + name: variableID + required: true + schema: + type: string requestBody: content: application/json: @@ -7030,7 +6947,7 @@ paths: description: Variable update to apply required: true responses: - "200": + '200': content: application/json: schema: @@ -7041,17 +6958,17 @@ paths: description: Internal server error summary: Update a variable tags: - - Variables + - Variables put: operationId: PutVariablesID parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The variable ID. - in: path - name: variableID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The variable ID. + in: path + name: variableID + required: true + schema: + type: string requestBody: content: application/json: @@ -7060,7 +6977,7 @@ paths: description: Variable to replace required: true responses: - "200": + '200': content: application/json: schema: @@ -7071,20 +6988,20 @@ paths: description: Internal server error summary: Replace a variable tags: - - Variables + - 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 + - $ref: '#/components/parameters/TraceSpan' + - description: The variable ID. + in: path + name: variableID + required: true + schema: + type: string responses: - "200": + '200': content: application/json: schema: @@ -7098,17 +7015,17 @@ paths: description: Unexpected error summary: List all labels for a variable tags: - - Variables + - Variables post: operationId: PostVariablesIDLabels parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The variable ID. - in: path - name: variableID - required: true - schema: - type: string + - $ref: '#/components/parameters/TraceSpan' + - description: The variable ID. + in: path + name: variableID + required: true + schema: + type: string requestBody: content: application/json: @@ -7117,7 +7034,7 @@ paths: description: Label to add required: true responses: - "201": + '201': content: application/json: schema: @@ -7131,28 +7048,28 @@ paths: description: Unexpected error summary: Add a label to a variable tags: - - Variables + - 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 + - $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": + '204': description: Delete has been accepted - "404": + '404': content: application/json: schema: @@ -7166,94 +7083,118 @@ paths: description: Unexpected error summary: Delete a label from a variable tags: - - Variables + - Variables /api/v2/write: post: - description: | + description: > Writes data to a bucket. - To write data into InfluxDB, you need the following: - - **organization** – _See [View organizations](https://docs.influxdata.com/influxdb/v2.0/organizations/view-orgs/#view-your-organization-id) for instructions on viewing your organization ID._ - - **bucket** – _See [View buckets](https://docs.influxdata.com/influxdb/v2.0/organizations/buckets/view-buckets/) for - instructions on viewing your bucket ID._ - - **API token** – _See [View tokens](https://docs.influxdata.com/influxdb/v2.0/security/tokens/view-tokens/) - for instructions on viewing your API token._ - - **InfluxDB URL** – _See [InfluxDB URLs](https://docs.influxdata.com/influxdb/v2.0/reference/urls/)_. - - data in [line protocol](https://docs.influxdata.com/influxdb/v2.0/reference/syntax/line-protocol) format. - For more information and examples, see [Write data with the InfluxDB API](https://docs.influxdata.com/influxdb/v2.0/write-data/developer-tools/api). + To write data into InfluxDB, you need the following: + + - **organization** – _See [View + organizations](https://docs.influxdata.com/influxdb/v2.0/organizations/view-orgs/#view-your-organization-id) + for instructions on viewing your organization ID._ + + - **bucket** – _See [View + buckets](https://docs.influxdata.com/influxdb/v2.0/organizations/buckets/view-buckets/) + for + instructions on viewing your bucket ID._ + - **API token** – _See [View + tokens](https://docs.influxdata.com/influxdb/v2.0/security/tokens/view-tokens/) + for instructions on viewing your API token._ + - **InfluxDB URL** – _See [InfluxDB + URLs](https://docs.influxdata.com/influxdb/v2.0/reference/urls/)_. + + - data in [line + protocol](https://docs.influxdata.com/influxdb/v2.0/reference/syntax/line-protocol) + format. + + + For more information and examples, see [Write data with the InfluxDB + API](https://docs.influxdata.com/influxdb/v2.0/write-data/developer-tools/api). operationId: PostWrite parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: When present, the header value tells the database that compression - is applied to the line protocol in the request body. - in: header - name: Content-Encoding - schema: - default: identity - description: The header value specifies that the line protocol in the request - body is encoded with gzip or not encoded with identity. - enum: - - gzip - - identity - type: string - - description: The header value indicates the format of the data in the request - body. - in: header - name: Content-Type - schema: - default: text/plain; charset=utf-8 - description: | - `text/plain` specifies line protocol. `UTF-8` is the default character set. - enum: - - text/plain - - text/plain; charset=utf-8 - - application/vnd.influx.arrow - type: string - - description: The header value indicates the size of the entity-body, in bytes, - sent to the database. If the length is greater than the database's `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 header value specifies the response format. - in: header - name: Accept - schema: - default: application/json - description: The response format for errors. - enum: - - application/json - type: string - - description: The parameter value specifies the destination organization for - writes. The database writes all points in the batch to this organization. - If you provide both `orgID` and `org` parameters, `org` takes precedence. - in: query - name: org - required: true - schema: - description: Organization name or ID. - type: string - - description: The parameter value specifies the ID of the destination organization - for writes. If both `orgID` and `org` are specified, `org` takes precedence. - in: query - name: orgID - schema: - type: string - - description: The destination bucket for writes. - in: query - name: bucket - required: true - schema: - description: All points within batch are written to this bucket. - type: string - - description: The precision for the unix timestamps within the body line-protocol. - in: query - name: precision - schema: - $ref: '#/components/schemas/WritePrecision' + - $ref: '#/components/parameters/TraceSpan' + - description: >- + When present, the header value tells the database that compression + is applied to the line protocol in the request body. + in: header + name: Content-Encoding + schema: + default: identity + description: >- + The header value specifies that the line protocol in the request + body is encoded with gzip or not encoded with identity. + enum: + - gzip + - identity + type: string + - description: >- + The header value indicates the format of the data in the request + body. + in: header + name: Content-Type + schema: + default: text/plain; charset=utf-8 + description: > + `text/plain` specifies line protocol. `UTF-8` is the default + character set. + enum: + - text/plain + - text/plain; charset=utf-8 + - application/vnd.influx.arrow + type: string + - description: >- + The header value indicates the size of the entity-body, in bytes, + sent to the database. If the length is greater than the database's + `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 header value specifies the response format. + in: header + name: Accept + schema: + default: application/json + description: The response format for errors. + enum: + - application/json + type: string + - description: >- + The parameter value specifies the destination organization for + writes. The database writes all points in the batch to this + organization. If you provide both `orgID` and `org` parameters, + `org` takes precedence. + in: query + name: org + required: true + schema: + description: Organization name or ID. + type: string + - description: >- + The parameter value specifies the ID of the destination organization + for writes. If both `orgID` and `org` are specified, `org` takes + precedence. + in: query + name: orgID + schema: + type: string + - description: The destination bucket for writes. + in: query + name: bucket + required: true + schema: + description: All points within batch are written to this bucket. + type: string + - description: The precision for the unix timestamps within the body line-protocol. + in: query + name: precision + schema: + $ref: '#/components/schemas/WritePrecision' requestBody: content: text/plain: @@ -7263,34 +7204,42 @@ paths: description: Data in line protocol format. required: true responses: - "204": - description: InfluxDB validated the request data format and accepted the - data for writing to the bucket. `204` doesn't indicate a successful write - operation since writes are asynchronous. See [how to check for write errors](https://docs.influxdata.com/influxdb/v2.0/write-data/troubleshoot). - "400": + '204': + description: >- + InfluxDB validated the request data format and accepted the data for + writing to the bucket. `204` doesn't indicate a successful write + operation since writes are asynchronous. See [how to check for write + errors](https://docs.influxdata.com/influxdb/v2.0/write-data/troubleshoot). + '400': content: application/json: examples: measurementSchemaFieldTypeConflict: - summary: Example of a field type conflict thrown by an explicit + summary: >- + Example of a field type conflict thrown by an explicit bucket schema value: code: invalid - message: 'partial write error (2 written): unable to parse ''air_sensor,service=S1,sensor=L1 - temperature="90.5",humidity=70.0 1632850122'': schema: field - type for field "temperature" not permitted by schema; got String - but expected Float' + message: >- + partial write error (2 written): unable to parse + 'air_sensor,service=S1,sensor=L1 + temperature="90.5",humidity=70.0 1632850122': schema: + field type for field "temperature" not permitted by + schema; got String but expected Float schema: $ref: '#/components/schemas/LineProtocolError' - description: Bad request. The line protocol data in the request is malformed. - The response body contains the first malformed line in the data. InfluxDB - rejected the batch and did not write any data. - "401": + description: >- + Bad request. The line protocol data in the request is malformed. The + response body contains the first malformed line in the data. + InfluxDB rejected the batch and did not write any data. + '401': content: application/json: examples: tokenNotAuthorized: - summary: Token is not authorized to access the organization or resource + summary: >- + Token is not authorized to access the organization or + resource value: code: unauthorized message: unauthorized access @@ -7301,7 +7250,7 @@ paths: * The `Authorization: Token` header is missing or malformed. * The API token value is missing from the header. * The token does not have sufficient permissions to write to this organization and bucket. - "404": + '404': content: application/json: examples: @@ -7312,17 +7261,21 @@ paths: message: bucket "air_sensor" not found schema: $ref: '#/components/schemas/Error' - description: Not found. A requested resource was not found. The response - body contains the requested resource type, e.g. `organization name` or + description: >- + Not found. A requested resource was not found. The response body + contains the requested resource type, e.g. `organization name` or `bucket`, and name. - "413": + '413': content: application/json: schema: $ref: '#/components/schemas/LineProtocolLengthError' - description: | - All request data was rejected and not written. InfluxDB OSS only returns this error if the [Go (golang) `ioutil.ReadAll()`](https://pkg.go.dev/io/ioutil#ReadAll) function raises an error. - "500": + description: > + All request data was rejected and not written. InfluxDB OSS only + returns this error if the [Go (golang) + `ioutil.ReadAll()`](https://pkg.go.dev/io/ioutil#ReadAll) function + raises an error. + '500': content: application/json: examples: @@ -7333,13 +7286,15 @@ paths: schema: $ref: '#/components/schemas/Error' description: Internal server error. - "503": - description: The server is temporarily unavailable to accept writes. The + '503': + description: >- + The 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. + description: >- + A non-negative decimal integer indicating the seconds to delay + after the response is received. schema: format: int32 type: integer @@ -7347,12 +7302,240 @@ paths: $ref: '#/components/responses/ServerError' summary: Write data tags: - - Write + - Write + /health: + get: + operationId: GetHealth + parameters: + - $ref: '#/components/parameters/TraceSpan' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/HealthCheck' + description: The instance is healthy + '503': + content: + application/json: + schema: + $ref: '#/components/schemas/HealthCheck' + description: The instance is unhealthy + default: + $ref: '#/components/responses/ServerError' + description: Unexpected error + servers: + - url: / + summary: Get the health of an instance + tags: + - Health + /legacy/authorizations: + get: + operationId: GetLegacyAuthorizations + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: Only show legacy authorizations that belong to a user ID. + in: query + name: userID + schema: + type: string + - description: Only show legacy authorizations that belong to a user name. + in: query + name: user + schema: + type: string + - description: Only show legacy authorizations that belong to an organization ID. + in: query + name: orgID + schema: + type: string + - description: Only show legacy authorizations that belong to a organization name. + in: query + name: org + schema: + type: string + - description: Only show legacy authorizations with a specified token (auth name). + in: query + name: token + schema: + type: string + - description: Only show legacy authorizations with a specified auth ID. + in: query + name: authID + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Authorizations' + description: A list of legacy authorizations + default: + $ref: '#/components/responses/ServerError' + description: Unexpected error + summary: List all legacy authorizations + tags: + - Legacy Authorizations + post: + operationId: PostLegacyAuthorizations + parameters: + - $ref: '#/components/parameters/TraceSpan' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LegacyAuthorizationPostRequest' + description: Legacy authorization to create + required: true + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/Authorization' + description: Legacy authorization created + '400': + $ref: '#/components/responses/ServerError' + description: Invalid request + default: + $ref: '#/components/responses/ServerError' + description: Unexpected error + summary: Create a legacy authorization + tags: + - Legacy Authorizations + servers: + - url: /private + /legacy/authorizations/{authID}: + delete: + operationId: DeleteLegacyAuthorizationsID + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The ID of the legacy authorization to delete. + in: path + name: authID + required: true + schema: + type: string + responses: + '204': + description: Legacy authorization deleted + default: + $ref: '#/components/responses/ServerError' + description: Unexpected error + summary: Delete a legacy authorization + tags: + - Legacy Authorizations + get: + operationId: GetLegacyAuthorizationsID + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The ID of the legacy authorization to get. + in: path + name: authID + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Authorization' + description: Legacy authorization details + default: + $ref: '#/components/responses/ServerError' + description: Unexpected error + summary: Retrieve a legacy authorization + tags: + - Legacy Authorizations + patch: + operationId: PatchLegacyAuthorizationsID + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The ID of the legacy authorization to update. + in: path + name: authID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AuthorizationUpdateRequest' + description: Legacy authorization to update + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Authorization' + description: The active or inactive legacy authorization + default: + $ref: '#/components/responses/ServerError' + description: Unexpected error + summary: Update a legacy authorization to be active or inactive + tags: + - Legacy Authorizations + servers: + - url: /private + /legacy/authorizations/{authID}/password: + post: + operationId: PostLegacyAuthorizationsIDPassword + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The ID of the legacy authorization to update. + in: path + name: authID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PasswordResetBody' + description: New password + required: true + responses: + '204': + description: Legacy authorization password set + default: + $ref: '#/components/responses/ServerError' + description: Unexpected error + summary: Set a legacy authorization password + tags: + - Legacy Authorizations + servers: + - url: /private + /ready: + get: + operationId: GetReady + parameters: + - $ref: '#/components/parameters/TraceSpan' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Ready' + description: The instance is ready + default: + $ref: '#/components/responses/ServerError' + description: Unexpected error + servers: + - url: / + summary: Get the readiness of an instance at startup + tags: + - Ready components: parameters: After: - description: | - The last resource ID from which to seek from (but not including). This is to be used instead of `offset`. + description: > + The last resource ID from which to seek from (but not including). This + is to be used instead of `offset`. in: query name: after required: false @@ -7392,8 +7575,8 @@ components: example: baggage: key: value - span_id: "1" - trace_id: "1" + span_id: '1' + trace_id: '1' in: header name: Zap-Trace-Span required: false @@ -7413,7 +7596,7 @@ components: name: type: string required: - - id + - id type: object AnalyzeQueryResponse: properties: @@ -7444,84 +7627,87 @@ components: type: object Authorization: allOf: - - $ref: '#/components/schemas/AuthorizationUpdateRequest' - - properties: - createdAt: - format: date-time - readOnly: true - type: string - 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: Name of the org token is scoped to. - readOnly: true - type: string - orgID: - description: ID of org that authorization is scoped to. - type: string - permissions: - description: List of permissions for an auth. An auth must have at least - one Permission. - items: - $ref: '#/components/schemas/Permission' - minItems: 1 - type: array - token: - description: Passed via the Authorization Header and Token Authentication - type. - readOnly: true - type: string - updatedAt: - format: date-time - readOnly: true - type: string - user: - description: Name of user that created and owns the token. - readOnly: true - type: string - userID: - description: ID of user that created and owns the token. - readOnly: true - type: string - type: object + - $ref: '#/components/schemas/AuthorizationUpdateRequest' + - properties: + createdAt: + format: date-time + readOnly: true + type: string + 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: Name of the org token is scoped to. + readOnly: true + type: string + orgID: + description: ID of org that authorization is scoped to. + type: string + permissions: + description: >- + List of permissions for an auth. An auth must have at least one + Permission. + items: + $ref: '#/components/schemas/Permission' + minItems: 1 + type: array + token: + description: >- + Passed via the Authorization Header and Token Authentication + type. + readOnly: true + type: string + updatedAt: + format: date-time + readOnly: true + type: string + user: + description: Name of user that created and owns the token. + readOnly: true + type: string + userID: + description: ID of user that created and owns the token. + readOnly: true + type: string + type: object required: - - orgID - - permissions + - orgID + - permissions AuthorizationPostRequest: allOf: - - $ref: '#/components/schemas/AuthorizationUpdateRequest' - - properties: - orgID: - description: ID of org that authorization is scoped to. - type: string - permissions: - description: List of permissions for an auth. An auth must have at least - one Permission. - items: - $ref: '#/components/schemas/Permission' - minItems: 1 - type: array - userID: - description: ID of user that authorization is scoped to. - type: string - type: object + - $ref: '#/components/schemas/AuthorizationUpdateRequest' + - properties: + orgID: + description: ID of org that authorization is scoped to. + type: string + permissions: + description: >- + List of permissions for an auth. An auth must have at least one + Permission. + items: + $ref: '#/components/schemas/Permission' + minItems: 1 + type: array + userID: + description: ID of user that authorization is scoped to. + type: string + type: object required: - - orgID - - permissions + - orgID + - permissions AuthorizationUpdateRequest: properties: description: @@ -7529,11 +7715,12 @@ components: type: string status: default: active - description: If inactive the token is inactive and requests using the token - will be rejected. + description: >- + If inactive the token is inactive and requests using the token will + be rejected. enum: - - active - - inactive + - active + - inactive type: string Authorizations: properties: @@ -7550,11 +7737,11 @@ components: properties: x: $ref: '#/components/schemas/Axis' - "y": + 'y': $ref: '#/components/schemas/Axis' required: - - x - - "y" + - x + - 'y' type: object Axis: description: The description of a particular axis for a visualization. @@ -7562,13 +7749,14 @@ components: base: description: Base represents the radix for formatting axis values. enum: - - "" - - "2" - - "10" + - '' + - '2' + - '10' type: string bounds: - description: The extents of an axis in the form [lower, upper]. Clients - determine whether bounds are to be inclusive or exclusive of their limits + description: >- + The extents of an axis in the form [lower, upper]. Clients determine + whether bounds are to be inclusive or exclusive of their limits items: type: string maxItems: 2 @@ -7589,12 +7777,13 @@ components: AxisScale: description: 'Scale is the axis formatting scale. Supported: "log", "linear"' enum: - - log - - linear + - log + - linear type: string BadStatement: - description: A placeholder for statements for which no correct statement nodes - can be created + description: >- + A placeholder for statements for which no correct statement nodes can be + created properties: text: description: Raw source text @@ -7623,10 +7812,10 @@ components: $ref: '#/components/schemas/XYGeom' hoverDimension: enum: - - auto - - x - - "y" - - xy + - auto + - x + - 'y' + - xy type: string legendColorizeRows: type: boolean @@ -7649,7 +7838,7 @@ components: type: array shape: enum: - - chronograf-v2 + - chronograf-v2 type: string showNoteWhenEmpty: description: If true, will display note when empty @@ -7660,7 +7849,7 @@ components: type: string type: enum: - - band + - band type: string upperColumn: type: string @@ -7685,14 +7874,14 @@ components: yTotalTicks: type: integer required: - - type - - geom - - queries - - shape - - axes - - colors - - note - - showNoteWhenEmpty + - type + - geom + - queries + - shape + - axes + - colors + - note + - showNoteWhenEmpty type: object BinaryExpression: description: uses binary operators to act on two operands in an expression @@ -7758,8 +7947,7 @@ components: description: URL to retrieve parent organization for this bucket owners: $ref: '#/components/schemas/Link' - description: URL to retrieve owners that can read and write to this - bucket. + description: URL to retrieve owners that can read and write to this bucket. self: $ref: '#/components/schemas/Link' description: URL for this bucket @@ -7782,8 +7970,8 @@ components: type: default: user enum: - - user - - system + - user + - system readOnly: true type: string updatedAt: @@ -7791,8 +7979,8 @@ components: readOnly: true type: string required: - - name - - retentionRules + - name + - retentionRules BucketMetadataManifest: properties: bucketID: @@ -7810,12 +7998,12 @@ components: retentionPolicies: $ref: '#/components/schemas/RetentionPolicyManifests' required: - - organizationID - - organizationName - - bucketID - - bucketName - - defaultRetentionPolicy - - retentionPolicies + - organizationID + - organizationName + - bucketID + - bucketName + - defaultRetentionPolicy + - retentionPolicies type: object BucketMetadataManifests: items: @@ -7830,8 +8018,8 @@ components: format: int64 type: integer required: - - oldId - - newId + - oldId + - newId type: object BucketShardMappings: items: @@ -7849,8 +8037,8 @@ components: type: object BuilderAggregateFunctionType: enum: - - filter - - group + - filter + - group type: string BuilderConfig: properties: @@ -7934,7 +8122,7 @@ components: x: format: int32 type: integer - "y": + 'y': format: int32 type: integer type: object @@ -7949,19 +8137,19 @@ components: x: format: int32 type: integer - "y": + 'y': format: int32 type: integer type: object CellWithViewProperties: allOf: - - $ref: '#/components/schemas/Cell' - - properties: - name: - type: string - properties: - $ref: '#/components/schemas/ViewProperties' - type: object + - $ref: '#/components/schemas/Cell' + - properties: + name: + type: string + properties: + $ref: '#/components/schemas/ViewProperties' + type: object type: object Cells: items: @@ -7973,7 +8161,7 @@ components: type: array Check: allOf: - - $ref: '#/components/schemas/CheckDiscriminator' + - $ref: '#/components/schemas/CheckDiscriminator' CheckBase: properties: createdAt: @@ -7993,9 +8181,9 @@ components: type: string lastRunStatus: enum: - - failed - - success - - canceled + - failed + - success + - canceled readOnly: true type: string latestCompleted: @@ -8049,9 +8237,9 @@ components: readOnly: true type: string required: - - name - - orgID - - query + - name + - orgID + - query CheckDiscriminator: discriminator: mapping: @@ -8060,9 +8248,9 @@ components: threshold: '#/components/schemas/ThresholdCheck' propertyName: type oneOf: - - $ref: '#/components/schemas/DeadmanCheck' - - $ref: '#/components/schemas/ThresholdCheck' - - $ref: '#/components/schemas/CustomCheck' + - $ref: '#/components/schemas/DeadmanCheck' + - $ref: '#/components/schemas/ThresholdCheck' + - $ref: '#/components/schemas/CustomCheck' CheckPatch: properties: description: @@ -8071,18 +8259,18 @@ components: type: string status: enum: - - active - - inactive + - active + - inactive type: string type: object CheckStatusLevel: description: The state to record if check matches a criteria. enum: - - UNKNOWN - - OK - - INFO - - CRIT - - WARN + - UNKNOWN + - OK + - INFO + - CRIT + - WARN type: string CheckViewProperties: properties: @@ -8110,18 +8298,18 @@ components: type: array shape: enum: - - chronograf-v2 + - chronograf-v2 type: string type: enum: - - check + - check type: string required: - - type - - shape - - checkID - - queries - - colors + - type + - shape + - checkID + - queries + - colors type: object Checks: properties: @@ -8132,7 +8320,8 @@ components: links: $ref: '#/components/schemas/Links' ConditionalExpression: - description: Selects one of two expressions, `Alternate` or `Consequent`, depending + description: >- + Selects one of two expressions, `Alternate` or `Consequent`, depending on a third boolean expression, `Test` properties: alternate: @@ -8148,7 +8337,7 @@ components: properties: type: enum: - - constant + - constant type: string values: items: @@ -8170,7 +8359,7 @@ components: x: format: int32 type: integer - "y": + 'y': format: int32 type: integer type: object @@ -8186,19 +8375,19 @@ components: description: The ID of the organization that owns the dashboard. type: string required: - - orgID - - name + - orgID + - name CustomCheck: allOf: - - $ref: '#/components/schemas/CheckBase' - - properties: - type: - enum: - - custom - type: string - required: - - type - type: object + - $ref: '#/components/schemas/CheckBase' + - properties: + type: + enum: + - custom + type: string + required: + - type + type: object DBRP: properties: bucketID: @@ -8208,8 +8397,9 @@ components: description: InfluxDB v1 database type: string default: - description: Specify if this mapping represents the default retention policy - for the database specificed. + description: >- + Specify if this mapping represents the default retention policy for + the database specificed. type: boolean id: description: the mapping identifier @@ -8224,12 +8414,12 @@ components: description: InfluxDB v1 retention policy type: string required: - - id - - orgID - - bucketID - - database - - retention_policy - - default + - id + - orgID + - bucketID + - database + - retention_policy + - default type: object DBRPCreate: properties: @@ -8240,8 +8430,9 @@ components: description: InfluxDB v1 database type: string default: - description: Specify if this mapping represents the default retention policy - for the database specificed. + description: >- + Specify if this mapping represents the default retention policy for + the database specificed. type: boolean org: description: the organization that owns this mapping. @@ -8253,9 +8444,9 @@ components: description: InfluxDB v1 retention policy type: string required: - - bucketID - - database - - retention_policy + - bucketID + - database + - retention_policy type: object DBRPGet: properties: @@ -8278,47 +8469,47 @@ components: 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 + - $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. @@ -8337,23 +8528,23 @@ components: type: description: Type is how the color is used. enum: - - min - - max - - threshold - - scale - - text - - background + - 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 + - id + - type + - hex + - name + - value type: object DashboardQuery: properties: @@ -8369,47 +8560,47 @@ components: 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 + - $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: @@ -8421,8 +8612,9 @@ components: $ref: '#/components/schemas/Links' type: object DateTimeLiteral: - description: Represents an instant in time with nanosecond precision using the - syntax of golang's RFC3339 Nanosecond variant + description: >- + Represents an instant in time with nanosecond precision using the syntax + of golang's RFC3339 Nanosecond variant properties: type: $ref: '#/components/schemas/NodeType' @@ -8432,49 +8624,51 @@ components: 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 + - $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. + 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 @@ -8500,19 +8694,21 @@ components: format: date-time type: string required: - - start - - stop + - start + - stop type: object Dialect: - description: Dialect are options to change the default CSV output format; https://www.w3.org/TR/2015/REC-tabular-metadata-20151217/#dialect-descriptions + description: >- + Dialect are options to change the default CSV output format; + https://www.w3.org/TR/2015/REC-tabular-metadata-20151217/#dialect-descriptions properties: annotations: description: https://www.w3.org/TR/2015/REC-tabular-data-model-20151217/#columns items: enum: - - group - - datatype - - default + - group + - datatype + - default type: string type: array uniqueItems: true @@ -8526,8 +8722,8 @@ components: default: RFC3339 description: Format of timestamps enum: - - RFC3339 - - RFC3339Nano + - RFC3339 + - RFC3339Nano type: string delimiter: default: ',' @@ -8562,8 +8758,9 @@ components: $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. + 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 @@ -8573,7 +8770,8 @@ components: type: string type: object DurationLiteral: - description: Represents the elapsed time between two instants as an int64 nanosecond + description: >- + Represents the elapsed time between two instants as an int64 nanosecond count with syntax of golang's time.Duration properties: type: @@ -8589,24 +8787,25 @@ components: code: description: code is the machine-readable error code. enum: - - internal error - - not found - - conflict - - invalid - - unprocessable entity - - empty value - - unavailable - - forbidden - - too many requests - - unauthorized - - method not allowed - - request too large - - unsupported media type + - internal error + - 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: err is a stack of errors that occurred during processing of - the request. Useful for debugging. + description: >- + err is a stack of errors that occurred during processing of the + request. Useful for debugging. readOnly: true type: string message: @@ -8614,40 +8813,42 @@ components: readOnly: true type: string op: - description: op describes the logical code operation during error. Useful - for debugging. + description: >- + op describes the logical code operation during error. Useful for + debugging. readOnly: true type: string required: - - code - - message + - code + - message 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' + - $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 does not return a value and is + description: >- + May consist of an expression that does not return a value and is executed solely for its side-effects properties: expression: @@ -8658,7 +8859,8 @@ components: Field: properties: alias: - description: Alias overrides the field name in the returned response. Applies + description: >- + Alias overrides the field name in the returned response. Applies only if type is `func` type: string args: @@ -8667,19 +8869,21 @@ components: $ref: '#/components/schemas/Field' type: array type: - description: '`type` describes the field type. `func` is a function. `field` - is a field reference.' + description: >- + `type` describes the field type. `func` is a function. `field` is a + field reference. enum: - - func - - field - - integer - - number - - regex - - wildcard + - 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 + description: >- + value is the value of the field. Meaning of the value is implied by + the `type` key type: string type: object File: @@ -8707,8 +8911,9 @@ components: additionalProperties: true type: object FloatLiteral: - description: Represents floating point numbers according to the double representations - defined by the IEEE-754-1985 + description: >- + Represents floating point numbers according to the double + representations defined by the IEEE-754-1985 properties: type: $ref: '#/components/schemas/NodeType' @@ -8768,7 +8973,7 @@ components: type: array shape: enum: - - chronograf-v2 + - chronograf-v2 type: string showNoteWhenEmpty: description: If true, will display note when empty @@ -8781,116 +8986,116 @@ components: type: string type: enum: - - gauge + - gauge type: string required: - - type - - queries - - colors - - shape - - note - - showNoteWhenEmpty - - prefix - - tickPrefix - - suffix - - tickSuffix - - decimalPlaces + - 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 + - $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 + - $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: + - $ref: '#/components/schemas/GeoViewLayerProperties' + - properties: + colorDimension: + $ref: '#/components/schemas/Axis' + colorField: + description: Marker color field type: string - type: array - required: - - colorField - - colorDimension - - colors - type: object + 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 + - $ref: '#/components/schemas/GeoViewLayerProperties' + - required: + - trackWidth + - speed + - randomColors + - trackPointVisualization + type: object properties: colors: description: Colors define color encoding of data into a visualization @@ -8908,29 +9113,28 @@ components: type: integer GeoViewLayer: oneOf: - - $ref: '#/components/schemas/GeoCircleViewLayer' - - $ref: '#/components/schemas/GeoHeatMapViewLayer' - - $ref: '#/components/schemas/GeoPointMapViewLayer' - - $ref: '#/components/schemas/GeoTrackMapViewLayer' + - $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 + - heatmap + - circleMap + - pointMap + - trackMap type: string required: - - type + - type type: object GeoViewProperties: properties: allowPanAndZoom: default: true - description: If true, map zoom and pan controls are enabled on the dashboard - view + 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 @@ -8944,8 +9148,8 @@ components: format: double type: number required: - - lat - - lon + - lat + - lon type: object colors: description: Colors define color encoding of data into a visualization @@ -8954,8 +9158,9 @@ components: type: array detectCoordinateFields: default: true - description: If true, search results get automatically regroupped so that - lon,lat and value are treated as columns + 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' @@ -8978,14 +9183,14 @@ components: type: string shape: enum: - - chronograf-v2 + - chronograf-v2 type: string showNoteWhenEmpty: description: If true, will display note when empty type: boolean type: enum: - - geo + - geo type: string useS2CellID: description: If true, S2 column is used to calculate lat/lon @@ -8997,83 +9202,83 @@ components: minimum: 1 type: number required: - - type - - shape - - queries - - note - - showNoteWhenEmpty - - center - - zoom - - allowPanAndZoom - - detectCoordinateFields - - layers + - 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 + - $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: + - $ref: '#/components/schemas/NotificationEndpointBase' + - properties: + authMethod: + enum: + - none + - basic + - bearer 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 + 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' + - $ref: '#/components/schemas/NotificationRuleBase' + - $ref: '#/components/schemas/HTTPNotificationRuleBase' HTTPNotificationRuleBase: properties: type: enum: - - http + - http type: string url: type: string required: - - type + - type type: object HealthCheck: properties: @@ -9089,14 +9294,14 @@ components: type: string status: enum: - - pass - - fail + - pass + - fail type: string version: type: string required: - - name - - status + - name + - status type: object HeatmapViewProperties: properties: @@ -9132,7 +9337,7 @@ components: type: array shape: enum: - - chronograf-v2 + - chronograf-v2 type: string showNoteWhenEmpty: description: If true, will display note when empty @@ -9141,7 +9346,7 @@ components: type: string type: enum: - - heatmap + - heatmap type: string xAxisLabel: type: string @@ -9186,23 +9391,23 @@ components: yTotalTicks: type: integer required: - - type - - queries - - colors - - shape - - note - - showNoteWhenEmpty - - xColumn - - yColumn - - xDomain - - yDomain - - xAxisLabel - - yAxisLabel - - xPrefix - - yPrefix - - xSuffix - - ySuffix - - binSize + - type + - queries + - colors + - shape + - note + - showNoteWhenEmpty + - xColumn + - yColumn + - xDomain + - yDomain + - xAxisLabel + - yAxisLabel + - xPrefix + - yPrefix + - xSuffix + - ySuffix + - binSize type: object HistogramViewProperties: properties: @@ -9230,8 +9435,8 @@ components: type: string position: enum: - - overlaid - - stacked + - overlaid + - stacked type: string queries: items: @@ -9239,14 +9444,14 @@ components: type: array shape: enum: - - chronograf-v2 + - chronograf-v2 type: string showNoteWhenEmpty: description: If true, will display note when empty type: boolean type: enum: - - histogram + - histogram type: string xAxisLabel: type: string @@ -9258,18 +9463,18 @@ components: type: number type: array required: - - type - - queries - - colors - - shape - - note - - showNoteWhenEmpty - - xColumn - - fillColumns - - xDomain - - xAxisLabel - - position - - binCount + - type + - queries + - colors + - shape + - note + - showNoteWhenEmpty + - xColumn + - fillColumns + - xDomain + - xAxisLabel + - position + - binCount type: object Identifier: description: A valid Flux identifier @@ -9310,7 +9515,8 @@ components: IsOnboarding: properties: allowed: - description: True means that the influxdb instance has NOT had initial setup; + description: >- + True means that the influxdb instance has NOT had initial setup; false means that the database has been setup. type: boolean type: object @@ -9327,8 +9533,9 @@ components: properties: additionalProperties: type: string - description: Key/Value pairs associated with this label. Keys can be removed - by sending an update with an empty value. + description: >- + Key/Value pairs associated with this label. Keys can be removed by + sending an update with an empty value. example: color: ffb3b3 description: this is a description @@ -9343,15 +9550,16 @@ components: properties: additionalProperties: type: string - description: Key/Value pairs associated with this label. Keys can be removed - by sending an update with an empty value. + description: >- + Key/Value pairs associated with this label. Keys can be removed by + sending an update with an empty value. example: color: ffb3b3 description: this is a description type: object required: - - orgID - - name + - orgID + - name type: object LabelMapping: properties: @@ -9372,8 +9580,9 @@ components: properties: additionalProperties: type: string - description: Key/Value pairs associated with this label. Keys can be removed - by sending an update with an empty value. + description: >- + Key/Value pairs associated with this label. Keys can be removed by + sending an update with an empty value. example: color: ffb3b3 description: this is a description @@ -9397,7 +9606,7 @@ components: description: Flux query script to be analyzed type: string required: - - query + - query type: object LatLonColumn: description: Object type for key and column definitions @@ -9409,8 +9618,8 @@ components: description: Key to determine whether the column is tag/field type: string required: - - key - - column + - key + - column type: object LatLonColumns: description: Object type to define lat/lon columns @@ -9420,48 +9629,49 @@ components: lon: $ref: '#/components/schemas/LatLonColumn' required: - - lat - - lon + - lat + - lon type: object LegacyAuthorizationPostRequest: allOf: - - $ref: '#/components/schemas/AuthorizationUpdateRequest' - - properties: - orgID: - description: ID of org that authorization is scoped to. - type: string - permissions: - description: List of permissions for an auth. An auth must have at least - one Permission. - items: - $ref: '#/components/schemas/Permission' - minItems: 1 - type: array - token: - description: Token (name) of the authorization - type: string - userID: - description: ID of user that authorization is scoped to. - type: string - type: object + - $ref: '#/components/schemas/AuthorizationUpdateRequest' + - properties: + orgID: + description: ID of org that authorization is scoped to. + type: string + permissions: + description: >- + List of permissions for an auth. An auth must have at least one + Permission. + items: + $ref: '#/components/schemas/Permission' + minItems: 1 + type: array + token: + description: Token (name) of the authorization + type: string + userID: + description: ID of user that authorization is scoped to. + type: string + type: object required: - - orgID - - permissions + - orgID + - permissions LesserThreshold: allOf: - - $ref: '#/components/schemas/ThresholdBase' - - properties: - type: - enum: - - lesser - type: string - value: - format: float - type: number - required: - - type - - value - type: object + - $ref: '#/components/schemas/ThresholdBase' + - properties: + type: + enum: + - lesser + type: string + value: + format: float + type: number + required: + - type + - value + type: object LinePlusSingleStatProperties: properties: axes: @@ -9483,10 +9693,10 @@ components: type: array hoverDimension: enum: - - auto - - x - - "y" - - xy + - auto + - x + - 'y' + - xy type: string legendColorizeRows: type: boolean @@ -9501,8 +9711,8 @@ components: type: string position: enum: - - overlaid - - stacked + - overlaid + - stacked type: string prefix: type: string @@ -9514,7 +9724,7 @@ components: type: boolean shape: enum: - - chronograf-v2 + - chronograf-v2 type: string showNoteWhenEmpty: description: If true, will display note when empty @@ -9527,7 +9737,7 @@ components: type: string type: enum: - - line-plus-single-stat + - line-plus-single-stat type: string xColumn: type: string @@ -9550,34 +9760,35 @@ components: yTotalTicks: type: integer required: - - type - - queries - - shape - - axes - - colors - - note - - showNoteWhenEmpty - - prefix - - suffix - - decimalPlaces - - position + - 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 + - internal error + - not found + - conflict + - invalid + - empty value + - unavailable readOnly: true type: string err: - description: Err is a stack of errors that occurred during processing of - the request. Useful for debugging. + description: >- + Err is a stack of errors that occurred during processing of the + request. Useful for debugging. readOnly: true type: string line: @@ -9590,21 +9801,22 @@ components: readOnly: true type: string op: - description: Op describes the logical code operation during error. Useful - for debugging. + description: >- + Op describes the logical code operation during error. Useful for + debugging. readOnly: true type: string required: - - code - - message - - op - - err + - code + - message + - op + - err LineProtocolLengthError: properties: code: description: Code is the machine-readable error code. enum: - - invalid + - invalid readOnly: true type: string maxLength: @@ -9617,9 +9829,9 @@ components: readOnly: true type: string required: - - code - - message - - maxLength + - code + - message + - maxLength Link: description: URI of resource. format: uri @@ -9634,7 +9846,7 @@ components: self: $ref: '#/components/schemas/Link' required: - - self + - self type: object LogEvent: properties: @@ -9654,8 +9866,9 @@ components: type: string type: object LogicalExpression: - description: Represents the rule conditions that collectively evaluate to either - true or false + description: >- + Represents the rule conditions that collectively evaluate to either true + or false properties: left: $ref: '#/components/schemas/Expression' @@ -9678,7 +9891,7 @@ components: properties: type: enum: - - map + - map type: string values: additionalProperties: @@ -9690,16 +9903,16 @@ components: type: string shape: enum: - - chronograf-v2 + - chronograf-v2 type: string type: enum: - - markdown + - markdown type: string required: - - type - - shape - - note + - type + - shape + - note type: object MemberAssignment: description: Object property assignment @@ -9732,9 +9945,9 @@ components: format: binary type: string required: - - kv - - sql - - buckets + - kv + - sql + - buckets type: object MosaicViewProperties: properties: @@ -9753,10 +9966,10 @@ components: type: array hoverDimension: enum: - - auto - - x - - "y" - - xy + - auto + - x + - 'y' + - xy type: string legendColorizeRows: type: boolean @@ -9775,7 +9988,7 @@ components: type: array shape: enum: - - chronograf-v2 + - chronograf-v2 type: string showNoteWhenEmpty: description: If true, will display note when empty @@ -9784,7 +9997,7 @@ components: type: string type: enum: - - mosaic + - mosaic type: string xAxisLabel: type: string @@ -9829,34 +10042,34 @@ components: ySuffix: type: string required: - - type - - queries - - colors - - shape - - note - - showNoteWhenEmpty - - xColumn - - ySeriesColumns - - fillColumns - - xDomain - - yDomain - - xAxisLabel - - yAxisLabel - - xPrefix - - yPrefix - - xSuffix - - ySuffix + - 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' + - $ref: '#/components/schemas/Expression' + - $ref: '#/components/schemas/Block' NodeType: description: Type of AST node type: string NotificationEndpoint: allOf: - - $ref: '#/components/schemas/NotificationEndpointDiscriminator' + - $ref: '#/components/schemas/NotificationEndpointDiscriminator' NotificationEndpointBase: properties: createdAt: @@ -9899,8 +10112,8 @@ components: default: active description: The status of the endpoint. enum: - - active - - inactive + - active + - inactive type: string type: $ref: '#/components/schemas/NotificationEndpointType' @@ -9911,8 +10124,8 @@ components: userID: type: string required: - - type - - name + - type + - name type: object NotificationEndpointDiscriminator: discriminator: @@ -9923,16 +10136,16 @@ components: telegram: '#/components/schemas/TelegramNotificationEndpoint' propertyName: type oneOf: - - $ref: '#/components/schemas/SlackNotificationEndpoint' - - $ref: '#/components/schemas/PagerDutyNotificationEndpoint' - - $ref: '#/components/schemas/HTTPNotificationEndpoint' - - $ref: '#/components/schemas/TelegramNotificationEndpoint' + - $ref: '#/components/schemas/SlackNotificationEndpoint' + - $ref: '#/components/schemas/PagerDutyNotificationEndpoint' + - $ref: '#/components/schemas/HTTPNotificationEndpoint' + - $ref: '#/components/schemas/TelegramNotificationEndpoint' NotificationEndpointType: enum: - - slack - - pagerduty - - http - - telegram + - slack + - pagerduty + - http + - telegram type: string NotificationEndpointUpdate: properties: @@ -9942,8 +10155,8 @@ components: type: string status: enum: - - active - - inactive + - active + - inactive type: string type: object NotificationEndpoints: @@ -9956,7 +10169,7 @@ components: type: array NotificationRule: allOf: - - $ref: '#/components/schemas/NotificationRuleDiscriminator' + - $ref: '#/components/schemas/NotificationRuleDiscriminator' NotificationRuleBase: properties: createdAt: @@ -9981,9 +10194,9 @@ components: type: string lastRunStatus: enum: - - failed - - success - - canceled + - failed + - success + - canceled readOnly: true type: string latestCompleted: @@ -9992,12 +10205,14 @@ components: readOnly: true type: string limit: - description: Don't notify me more than times every - seconds. If set, limitEvery cannot be empty. + 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. + description: >- + Don't notify me more than times every seconds. + If set, limit cannot be empty. type: integer links: example: @@ -10062,11 +10277,11 @@ components: readOnly: true type: string required: - - orgID - - status - - name - - statusRules - - endpointID + - orgID + - status + - name + - statusRules + - endpointID type: object NotificationRuleDiscriminator: discriminator: @@ -10078,11 +10293,11 @@ components: 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' + - $ref: '#/components/schemas/SlackNotificationRule' + - $ref: '#/components/schemas/SMTPNotificationRule' + - $ref: '#/components/schemas/PagerDutyNotificationRule' + - $ref: '#/components/schemas/HTTPNotificationRule' + - $ref: '#/components/schemas/TelegramNotificationRule' NotificationRuleUpdate: properties: description: @@ -10091,8 +10306,8 @@ components: type: string status: enum: - - active - - inactive + - active + - inactive type: string type: object NotificationRules: @@ -10124,22 +10339,25 @@ components: type: string retentionPeriodHrs: deprecated: true - description: | - Retention period *in nanoseconds* for the new bucket. This key's name has been misleading since OSS 2.0 GA, please transition to use `retentionPeriodSeconds` + description: > + Retention period *in nanoseconds* for the new bucket. This key's + name has been misleading since OSS 2.0 GA, please transition to use + `retentionPeriodSeconds` type: integer retentionPeriodSeconds: format: int64 type: integer token: - description: | - Authentication token to set on the initial user. If not specified, the server will generate a token. + description: > + Authentication token to set on the initial user. If not specified, + the server will generate a token. type: string username: type: string required: - - username - - org - - bucket + - username + - org + - bucket type: object OnboardingResponse: properties: @@ -10157,8 +10375,8 @@ components: properties: assignment: oneOf: - - $ref: '#/components/schemas/VariableAssignment' - - $ref: '#/components/schemas/MemberAssignment' + - $ref: '#/components/schemas/VariableAssignment' + - $ref: '#/components/schemas/MemberAssignment' type: $ref: '#/components/schemas/NodeType' type: object @@ -10208,15 +10426,15 @@ components: default: active description: If inactive the organization is inactive. enum: - - active - - inactive + - active + - inactive type: string updatedAt: format: date-time readOnly: true type: string required: - - name + - name Organizations: properties: links: @@ -10253,31 +10471,31 @@ components: type: object PagerDutyNotificationEndpoint: allOf: - - $ref: '#/components/schemas/NotificationEndpointBase' - - properties: - clientURL: - type: string - routingKey: - type: string - required: - - routingKey - type: object + - $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' + - $ref: '#/components/schemas/NotificationRuleBase' + - $ref: '#/components/schemas/PagerDutyNotificationRuleBase' PagerDutyNotificationRuleBase: properties: messageTemplate: type: string type: enum: - - pagerduty + - pagerduty type: string required: - - type - - messageTemplate + - type + - messageTemplate type: object ParenExpression: description: Represents an expression wrapped in parenthesis @@ -10292,7 +10510,7 @@ components: password: type: string required: - - password + - password PatchBucketRequest: description: Updates to an existing bucket resource. properties: @@ -10316,7 +10534,8 @@ components: description: Updates to a rule to expire or retain data. properties: everySeconds: - description: Duration in seconds for how long data will be kept in the database. + description: >- + Duration in seconds for how long data will be kept in the database. 0 means infinite. example: 86400 format: int64 @@ -10329,10 +10548,10 @@ components: type: default: expire enum: - - expire + - expire type: string required: - - type + - type type: object PatchRetentionRules: description: Updates to rules to expire or retain data. No rules means no updates. @@ -10343,14 +10562,14 @@ components: properties: action: enum: - - read - - write + - read + - write type: string resource: $ref: '#/components/schemas/Resource' required: - - action - - resource + - action + - resource PipeExpression: description: Call expression with pipe argument properties: @@ -10362,8 +10581,9 @@ components: $ref: '#/components/schemas/NodeType' type: object PipeLiteral: - description: Represents a specialized literal value, indicating the left hand - value of a pipe expression + description: >- + Represents a specialized literal value, indicating the left hand value + of a pipe expression properties: type: $ref: '#/components/schemas/NodeType' @@ -10384,18 +10604,18 @@ components: $ref: '#/components/schemas/SchemaType' default: implicit required: - - orgID - - name - - retentionRules + - orgID + - name + - retentionRules PostCheck: allOf: - - $ref: '#/components/schemas/CheckDiscriminator' + - $ref: '#/components/schemas/CheckDiscriminator' PostNotificationEndpoint: allOf: - - $ref: '#/components/schemas/NotificationEndpointDiscriminator' + - $ref: '#/components/schemas/NotificationEndpointDiscriminator' PostNotificationRule: allOf: - - $ref: '#/components/schemas/NotificationRuleDiscriminator' + - $ref: '#/components/schemas/NotificationRuleDiscriminator' PostOrganizationRequest: properties: description: @@ -10403,7 +10623,7 @@ components: name: type: string required: - - name + - name type: object Property: description: The value associated with a key @@ -10417,8 +10637,8 @@ components: type: object PropertyKey: oneOf: - - $ref: '#/components/schemas/Identifier' - - $ref: '#/components/schemas/StringLiteral' + - $ref: '#/components/schemas/Identifier' + - $ref: '#/components/schemas/StringLiteral' Query: description: Query influx using the Flux language properties: @@ -10427,14 +10647,17 @@ components: extern: $ref: '#/components/schemas/File' now: - description: Specifies the time that should be reported as "now" in the - query. Default is the server's now time. + description: >- + Specifies the time that should be reported as "now" in the query. + Default is the server's now time. format: date-time type: string params: additionalProperties: true - description: | - Enumeration of key/value pairs that respresent parameters to be injected into query (can only specify either this field or extern and not both) + description: > + Enumeration of key/value pairs that respresent parameters to be + injected into query (can only specify either this field or extern + and not both) type: object query: description: Query script to execute. @@ -10442,21 +10665,21 @@ components: type: description: The type of query. Must be "flux". enum: - - flux + - flux type: string required: - - query + - query type: object QueryEditMode: enum: - - builder - - advanced + - builder + - advanced type: string QueryVariableProperties: properties: type: enum: - - query + - query type: string values: properties: @@ -10467,43 +10690,44 @@ components: 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 + - $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" + example: 2019-03-13T10:09:33.891196-04:00 format: date-time type: string status: enum: - - ready + - 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 + description: >- + Expressions begin and end with `/` and are regular expressions with + syntax accepted by RE2 properties: type: $ref: '#/components/schemas/NodeType' @@ -10529,12 +10753,12 @@ components: format: uri type: string required: - - id - - name - - orgID - - remoteURL - - remoteOrgID - - allowInsecureTLS + - id + - name + - orgID + - remoteURL + - remoteOrgID + - allowInsecureTLS type: object RemoteConnectionCreationRequest: properties: @@ -10555,12 +10779,12 @@ components: format: uri type: string required: - - name - - orgID - - remoteURL - - remoteAPIToken - - remoteOrgID - - allowInsecureTLS + - name + - orgID + - remoteURL + - remoteAPIToken + - remoteOrgID + - allowInsecureTLS type: object RemoteConnectionUpdateRequest: properties: @@ -10627,14 +10851,14 @@ components: remoteID: type: string required: - - id - - name - - remoteID - - orgID - - localBucketID - - remoteBucketID - - maxQueueSizeBytes - - currentQueueSizeBytes + - id + - name + - remoteID + - orgID + - localBucketID + - remoteBucketID + - maxQueueSizeBytes + - currentQueueSizeBytes type: object ReplicationCreationRequest: properties: @@ -10656,12 +10880,12 @@ components: remoteID: type: string required: - - name - - orgID - - remoteID - - localBucketID - - remoteBucketID - - maxQueueSizeBytes + - name + - orgID + - remoteID + - localBucketID + - remoteBucketID + - maxQueueSizeBytes type: object ReplicationUpdateRequest: properties: @@ -10688,57 +10912,57 @@ components: Resource: properties: id: - description: If ID is set that is a permission for a specific resource. - if it is not set it is a permission for all resources of that resource - type. + description: >- + If ID is set that is a permission for a specific resource. if it is + not set it is a permission for all resources of that resource type. type: string name: description: Optional name of the resource if the resource has a name field. type: string org: - description: Optional name of the organization of the organization with - orgID. + description: Optional name of the organization of the organization with orgID. type: string orgID: - description: If orgID is set that is a permission for all resources owned - my that org. if it is not set it is a permission for all resources of - that resource type. + description: >- + If orgID is set that is a permission for all resources owned my that + org. if it is not set it is a permission for all resources of that + resource type. type: string type: enum: - - authorizations - - buckets - - dashboards - - orgs - - sources - - tasks - - telegrafs - - users - - variables - - scrapers - - secrets - - labels - - views - - documents - - notificationRules - - notificationEndpoints - - checks - - dbrp - - notebooks + - authorizations + - buckets + - dashboards + - orgs + - sources + - tasks + - telegrafs + - users + - variables + - scrapers + - secrets + - labels + - views + - documents + - notificationRules + - notificationEndpoints + - checks + - dbrp + - notebooks type: string required: - - type + - type type: object ResourceMember: allOf: - - $ref: '#/components/schemas/UserResponse' - - properties: - role: - default: member - enum: - - member - type: string - type: object + - $ref: '#/components/schemas/UserResponse' + - properties: + role: + default: member + enum: + - member + type: string + type: object ResourceMembers: properties: links: @@ -10754,14 +10978,14 @@ components: type: object ResourceOwner: allOf: - - $ref: '#/components/schemas/UserResponse' - - properties: - role: - default: owner - enum: - - owner - type: string - type: object + - $ref: '#/components/schemas/UserResponse' + - properties: + role: + default: owner + enum: + - owner + type: string + type: object ResourceOwners: properties: links: @@ -10785,9 +11009,9 @@ components: shardMappings: $ref: '#/components/schemas/BucketShardMappings' required: - - id - - name - - shardMappings + - id + - name + - shardMappings type: object RetentionPolicyManifest: properties: @@ -10806,12 +11030,12 @@ components: subscriptions: $ref: '#/components/schemas/SubscriptionManifests' required: - - name - - replicaN - - duration - - shardGroupDuration - - shardGroups - - subscriptions + - name + - replicaN + - duration + - shardGroupDuration + - shardGroups + - subscriptions type: object RetentionPolicyManifests: items: @@ -10820,7 +11044,8 @@ components: RetentionRule: properties: everySeconds: - description: Duration in seconds for how long data will be kept in the database. + description: >- + Duration in seconds for how long data will be kept in the database. 0 means infinite. example: 86400 format: int64 @@ -10833,11 +11058,11 @@ components: type: default: expire enum: - - expire + - expire type: string required: - - type - - everySeconds + - type + - everySeconds type: object RetentionRules: description: Rules to expire or retain data. No rules means data never expires. @@ -10935,12 +11160,12 @@ components: RuleStatusLevel: description: The state to record if check matches a criteria. enum: - - UNKNOWN - - OK - - INFO - - CRIT - - WARN - - ANY + - UNKNOWN + - OK + - INFO + - CRIT + - WARN + - ANY type: string Run: properties: @@ -10991,11 +11216,11 @@ components: type: string status: enum: - - scheduled - - started - - failed - - success - - canceled + - scheduled + - started + - failed + - success + - canceled readOnly: true type: string taskID: @@ -11004,8 +11229,9 @@ components: RunManually: properties: scheduledFor: - description: Time used for run's "now" option, RFC3339. Default is the - server's now time. + description: >- + Time used for run's "now" option, RFC3339. Default is the server's + now time. format: date-time nullable: true type: string @@ -11020,8 +11246,8 @@ components: type: object SMTPNotificationRule: allOf: - - $ref: '#/components/schemas/NotificationRuleBase' - - $ref: '#/components/schemas/SMTPNotificationRuleBase' + - $ref: '#/components/schemas/NotificationRuleBase' + - $ref: '#/components/schemas/SMTPNotificationRuleBase' SMTPNotificationRuleBase: properties: bodyTemplate: @@ -11032,12 +11258,12 @@ components: type: string type: enum: - - smtp + - smtp type: string required: - - type - - subjectTemplate - - to + - type + - subjectTemplate + - to type: object ScatterViewProperties: properties: @@ -11075,7 +11301,7 @@ components: type: array shape: enum: - - chronograf-v2 + - chronograf-v2 type: string showNoteWhenEmpty: description: If true, will display note when empty @@ -11088,7 +11314,7 @@ components: type: string type: enum: - - scatter + - scatter type: string xAxisLabel: type: string @@ -11133,29 +11359,29 @@ components: yTotalTicks: type: integer required: - - type - - queries - - colors - - shape - - note - - showNoteWhenEmpty - - xColumn - - yColumn - - fillColumns - - symbolColumns - - xDomain - - yDomain - - xAxisLabel - - yAxisLabel - - xPrefix - - yPrefix - - xSuffix - - ySuffix + - type + - queries + - colors + - shape + - note + - showNoteWhenEmpty + - xColumn + - yColumn + - fillColumns + - symbolColumns + - xDomain + - yDomain + - xAxisLabel + - yAxisLabel + - xPrefix + - yPrefix + - xSuffix + - ySuffix type: object SchemaType: enum: - - implicit - - explicit + - implicit + - explicit type: string ScraperTargetRequest: properties: @@ -11175,7 +11401,7 @@ components: type: description: The type of the metrics to be parsed. enum: - - prometheus + - prometheus type: string url: description: The URL of the metrics endpoint. @@ -11184,38 +11410,38 @@ components: type: object ScraperTargetResponse: allOf: - - $ref: '#/components/schemas/ScraperTargetRequest' - - properties: - bucket: - description: The bucket name. - type: string - id: - readOnly: true - type: string - links: - example: - bucket: /api/v2/buckets/1 - members: /api/v2/scrapers/1/members - organization: /api/v2/orgs/1 - owners: /api/v2/scrapers/1/owners - self: /api/v2/scrapers/1 - properties: - bucket: - $ref: '#/components/schemas/Link' - members: - $ref: '#/components/schemas/Link' - organization: - $ref: '#/components/schemas/Link' - owners: - $ref: '#/components/schemas/Link' - self: - $ref: '#/components/schemas/Link' - readOnly: true - type: object - org: - description: The name of the organization. - type: string - type: object + - $ref: '#/components/schemas/ScraperTargetRequest' + - properties: + bucket: + description: The bucket name. + type: string + id: + readOnly: true + type: string + links: + example: + bucket: /api/v2/buckets/1 + members: /api/v2/scrapers/1/members + organization: /api/v2/orgs/1 + owners: /api/v2/scrapers/1/owners + self: /api/v2/scrapers/1 + properties: + bucket: + $ref: '#/components/schemas/Link' + members: + $ref: '#/components/schemas/Link' + organization: + $ref: '#/components/schemas/Link' + owners: + $ref: '#/components/schemas/Link' + self: + $ref: '#/components/schemas/Link' + readOnly: true + type: object + org: + description: The name of the organization. + type: string + type: object type: object ScraperTargetResponses: properties: @@ -11233,17 +11459,17 @@ components: type: object SecretKeysResponse: allOf: - - $ref: '#/components/schemas/SecretKeys' - - properties: - links: - properties: - org: - type: string - self: - type: string - readOnly: true - type: object - type: object + - $ref: '#/components/schemas/SecretKeys' + - properties: + links: + properties: + org: + type: string + self: + type: string + readOnly: true + type: object + type: object Secrets: additionalProperties: type: string @@ -11269,10 +11495,10 @@ components: format: date-time type: string required: - - id - - startTime - - endTime - - shards + - id + - startTime + - endTime + - shards type: object ShardGroupManifests: items: @@ -11286,8 +11512,8 @@ components: shardOwners: $ref: '#/components/schemas/ShardOwners' required: - - id - - shardOwners + - id + - shardOwners type: object ShardManifests: items: @@ -11300,7 +11526,7 @@ components: format: int64 type: integer required: - - nodeID + - nodeID type: object ShardOwners: items: @@ -11316,7 +11542,7 @@ components: type: array shape: enum: - - chronograf-v2 + - chronograf-v2 type: string showAll: type: boolean @@ -11325,15 +11551,15 @@ components: type: boolean type: enum: - - simple-table + - simple-table type: string required: - - type - - showAll - - queries - - shape - - note - - showNoteWhenEmpty + - type + - showAll + - queries + - shape + - note + - showNoteWhenEmpty type: object SingleStatViewProperties: properties: @@ -11354,7 +11580,7 @@ components: type: array shape: enum: - - chronograf-v2 + - chronograf-v2 type: string showNoteWhenEmpty: description: If true, will display note when empty @@ -11369,38 +11595,39 @@ components: type: string type: enum: - - single-stat + - single-stat type: string required: - - type - - queries - - colors - - shape - - note - - showNoteWhenEmpty - - prefix - - tickPrefix - - suffix - - tickSuffix - - decimalPlaces + - 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 + - $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' + - $ref: '#/components/schemas/NotificationRuleBase' + - $ref: '#/components/schemas/SlackNotificationRuleBase' SlackNotificationRuleBase: properties: channel: @@ -11409,11 +11636,11 @@ components: type: string type: enum: - - slack + - slack type: string required: - - type - - messageTemplate + - type + - messageTemplate type: object Source: properties: @@ -11428,7 +11655,7 @@ components: languages: items: enum: - - flux + - flux type: string readOnly: true type: array @@ -11460,9 +11687,9 @@ components: type: string type: enum: - - v1 - - v2 - - self + - v1 + - v2 + - self type: string url: format: uri @@ -11546,14 +11773,14 @@ components: 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' + - $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: @@ -11605,9 +11832,9 @@ components: name: type: string required: - - name - - mode - - destinations + - name + - mode + - destinations type: object SubscriptionManifests: items: @@ -11623,7 +11850,8 @@ components: decimalPlaces: $ref: '#/components/schemas/DecimalPlaces' fieldOptions: - description: fieldOptions represent the fields retrieved by the query with + description: >- + fieldOptions represent the fields retrieved by the query with customization options items: $ref: '#/components/schemas/RenamableField' @@ -11636,7 +11864,7 @@ components: type: array shape: enum: - - chronograf-v2 + - chronograf-v2 type: string showNoteWhenEmpty: description: If true, will display note when empty @@ -11644,43 +11872,47 @@ components: tableOptions: properties: fixFirstColumn: - description: fixFirstColumn indicates whether the first column of the - table should be locked + 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 + 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 + description: >- + Wrapping describes the text wrapping style to be used in table + views enum: - - truncate - - wrap - - single-line + - truncate + - wrap + - single-line type: string type: object timeFormat: - description: timeFormat describes the display format for time values according - to moment.js date formatting + description: >- + timeFormat describes the display format for time values according to + moment.js date formatting type: string type: enum: - - table + - table type: string required: - - type - - queries - - colors - - shape - - note - - showNoteWhenEmpty - - tableOptions - - fieldOptions - - timeFormat - - decimalPlaces + - type + - queries + - colors + - shape + - note + - showNoteWhenEmpty + - tableOptions + - fieldOptions + - timeFormat + - decimalPlaces type: object TagRule: properties: @@ -11688,10 +11920,10 @@ components: type: string operator: enum: - - equal - - notequal - - equalregex - - notequalregex + - equal + - notequal + - equalregex + - notequalregex type: string value: type: string @@ -11699,16 +11931,18 @@ components: Task: properties: authorizationID: - description: The ID of the authorization used when this task communicates - with the query engine. + description: >- + The ID of the authorization used when this task communicates with + the query engine. type: string createdAt: format: date-time readOnly: true type: string cron: - description: A task repetition schedule in the form '* * * * * *'; parsed - from Flux. + description: >- + A task repetition schedule in the form '* * * * * *'; parsed from + Flux. type: string description: description: An optional description of the task. @@ -11729,9 +11963,9 @@ components: type: string lastRunStatus: enum: - - failed - - success - - canceled + - failed + - success + - canceled readOnly: true type: string latestCompleted: @@ -11766,9 +12000,10 @@ components: description: The name of the task. type: string offset: - description: Duration to delay after the schedule, before executing the - task; parsed from flux, if set to zero it will remove this option and - use 0 as the default. + description: >- + Duration to delay after the schedule, before executing the task; + parsed from flux, if set to zero it will remove this option and use + 0 as the default. type: string org: description: The name of the organization that owns this Task. @@ -11782,7 +12017,8 @@ components: status: $ref: '#/components/schemas/TaskStatusType' type: - description: The type of task, this can be used for filtering tasks on list + description: >- + The type of task, this can be used for filtering tasks on list actions. type: string updatedAt: @@ -11790,10 +12026,10 @@ components: readOnly: true type: string required: - - id - - name - - orgID - - flux + - id + - name + - orgID + - flux type: object TaskCreateRequest: properties: @@ -11812,12 +12048,12 @@ components: status: $ref: '#/components/schemas/TaskStatusType' required: - - flux + - flux type: object TaskStatusType: enum: - - active - - inactive + - active + - inactive type: string TaskUpdateRequest: properties: @@ -11854,32 +12090,32 @@ components: type: object Telegraf: allOf: - - $ref: '#/components/schemas/TelegrafRequest' - - properties: - id: - readOnly: true - type: string - labels: - $ref: '#/components/schemas/Labels' - readOnly: true - links: - example: - lables: /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 + - $ref: '#/components/schemas/TelegrafRequest' + - properties: + id: + readOnly: true + type: string + labels: + $ref: '#/components/schemas/Labels' + readOnly: true + links: + example: + lables: /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: @@ -11930,52 +12166,58 @@ components: type: object TelegramNotificationEndpoint: allOf: - - $ref: '#/components/schemas/NotificationEndpointBase' - - properties: - channel: - description: 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 + - $ref: '#/components/schemas/NotificationEndpointBase' + - properties: + channel: + description: >- + 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' + - $ref: '#/components/schemas/NotificationRuleBase' + - $ref: '#/components/schemas/TelegramNotificationRuleBase' TelegramNotificationRuleBase: properties: disableWebPagePreview: - description: Disables preview of web links in the sent messages when "true". + 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" . + description: >- + Parse mode of the message text per + https://core.telegram.org/bots/api#formatting-options . Defaults to + "MarkdownV2" . enum: - - MarkdownV2 - - HTML - - Markdown + - MarkdownV2 + - HTML + - Markdown type: string type: - description: The discriminator between other types of notification rules - is "telegram". + description: >- + The discriminator between other types of notification rules is + "telegram". enum: - - telegram + - telegram type: string required: - - type - - messageTemplate - - channel + - type + - messageTemplate + - channel type: object Template: items: @@ -11998,45 +12240,45 @@ components: actions: items: oneOf: - - properties: - action: - enum: - - skipKind - type: string - properties: + - properties: + action: + enum: + - skipKind + type: string 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' + required: + - kind + type: object + type: object + - properties: + action: + enum: + - skipResource + type: string properties: - kind: - $ref: '#/components/schemas/TemplateKind' - resourceTemplateName: - type: string - required: - - kind - - resourceTemplateName - type: object - type: object + properties: + kind: + $ref: '#/components/schemas/TemplateKind' + resourceTemplateName: + type: string + required: + - kind + - resourceTemplateName + type: object + type: object type: array dryRun: type: boolean envRefs: additionalProperties: oneOf: - - type: string - - type: integer - - type: number - - type: boolean + - type: string + - type: integer + - type: number + - type: boolean type: object orgID: type: string @@ -12048,7 +12290,7 @@ components: url: type: string required: - - url + - url type: object type: array secrets: @@ -12099,16 +12341,18 @@ components: items: properties: defaultValue: - description: Default value that will be provided for the reference when - no value is provided + 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 + - type: string + - type: integer + - type: number + - type: boolean envRefKey: - description: Key identified as environment reference and is the key identified + description: >- + Key identified as environment reference and is the key identified in the template type: string resourceField: @@ -12118,13 +12362,13 @@ components: description: Value provided to fulfill reference nullable: true oneOf: - - type: string - - type: integer - - type: number - - type: boolean + - type: string + - type: integer + - type: number + - type: boolean required: - - resourceField - - envRefKey + - resourceField + - envRefKey type: object type: array TemplateExportByID: @@ -12155,13 +12399,14 @@ components: 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 + 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 + - id + - kind type: object type: array stackID: @@ -12195,8 +12440,8 @@ components: name: type: string required: - - name - - kind + - name + - kind type: object type: array stackID: @@ -12204,20 +12449,20 @@ components: type: object TemplateKind: enum: - - Bucket - - Check - - CheckDeadman - - CheckThreshold - - Dashboard - - Label - - NotificationEndpoint - - NotificationEndpointHTTP - - NotificationEndpointPagerDuty - - NotificationEndpointSlack - - NotificationRule - - Task - - Telegraf - - Variable + - Bucket + - Check + - CheckDeadman + - CheckThreshold + - Dashboard + - Label + - NotificationEndpoint + - NotificationEndpointHTTP + - NotificationEndpointPagerDuty + - NotificationEndpointSlack + - NotificationRule + - Task + - Telegraf + - Variable type: string TemplateSummary: properties: @@ -12619,19 +12864,19 @@ components: 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 + - $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: @@ -12696,19 +12941,19 @@ components: 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 + - $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: @@ -12793,19 +13038,19 @@ components: 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 + - $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: @@ -12872,9 +13117,9 @@ components: range: '#/components/schemas/RangeThreshold' propertyName: type oneOf: - - $ref: '#/components/schemas/GreaterThreshold' - - $ref: '#/components/schemas/LesserThreshold' - - $ref: '#/components/schemas/RangeThreshold' + - $ref: '#/components/schemas/GreaterThreshold' + - $ref: '#/components/schemas/LesserThreshold' + - $ref: '#/components/schemas/RangeThreshold' ThresholdBase: properties: allValues: @@ -12884,38 +13129,38 @@ components: $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 + - $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: @@ -12952,11 +13197,11 @@ components: default: active description: If inactive the user is inactive. enum: - - active - - inactive + - active + - inactive type: string required: - - name + - name UserResponse: properties: id: @@ -12979,11 +13224,11 @@ components: default: active description: If inactive the user is inactive. enum: - - active - - inactive + - active + - inactive type: string required: - - name + - name Users: properties: links: @@ -13036,9 +13281,9 @@ components: format: date-time type: string required: - - name - - orgID - - arguments + - name + - orgID + - arguments type: object VariableAssignment: description: Represents the declaration of a variable @@ -13052,43 +13297,43 @@ components: type: object VariableProperties: oneOf: - - $ref: '#/components/schemas/QueryVariableProperties' - - $ref: '#/components/schemas/ConstantVariableProperties' - - $ref: '#/components/schemas/MapVariableProperties' + - $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 + - 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: @@ -13111,24 +13356,24 @@ components: properties: $ref: '#/components/schemas/ViewProperties' required: - - name - - properties + - 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' + - $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: @@ -13143,18 +13388,18 @@ components: type: object WritePrecision: enum: - - ms - - s - - us - - ns + - ms + - s + - us + - ns type: string XYGeom: enum: - - line - - step - - stacked - - bar - - monotoneX + - line + - step + - stacked + - bar + - monotoneX type: string XYViewProperties: properties: @@ -13177,10 +13422,10 @@ components: $ref: '#/components/schemas/XYGeom' hoverDimension: enum: - - auto - - x - - "y" - - xy + - auto + - x + - 'y' + - xy type: string legendColorizeRows: type: boolean @@ -13195,8 +13440,8 @@ components: type: string position: enum: - - overlaid - - stacked + - overlaid + - stacked type: string queries: items: @@ -13206,7 +13451,7 @@ components: type: boolean shape: enum: - - chronograf-v2 + - chronograf-v2 type: string showNoteWhenEmpty: description: If true, will display note when empty @@ -13217,7 +13462,7 @@ components: type: string type: enum: - - xy + - xy type: string xColumn: type: string @@ -13240,15 +13485,15 @@ components: yTotalTicks: type: integer required: - - type - - geom - - queries - - shape - - axes - - colors - - note - - showNoteWhenEmpty - - position + - type + - geom + - queries + - shape + - axes + - colors + - note + - showNoteWhenEmpty + - position type: object responses: ServerError: @@ -13262,12 +13507,18 @@ components: type: http scheme: token bearerFormat: InfluxDB Token String - description: | + description: > ### Token authentication scheme - InfluxDB API tokens ensure secure interaction between users and data. A token belongs to an organization and identifies InfluxDB permissions within the organization. - Include your API token in an `Authentication: Token YOUR_API_TOKEN` HTTP header with each request. + InfluxDB API tokens ensure secure interaction between users and data. A + token belongs to an organization and identifies InfluxDB permissions + within the organization. + + + Include your API token in an `Authentication: Token YOUR_API_TOKEN` HTTP + header with each request. + ### Example @@ -13281,10 +13532,14 @@ components: BasicAuthentication: type: http scheme: basic - description: | + description: > ### Basic authentication scheme - Use HTTP Basic Auth with clients that support the InfluxDB 1.x convention of username and password (that don't support the `Authorization: Token` scheme). + + Use HTTP Basic Auth with clients that support the InfluxDB 1.x + convention of username and password (that don't support the + `Authorization: Token` scheme). + Username and password schemes require the following credentials: - **username**: 1.x username (this is separate from the UI login username) @@ -13292,18 +13547,24 @@ components: ### Example + `curl --get "http://localhost:8086/query" --user "YOUR_1.x_USERNAME":"YOUR_TOKEN_OR_PASSWORD"` - For more information and examples, see how to [authenticate with a username and password scheme](https://docs.influxdata.com/influxdb/v2.0/reference/api/influxdb-1x/) + For more information and examples, see how to [authenticate with a + username and password + scheme](https://docs.influxdata.com/influxdb/v2.0/reference/api/influxdb-1x/) QuerystringAuthentication: type: apiKey in: query name: u=&p= - description: | + description: > ### Querystring authentication scheme - Use InfluxDB 1.x API parameters to provide credentials through the query string. + + Use InfluxDB 1.x API parameters to provide credentials through the query + string. + Username and password schemes require the following credentials: - **username**: 1.x username (this is separate from the UI login username) @@ -13311,11 +13572,14 @@ components: ### Example + `curl --get "http://localhost:8086/query" --data-urlencode "u=YOUR_1.x_USERNAME" --data-urlencode "p=YOUR_TOKEN_OR_PASSWORD"` - For more information and examples, see how to [authenticate with a username and password scheme](https://docs.influxdata.com/influxdb/v2.0/reference/api/influxdb-1x/) + For more information and examples, see how to [authenticate with a + username and password + scheme](https://docs.influxdata.com/influxdb/v2.0/reference/api/influxdb-1x/) security: - TokenAuthentication: [] - BasicAuthentication: [] diff --git a/api-docs/yarn.lock b/api-docs/yarn.lock index 439c07f0e..e79302e28 100644 --- a/api-docs/yarn.lock +++ b/api-docs/yarn.lock @@ -2,4 +2,14 @@ # yarn lockfile v1 +argparse@^2.0.1: + version "2.0.1" + resolved "https://registry.yarnpkg.com/argparse/-/argparse-2.0.1.tgz#246f50f3ca78a3240f6c997e8a9bd1eac49e4b38" + integrity sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q== +js-yaml@^4.1.0: + version "4.1.0" + resolved "https://registry.yarnpkg.com/js-yaml/-/js-yaml-4.1.0.tgz#c1fb65f8f5017901cdd2c951864ba18458a10602" + integrity sha512-wpxZs9NoxZaJESJGIZTyDEaYpl0FKSA+FB9aJiyemKhMwkxQg63h4T1KJgUGHpTqPDNRcmmYLugrRjJlBtWvRA== + dependencies: + argparse "^2.0.1"