openapi: 3.0.0 info: title: Complete InfluxDB Cloud Authorizations (API tokens) Authorizations (API tokens) Templates API description: 'Create and manage authorizations (API tokens). An _authorization_ contains a list of `read` and `write` permissions for organization resources and provides an API token for authentication. An authorization belongs to an organization and only contains permissions for that organization. We recommend the following for managing your tokens: - Create a generic user to create and manage tokens for writing data. - Store your tokens in a secure password vault for future access. ### User sessions with authorizations Optionally, when creating an authorization, you can scope it to a specific user. If the user signs in with username and password, creating a _user session_, the session carries the permissions granted by all the user''s authorizations. For more information, see [how to assign a token to a specific user](https://docs.influxdata.com/influxdb/cloud/security/tokens/create-token/). To create a user session, use the [`POST /api/v2/signin` endpoint](#operation/PostSignin). ### Related endpoints - [Signin](#tag/Signin) - [Signout](#tag/Signout) ### Related guides - [Authorize API requests](https://docs.influxdata.com/influxdb/cloud/api-guide/api_intro/#authentication) - [Manage API tokens](https://docs.influxdata.com/influxdb/cloud/security/tokens/) - [Assign a token to a specific user](https://docs.influxdata.com/influxdb/cloud/security/tokens/create-token/) ' servers: - url: '' security: - TokenAuthentication: [] tags: - description: 'Export and apply InfluxDB **templates**. Manage **stacks** of templated InfluxDB resources. InfluxDB templates are prepackaged configurations for resources. Use InfluxDB templates to configure a fresh instance of InfluxDB, back up your dashboard configuration, or share your configuration. Use the `/api/v2/templates` endpoints to export templates and apply templates. **InfluxDB stacks** are stateful InfluxDB templates that let you add, update, and remove installed template resources over time, avoid duplicating resources when applying the same or similar templates more than once, and apply changes to distributed instances of InfluxDB OSS or InfluxDB Cloud. Use the `/api/v2/stacks` endpoints to manage installed template resources. ### Related guides - [InfluxDB stacks](https://docs.influxdata.com/influxdb/cloud/influxdb-templates/stacks/) - [InfluxDB templates](https://docs.influxdata.com/influxdb/cloud/influxdb-templates/) ' name: Templates paths: /api/v2/stacks: get: description: 'Lists installed InfluxDB stacks. To limit stacks in the response, pass query parameters in your request. If no query parameters are passed, InfluxDB returns all installed stacks for the organization. #### Related guides - [View InfluxDB stacks](https://docs.influxdata.com/influxdb/cloud/influxdb-templates/stacks/). ' operationId: ListStacks parameters: - description: "An organization ID.\nOnly returns stacks owned by the specified [organization](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#organization).\n\n#### InfluxDB Cloud\n\n- Doesn't require this parameter;\n InfluxDB only returns resources allowed by the API token.\n" in: query name: orgID required: true schema: type: string - description: 'A stack name. Finds stack `events` with this name and returns the stacks. Repeatable. To filter for more than one stack name, repeat this parameter with each name--for example: - `INFLUX_URL/api/v2/stacks?&orgID=INFLUX_ORG_ID&name=project-stack-0&name=project-stack-1` ' examples: findStackByName: summary: Find stacks with the event name value: project-stack-0 in: query name: name schema: type: string - description: 'A stack ID. Only returns the specified stack. Repeatable. To filter for more than one stack ID, repeat this parameter with each ID--for example: - `INFLUX_URL/api/v2/stacks?&orgID=INFLUX_ORG_ID&stackID=09bd87cd33be3000&stackID=09bef35081fe3000` ' examples: findStackByID: summary: Find a stack with the ID value: 09bd87cd33be3000 in: query name: stackID schema: type: string responses: '200': content: application/json: schema: properties: stacks: items: $ref: '#/components/schemas/Stack' type: array type: object description: Success. The response body contains the list of stacks. '400': content: application/json: examples: orgIdMissing: summary: The orgID query parameter is missing value: code: invalid message: 'organization id[""] is invalid: id must have a length of 16 bytes' orgProvidedNotFound: summary: The org or orgID passed doesn't own the token passed in the header value: code: invalid message: 'failed to decode request body: organization not found' schema: $ref: '#/components/schemas/Error' description: 'Bad request. The response body contains detail about the error. #### InfluxDB OSS - Returns this error if an incorrect value is passed in the `org` parameter or `orgID` parameter. ' '401': $ref: '#/components/responses/AuthorizationError' '500': $ref: '#/components/responses/InternalServerError' default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error summary: List installed stacks tags: - Templates post: description: "Creates or initializes a stack.\n\nUse this endpoint to _manually_ initialize a new stack with the following\noptional information:\n\n - Stack name\n - Stack description\n - URLs for template manifest files\n\nTo automatically create a stack when applying templates,\nuse the [/api/v2/templates/apply endpoint](#operation/ApplyTemplate).\n\n#### Required permissions\n\n- `write` permission for the organization\n\n#### Related guides\n\n- [Initialize an InfluxDB stack](https://docs.influxdata.com/influxdb/cloud/influxdb-templates/stacks/init/).\n- [Use InfluxDB templates](https://docs.influxdata.com/influxdb/cloud/influxdb-templates/use/#apply-templates-to-an-influxdb-instance).\n" operationId: CreateStack requestBody: content: application/json: schema: properties: description: type: string name: type: string orgID: type: string urls: items: type: string type: array title: PostStackRequest type: object description: The stack to create. required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/Stack' description: Success. Returns the newly created stack. '401': $ref: '#/components/responses/AuthorizationError' '422': content: application/json: schema: $ref: '#/components/schemas/Error' description: 'Unprocessable entity. The error may indicate one of the following problems: - The request body isn''t valid--the request is well-formed, but InfluxDB can''t process it due to semantic errors. - You passed a parameter combination that InfluxDB doesn''t support. ' '500': $ref: '#/components/responses/InternalServerError' default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error summary: Create a stack tags: - Templates /api/v2/stacks/{stack_id}: delete: operationId: DeleteStack parameters: - description: The identifier of the stack. in: path name: stack_id required: true schema: type: string - description: The identifier of the organization. in: query name: orgID required: true schema: type: string responses: '204': description: The stack and its associated resources were deleted. default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error summary: Delete a stack and associated resources tags: - Templates get: operationId: ReadStack parameters: - description: The identifier of the stack. in: path name: stack_id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/Stack' description: Returns the stack. default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error summary: Retrieve a stack tags: - Templates patch: operationId: UpdateStack parameters: - description: The identifier of the stack. in: path name: stack_id required: true schema: type: string requestBody: content: application/json: schema: properties: additionalResources: items: properties: kind: type: string resourceID: type: string templateMetaName: type: string required: - kind - resourceID type: object type: array description: nullable: true type: string name: nullable: true type: string templateURLs: items: type: string nullable: true type: array title: PatchStackRequest type: object description: The stack to update. required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/Stack' description: Returns the updated stack. default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error summary: Update a stack tags: - Templates /api/v2/stacks/{stack_id}/uninstall: post: operationId: UninstallStack parameters: - description: The identifier of the stack. in: path name: stack_id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/Stack' description: Returns the uninstalled stack. default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error summary: Uninstall a stack tags: - Templates /api/v2/templates/apply: post: description: "Applies a template to\ncreate or update a [stack](https://docs.influxdata.com/influxdb/cloud/influxdb-templates/stacks/) of InfluxDB\n[resources](https://docs.influxdata.com/influxdb/cloud/reference/cli/influx/export/all/#resources).\nThe response contains the diff of changes and the stack ID.\n\nUse this endpoint to install an InfluxDB template to an organization.\nProvide template URLs or template objects in your request.\nTo customize which template resources are installed, use the `actions`\nparameter.\n\nBy default, when you apply a template, InfluxDB installs the template to\ncreate and update stack resources and then generates a diff of the changes.\nIf you pass `dryRun: true` in the request body, InfluxDB validates the\ntemplate and generates the resource diff, but doesn’t make any\nchanges to your instance.\n\n#### Custom values for templates\n\n- Some templates may contain [environment references](https://docs.influxdata.com/influxdb/cloud/influxdb-templates/create/#include-user-definable-resource-names) for custom metadata.\n To provide custom values for environment references, pass the _`envRefs`_\n property in the request body.\n For more information and examples, see how to\n [define environment references](https://docs.influxdata.com/influxdb/cloud/influxdb-templates/use/#define-environment-references).\n\n- Some templates may contain queries that use\n [secrets](https://docs.influxdata.com/influxdb/cloud/security/secrets/).\n To provide custom secret values, pass the _`secrets`_ property\n in the request body.\n Don't expose secret values in templates.\n For more information, see [how to pass secrets when installing a template](https://docs.influxdata.com/influxdb/cloud/influxdb-templates/use/#pass-secrets-when-installing-a-template).\n\n#### Required permissions\n\n- `write` permissions for resource types in the template.\n\n#### Rate limits (with InfluxDB Cloud)\n\n- Adjustable service quotas apply.\n For more information, see [limits and adjustable quotas](https://docs.influxdata.com/influxdb/cloud/account-management/limits/).\n\n#### Related guides\n\n- [Use templates](https://docs.influxdata.com/influxdb/cloud/influxdb-templates/use/)\n- [Stacks](https://docs.influxdata.com/influxdb/cloud/influxdb-templates/stacks/)\n" operationId: ApplyTemplate requestBody: content: application/json: examples: skipKindAction: summary: Skip all bucket and task resources in the provided templates value: actions: - action: skipKind properties: kind: Bucket - action: skipKind properties: kind: Task orgID: INFLUX_ORG_ID templates: - contents: - '[object Object]': null skipResourceAction: summary: Skip specific resources in the provided templates value: actions: - action: skipResource properties: kind: Label resourceTemplateName: foo-001 - action: skipResource properties: kind: Bucket resourceTemplateName: bar-020 - action: skipResource properties: kind: Bucket resourceTemplateName: baz-500 orgID: INFLUX_ORG_ID templates: - contents: - apiVersion: influxdata.com/v2alpha1 kind: Bucket metadata: name: baz-500 templateObjectEnvRefs: summary: envRefs for template objects value: envRefs: docker-bucket: MY_DOCKER_BUCKET docker-spec-1: MY_DOCKER_SPEC linux-cpu-label: MY_CPU_LABEL orgID: INFLUX_ORG_ID templates: - contents: - apiVersion: influxdata.com/v2alpha1 kind: Label metadata: name: envRef: key: linux-cpu-label spec: color: '#326BBA' name: inputs.cpu - contents: - apiVersion: influxdata.com/v2alpha1 kind: Bucket metadata: name: envRef: key: docker-bucket schema: $ref: '#/components/schemas/TemplateApply' application/x-jsonnet: schema: $ref: '#/components/schemas/TemplateApply' text/yml: schema: $ref: '#/components/schemas/TemplateApply' description: 'Parameters for applying templates. ' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/TemplateSummary' description: 'Success. The template dry run succeeded. The response body contains a resource diff of changes that the template would have made if installed. No resources were created or updated. The diff and summary won''t contain IDs for resources that didn''t exist at the time of the dry run. ' '201': content: application/json: schema: $ref: '#/components/schemas/TemplateSummary' description: 'Success. The template applied successfully. The response body contains the stack ID, a diff, and a summary. The diff compares the initial state to the state after the template installation. The summary contains newly created resources. ' '422': content: application/json: schema: allOf: - $ref: '#/components/schemas/TemplateSummary' - properties: code: type: string message: type: string required: - message - code type: object description: 'Unprocessable entity. The error may indicate one of the following problems: - The template failed validation. - You passed a parameter combination that InfluxDB doesn''t support. ' '500': content: application/json: examples: createExceedsQuota: summary: 'InfluxDB Cloud: Creating resource would exceed quota.' value: code: internal error message: "resource_type=\"tasks\" err=\"failed to apply resource\"\n\tmetadata_name=\"alerting-gates-b84003\" err_msg=\"failed to create tasks[\\\"alerting-gates-b84003\\\"]: creating task would exceed quota\"" schema: $ref: '#/components/schemas/Error' description: "Internal server error.\n\n#### InfluxDB Cloud\n\n- Returns this error if creating one of the template\n resources (bucket, dashboard, task, user) exceeds your plan’s\n adjustable service quotas.\n" default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error summary: Apply or dry-run a template tags: - Templates x-codeSamples: - label: 'cURL: Dry run with a remote template' lang: Shell source: "curl --request POST \"http://localhost:8086/api/v2/templates/apply\" \\\n --header \"Authorization: Token INFLUX_API_TOKEN\" \\\n --data @- << EOF\n {\n \"dryRun\": true,\n \"orgID\": \"INFLUX_ORG_ID\",\n \"remotes\": [\n {\n \"url\": \"https://raw.githubusercontent.com/influxdata/community-templates/master/linux_system/linux_system.yml\"\n }\n ]\n }\nEOF\n" - label: 'cURL: Apply with secret values' lang: Shell source: "curl \"http://localhost:8086/api/v2/templates/apply\" \\\n --header \"Authorization: Token INFLUX_API_TOKEN\" \\\n --data @- << EOF | jq .\n {\n \"orgID\": \"INFLUX_ORG_ID\",\n \"secrets\": {\n \"SLACK_WEBHOOK\": \"YOUR_SECRET_WEBHOOK_URL\"\n },\n \"remotes\": [\n {\n \"url\": \"https://raw.githubusercontent.com/influxdata/community-templates/master/fortnite/fn-template.yml\"\n }\n ]\n }\nEOF\n" - label: 'cURL: Apply template objects with environment references' lang: Shell source: "curl --request POST \"http://localhost:8086/api/v2/templates/apply\" \\\n --header \"Authorization: Token INFLUX_API_TOKEN\" \\\n --data @- << EOF\n { \"orgID\": \"INFLUX_ORG_ID\",\n \"envRefs\": {\n \"linux-cpu-label\": \"MY_CPU_LABEL\",\n \"docker-bucket\": \"MY_DOCKER_BUCKET\",\n \"docker-spec-1\": \"MY_DOCKER_SPEC\"\n },\n \"templates\": [\n { \"contents\": [{\n \"apiVersion\": \"influxdata.com/v2alpha1\",\n \"kind\": \"Label\",\n \"metadata\": {\n \"name\": {\n \"envRef\": {\n \"key\": \"linux-cpu-label\"\n }\n }\n },\n \"spec\": {\n \"color\": \"#326BBA\",\n \"name\": \"inputs.cpu\"\n }\n }]\n },\n \"templates\": [\n { \"contents\": [{\n \"apiVersion\": \"influxdata.com/v2alpha1\",\n \"kind\": \"Label\",\n \"metadata\": {\n \"name\": {\n \"envRef\": {\n \"key\": \"linux-cpu-label\"\n }\n }\n },\n \"spec\": {\n \"color\": \"#326BBA\",\n \"name\": \"inputs.cpu\"\n }\n }]\n },\n { \"contents\": [{\n \"apiVersion\": \"influxdata.com/v2alpha1\",\n \"kind\": \"Bucket\",\n \"metadata\": {\n \"name\": {\n \"envRef\": {\n \"key\": \"docker-bucket\"\n }\n }\n }\n }]\n }\n ]\n }\nEOF\n" /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 components: schemas: AxisScale: description: 'Scale is the axis formatting scale. Supported: "log", "linear"' enum: - log - linear type: string NotificationEndpointType: enum: - slack - pagerduty - http - telegram type: string SimpleTableViewProperties: properties: note: type: string queries: items: $ref: '#/components/schemas/DashboardQuery' type: array shape: enum: - chronograf-v2 type: string showAll: type: boolean showNoteWhenEmpty: description: If true, will display note when empty type: boolean type: enum: - simple-table type: string required: - type - showAll - queries - shape - note - showNoteWhenEmpty type: object TemplateEnvReferences: items: properties: defaultValue: description: Default value that will be provided for the reference when no value is provided nullable: true oneOf: - type: string - type: integer - type: number - type: boolean envRefKey: description: Key identified as environment reference and is the key identified in the template type: string resourceField: description: Field the environment reference corresponds too type: string value: description: Value provided to fulfill reference nullable: true oneOf: - type: string - type: integer - type: number - type: boolean required: - resourceField - envRefKey type: object type: array HeatmapViewProperties: properties: adaptiveZoomHide: type: boolean binSize: type: number colors: description: Colors define color encoding of data into a visualization items: type: string type: array generateXAxisTicks: items: type: string type: array generateYAxisTicks: items: type: string type: array legendColorizeRows: type: boolean legendHide: type: boolean legendOpacity: format: float type: number legendOrientationThreshold: type: integer note: type: string queries: items: $ref: '#/components/schemas/DashboardQuery' type: array shape: enum: - chronograf-v2 type: string showNoteWhenEmpty: description: If true, will display note when empty type: boolean timeFormat: type: string type: enum: - heatmap type: string xAxisLabel: type: string xColumn: type: string xDomain: items: type: number maxItems: 2 type: array xPrefix: type: string xSuffix: type: string xTickStart: format: float type: number xTickStep: format: float type: number xTotalTicks: type: integer yAxisLabel: type: string yColumn: type: string yDomain: items: type: number maxItems: 2 type: array yPrefix: type: string ySuffix: type: string yTickStart: format: float type: number yTickStep: format: float type: number yTotalTicks: type: integer required: - type - queries - colors - shape - note - showNoteWhenEmpty - xColumn - yColumn - xDomain - yDomain - xAxisLabel - yAxisLabel - xPrefix - yPrefix - xSuffix - ySuffix - binSize type: object Stack: properties: createdAt: format: date-time readOnly: true type: string events: items: properties: description: type: string eventType: type: string name: type: string resources: items: properties: apiVersion: type: string associations: items: properties: kind: $ref: '#/components/schemas/TemplateKind' metaName: type: string type: object type: array kind: $ref: '#/components/schemas/TemplateKind' links: properties: self: type: string type: object resourceID: type: string templateMetaName: type: string type: object type: array sources: items: type: string type: array updatedAt: format: date-time readOnly: true type: string urls: items: type: string type: array type: object type: array id: type: string orgID: type: string type: object RetentionRule: properties: everySeconds: default: 2592000 description: 'The duration in seconds for how long data will be kept in the database. The default duration is 2592000 (30 days). 0 represents infinite retention. ' example: 86400 format: int64 minimum: 0 type: integer shardGroupDurationSeconds: description: 'The shard group duration. The duration or interval (in seconds) that each shard group covers. #### InfluxDB Cloud - Does not use `shardGroupDurationsSeconds`. #### InfluxDB OSS - Default value depends on the [bucket retention period](https://docs.influxdata.com/influxdb/cloud/reference/internals/shards/#shard-group-duration). ' format: int64 type: integer type: default: expire enum: - expire type: string required: - everySeconds type: object DecimalPlaces: description: Indicates whether decimal places should be enforced, and how many digits it should show. properties: digits: description: The number of digits after decimal to display format: int32 type: integer isEnforced: description: Indicates whether decimal point setting should be enforced type: boolean type: object RenamableField: description: Describes a field that can be renamed and made visible or invisible. properties: displayName: description: The name that a field is renamed to by the user. type: string internalName: description: The calculated name of a field. readOnly: true type: string visible: description: Indicates whether this field should be visible on the table. type: boolean type: object LinePlusSingleStatProperties: properties: adaptiveZoomHide: type: boolean axes: $ref: '#/components/schemas/Axes' colors: description: Colors define color encoding of data into a visualization items: $ref: '#/components/schemas/DashboardColor' type: array decimalPlaces: $ref: '#/components/schemas/DecimalPlaces' generateXAxisTicks: items: type: string type: array generateYAxisTicks: items: type: string type: array hoverDimension: enum: - auto - x - y - xy type: string legendColorizeRows: type: boolean legendHide: type: boolean legendOpacity: format: float type: number legendOrientationThreshold: type: integer note: type: string position: enum: - overlaid - stacked type: string prefix: type: string queries: items: $ref: '#/components/schemas/DashboardQuery' type: array shadeBelow: type: boolean shape: enum: - chronograf-v2 type: string showNoteWhenEmpty: description: If true, will display note when empty type: boolean staticLegend: $ref: '#/components/schemas/StaticLegend' suffix: type: string timeFormat: type: string type: enum: - line-plus-single-stat type: string xColumn: type: string xTickStart: format: float type: number xTickStep: format: float type: number xTotalTicks: type: integer yColumn: type: string yTickStart: format: float type: number yTickStep: format: float type: number yTotalTicks: type: integer required: - type - queries - shape - axes - colors - note - showNoteWhenEmpty - prefix - suffix - decimalPlaces - position type: object Labels: items: $ref: '#/components/schemas/Label' type: array LesserThreshold: allOf: - $ref: '#/components/schemas/ThresholdBase' - properties: type: enum: - lesser type: string value: format: float type: number required: - type - value type: object TableViewProperties: properties: colors: description: Colors define color encoding of data into a visualization items: $ref: '#/components/schemas/DashboardColor' type: array decimalPlaces: $ref: '#/components/schemas/DecimalPlaces' fieldOptions: description: fieldOptions represent the fields retrieved by the query with customization options items: $ref: '#/components/schemas/RenamableField' type: array note: type: string queries: items: $ref: '#/components/schemas/DashboardQuery' type: array shape: enum: - chronograf-v2 type: string showNoteWhenEmpty: description: If true, will display note when empty type: boolean tableOptions: properties: fixFirstColumn: description: fixFirstColumn indicates whether the first column of the table should be locked type: boolean sortBy: $ref: '#/components/schemas/RenamableField' verticalTimeAxis: description: verticalTimeAxis describes the orientation of the table by indicating whether the time axis will be displayed vertically type: boolean wrapping: description: Wrapping describes the text wrapping style to be used in table views enum: - truncate - wrap - single-line type: string type: object timeFormat: description: timeFormat describes the display format for time values according to moment.js date formatting type: string type: enum: - table type: string required: - type - queries - colors - shape - note - showNoteWhenEmpty - tableOptions - fieldOptions - timeFormat - decimalPlaces type: object Axis: description: Axis used in a visualization. properties: base: description: Radix for formatting axis values. enum: - '' - '2' - '10' type: string bounds: description: The extents of the axis in the form [lower, upper]. Clients determine whether bounds are inclusive or exclusive of their limits. items: type: string maxItems: 2 minItems: 0 type: array label: description: Description of the axis. type: string prefix: description: Label prefix for formatting axis values. type: string scale: $ref: '#/components/schemas/AxisScale' suffix: description: Label suffix for formatting axis values. type: string type: object CustomCheck: allOf: - $ref: '#/components/schemas/CheckBase' - properties: type: enum: - custom type: string required: - type type: object BandViewProperties: properties: adaptiveZoomHide: type: boolean axes: $ref: '#/components/schemas/Axes' colors: description: Colors define color encoding of data into a visualization items: $ref: '#/components/schemas/DashboardColor' type: array generateXAxisTicks: items: type: string type: array generateYAxisTicks: items: type: string type: array geom: $ref: '#/components/schemas/XYGeom' hoverDimension: enum: - auto - x - y - xy type: string legendColorizeRows: type: boolean legendHide: type: boolean legendOpacity: format: float type: number legendOrientationThreshold: type: integer lowerColumn: type: string mainColumn: type: string note: type: string queries: items: $ref: '#/components/schemas/DashboardQuery' type: array shape: enum: - chronograf-v2 type: string showNoteWhenEmpty: description: If true, will display note when empty type: boolean staticLegend: $ref: '#/components/schemas/StaticLegend' timeFormat: type: string type: enum: - band type: string upperColumn: type: string xColumn: type: string xTickStart: format: float type: number xTickStep: format: float type: number xTotalTicks: type: integer yColumn: type: string yTickStart: format: float type: number yTickStep: format: float type: number yTotalTicks: type: integer required: - type - geom - queries - shape - axes - colors - note - showNoteWhenEmpty type: object TemplateExportByName: properties: orgIDs: items: properties: orgID: type: string resourceFilters: properties: byLabel: items: type: string type: array byResourceKind: items: $ref: '#/components/schemas/TemplateKind' type: array type: object type: object type: array resources: items: properties: kind: $ref: '#/components/schemas/TemplateKind' name: type: string required: - name - kind type: object type: array stackID: type: string type: object Threshold: discriminator: mapping: greater: '#/components/schemas/GreaterThreshold' lesser: '#/components/schemas/LesserThreshold' range: '#/components/schemas/RangeThreshold' propertyName: type oneOf: - $ref: '#/components/schemas/GreaterThreshold' - $ref: '#/components/schemas/LesserThreshold' - $ref: '#/components/schemas/RangeThreshold' 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 ThresholdBase: properties: allValues: description: If true, only alert if all values meet threshold. type: boolean level: $ref: '#/components/schemas/CheckStatusLevel' MosaicViewProperties: properties: colors: description: Colors define color encoding of data into a visualization items: type: string type: array fillColumns: items: type: string type: array generateXAxisTicks: items: type: string type: array hoverDimension: enum: - auto - x - y - xy type: string legendColorizeRows: type: boolean legendHide: type: boolean legendOpacity: format: float type: number legendOrientationThreshold: type: integer note: type: string queries: items: $ref: '#/components/schemas/DashboardQuery' type: array shape: enum: - chronograf-v2 type: string showNoteWhenEmpty: description: If true, will display note when empty type: boolean timeFormat: type: string type: enum: - mosaic type: string xAxisLabel: type: string xColumn: type: string xDomain: items: type: number maxItems: 2 type: array xPrefix: type: string xSuffix: type: string xTickStart: format: float type: number xTickStep: format: float type: number xTotalTicks: type: integer yAxisLabel: type: string yDomain: items: type: number maxItems: 2 type: array yLabelColumnSeparator: type: string yLabelColumns: items: type: string type: array yPrefix: type: string ySeriesColumns: items: type: string type: array ySuffix: type: string required: - type - queries - colors - shape - note - showNoteWhenEmpty - xColumn - ySeriesColumns - fillColumns - xDomain - yDomain - xAxisLabel - yAxisLabel - xPrefix - yPrefix - xSuffix - ySuffix type: object CheckBase: properties: createdAt: format: date-time readOnly: true type: string description: description: An optional description of the check. type: string id: readOnly: true type: string labels: $ref: '#/components/schemas/Labels' lastRunError: readOnly: true type: string lastRunStatus: enum: - failed - success - canceled readOnly: true type: string latestCompleted: description: A timestamp ([RFC3339 date/time format](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#rfc3339-timestamp)) of the latest scheduled and completed run. format: date-time readOnly: true type: string links: example: labels: /api/v2/checks/1/labels members: /api/v2/checks/1/members owners: /api/v2/checks/1/owners query: /api/v2/checks/1/query self: /api/v2/checks/1 properties: labels: $ref: '#/components/schemas/Link' description: The URL to retrieve labels for this check. members: $ref: '#/components/schemas/Link' description: The URL to retrieve members for this check. owners: $ref: '#/components/schemas/Link' description: The URL to retrieve owners for this check. query: $ref: '#/components/schemas/Link' description: The URL to retrieve the Flux script for this check. self: $ref: '#/components/schemas/Link' description: The URL for this check. readOnly: true type: object name: type: string orgID: description: The ID of the organization that owns this check. type: string ownerID: description: The ID of creator used to create this check. readOnly: true type: string query: $ref: '#/components/schemas/DashboardQuery' status: $ref: '#/components/schemas/TaskStatusType' taskID: description: The ID of the task associated with this check. type: string updatedAt: format: date-time readOnly: true type: string required: - name - orgID - query GaugeViewProperties: properties: colors: description: Colors define color encoding of data into a visualization items: $ref: '#/components/schemas/DashboardColor' type: array decimalPlaces: $ref: '#/components/schemas/DecimalPlaces' note: type: string prefix: type: string queries: items: $ref: '#/components/schemas/DashboardQuery' type: array shape: enum: - chronograf-v2 type: string showNoteWhenEmpty: description: If true, will display note when empty type: boolean suffix: type: string tickPrefix: type: string tickSuffix: type: string type: enum: - gauge type: string required: - type - queries - colors - shape - note - showNoteWhenEmpty - prefix - tickPrefix - suffix - tickSuffix - decimalPlaces type: object XYGeom: enum: - line - step - stacked - bar - monotoneX - stepBefore - stepAfter type: string SlackNotificationEndpoint: allOf: - $ref: '#/components/schemas/NotificationEndpointBase' - properties: token: description: Specifies the API token string. Specify either `URL` or `Token`. type: string url: description: Specifies the URL of the Slack endpoint. Specify either `URL` or `Token`. type: string type: object type: object ScatterViewProperties: properties: adaptiveZoomHide: type: boolean colors: description: Colors define color encoding of data into a visualization items: type: string type: array fillColumns: items: type: string type: array generateXAxisTicks: items: type: string type: array generateYAxisTicks: items: type: string type: array legendColorizeRows: type: boolean legendHide: type: boolean legendOpacity: format: float type: number legendOrientationThreshold: type: integer note: type: string queries: items: $ref: '#/components/schemas/DashboardQuery' type: array shape: enum: - chronograf-v2 type: string showNoteWhenEmpty: description: If true, will display note when empty type: boolean symbolColumns: items: type: string type: array timeFormat: type: string type: enum: - scatter type: string xAxisLabel: type: string xColumn: type: string xDomain: items: type: number maxItems: 2 type: array xPrefix: type: string xSuffix: type: string xTickStart: format: float type: number xTickStep: format: float type: number xTotalTicks: type: integer yAxisLabel: type: string yColumn: type: string yDomain: items: type: number maxItems: 2 type: array yPrefix: type: string ySuffix: type: string yTickStart: format: float type: number yTickStep: format: float type: number yTotalTicks: type: integer required: - type - queries - colors - shape - note - showNoteWhenEmpty - xColumn - yColumn - fillColumns - symbolColumns - xDomain - yDomain - xAxisLabel - yAxisLabel - xPrefix - yPrefix - xSuffix - ySuffix type: object 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 CheckDiscriminator: discriminator: mapping: custom: '#/components/schemas/CustomCheck' deadman: '#/components/schemas/DeadmanCheck' threshold: '#/components/schemas/ThresholdCheck' propertyName: type oneOf: - $ref: '#/components/schemas/DeadmanCheck' - $ref: '#/components/schemas/ThresholdCheck' - $ref: '#/components/schemas/CustomCheck' NotificationEndpointBase: properties: createdAt: format: date-time readOnly: true type: string description: description: An optional description of the notification endpoint. type: string id: type: string labels: $ref: '#/components/schemas/Labels' links: example: labels: /api/v2/notificationEndpoints/1/labels members: /api/v2/notificationEndpoints/1/members owners: /api/v2/notificationEndpoints/1/owners self: /api/v2/notificationEndpoints/1 properties: labels: $ref: '#/components/schemas/Link' description: The URL to retrieve labels for this endpoint. members: $ref: '#/components/schemas/Link' description: The URL to retrieve members for this endpoint. owners: $ref: '#/components/schemas/Link' description: The URL to retrieve owners for this endpoint. self: $ref: '#/components/schemas/Link' description: The URL for this endpoint. readOnly: true type: object name: type: string orgID: type: string status: default: active description: The status of the endpoint. enum: - active - inactive type: string type: $ref: '#/components/schemas/NotificationEndpointType' updatedAt: format: date-time readOnly: true type: string userID: type: string required: - type - name type: object HTTPNotificationEndpoint: allOf: - $ref: '#/components/schemas/NotificationEndpointBase' - properties: authMethod: enum: - none - basic - bearer type: string contentTemplate: type: string headers: additionalProperties: type: string description: Customized headers. type: object method: enum: - POST - GET - PUT type: string password: type: string token: type: string url: type: string username: type: string required: - url - authMethod - method type: object type: object BuilderFunctionsType: properties: name: type: string type: object GreaterThreshold: allOf: - $ref: '#/components/schemas/ThresholdBase' - properties: type: enum: - greater type: string value: format: float type: number required: - type - value type: object Error: properties: code: $ref: '#/components/schemas/ErrorCode' description: code is the machine-readable error code. enum: - internal error - not implemented - not found - conflict - invalid - unprocessable entity - empty value - unavailable - forbidden - too many requests - unauthorized - method not allowed - request too large - unsupported media type readOnly: true type: string err: description: Stack of errors that occurred during processing of the request. Useful for debugging. readOnly: true type: string message: description: Human-readable message. readOnly: true type: string op: description: Describes the logical code operation when the error occurred. Useful for debugging. readOnly: true type: string required: - code MarkdownViewProperties: properties: note: type: string shape: enum: - chronograf-v2 type: string type: enum: - markdown type: string required: - type - shape - note type: object GeoPointMapViewLayer: allOf: - $ref: '#/components/schemas/GeoViewLayerProperties' - properties: colorDimension: $ref: '#/components/schemas/Axis' colorField: description: Marker color field type: string colors: description: Colors define color encoding of data into a visualization items: $ref: '#/components/schemas/DashboardColor' type: array isClustered: description: Cluster close markers together type: boolean tooltipColumns: description: An array for which columns to display in tooltip items: type: string type: array required: - colorField - colorDimension - colors type: object 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 TelegrafRequest: properties: config: type: string description: type: string metadata: properties: buckets: items: type: string type: array type: object name: type: string orgID: type: string type: object ConstantVariableProperties: properties: type: enum: - constant type: string values: items: type: string type: array PagerDutyNotificationEndpoint: allOf: - $ref: '#/components/schemas/NotificationEndpointBase' - properties: clientURL: type: string routingKey: type: string required: - routingKey type: object type: object SingleStatViewProperties: properties: colors: description: Colors define color encoding of data into a visualization items: $ref: '#/components/schemas/DashboardColor' type: array decimalPlaces: $ref: '#/components/schemas/DecimalPlaces' note: type: string prefix: type: string queries: items: $ref: '#/components/schemas/DashboardQuery' type: array shape: enum: - chronograf-v2 type: string showNoteWhenEmpty: description: If true, will display note when empty type: boolean staticLegend: $ref: '#/components/schemas/StaticLegend' suffix: type: string tickPrefix: type: string tickSuffix: type: string type: enum: - single-stat type: string required: - type - queries - colors - shape - note - showNoteWhenEmpty - prefix - tickPrefix - suffix - tickSuffix - decimalPlaces type: object Check: allOf: - $ref: '#/components/schemas/CheckDiscriminator' BuilderAggregateFunctionType: enum: - filter - group type: string QueryVariableProperties: properties: type: enum: - query type: string values: properties: language: type: string query: type: string type: object ErrorCode: description: code is the machine-readable error code. enum: - internal error - not implemented - not found - conflict - invalid - unprocessable entity - empty value - unavailable - forbidden - too many requests - unauthorized - method not allowed - request too large - unsupported media type readOnly: true type: string DashboardColor: description: Defines an encoding of data value into color space. properties: hex: description: The hex number of the color maxLength: 7 minLength: 7 type: string id: description: The unique ID of the view color. type: string name: description: The user-facing name of the hex color. type: string type: description: Type is how the color is used. enum: - min - max - threshold - scale - text - background type: string value: description: The data value mapped to this color. format: float type: number required: - id - type - hex - name - value type: object HistogramViewProperties: properties: binCount: type: integer colors: description: Colors define color encoding of data into a visualization items: $ref: '#/components/schemas/DashboardColor' type: array fillColumns: items: type: string type: array legendColorizeRows: type: boolean legendHide: type: boolean legendOpacity: format: float type: number legendOrientationThreshold: type: integer note: type: string position: enum: - overlaid - stacked type: string queries: items: $ref: '#/components/schemas/DashboardQuery' type: array shape: enum: - chronograf-v2 type: string showNoteWhenEmpty: description: If true, will display note when empty type: boolean type: enum: - histogram type: string xAxisLabel: type: string xColumn: type: string xDomain: items: format: float type: number type: array required: - type - queries - colors - shape - note - showNoteWhenEmpty - xColumn - fillColumns - xDomain - xAxisLabel - position - binCount type: object TemplateExportByID: properties: orgIDs: items: properties: orgID: type: string resourceFilters: properties: byLabel: items: type: string type: array byResourceKind: items: $ref: '#/components/schemas/TemplateKind' type: array type: object type: object type: array resources: items: properties: id: type: string kind: $ref: '#/components/schemas/TemplateKind' name: description: if defined with id, name is used for resource exported by id. if defined independently, resources strictly matching name are exported type: string required: - id - kind type: object type: array stackID: type: string type: object Label: properties: id: readOnly: true type: string name: type: string orgID: readOnly: true type: string properties: additionalProperties: type: string description: 'Key-value pairs associated with this label. To remove a property, send an update with an empty value (`""`) for the key. ' example: color: ffb3b3 description: this is a description type: object type: object DashboardQuery: properties: builderConfig: $ref: '#/components/schemas/BuilderConfig' editMode: $ref: '#/components/schemas/QueryEditMode' name: type: string text: description: The text of the Flux query. type: string type: object GeoViewLayer: oneOf: - $ref: '#/components/schemas/GeoCircleViewLayer' - $ref: '#/components/schemas/GeoHeatMapViewLayer' - $ref: '#/components/schemas/GeoPointMapViewLayer' - $ref: '#/components/schemas/GeoTrackMapViewLayer' type: object TemplateSummaryLabel: properties: envReferences: $ref: '#/components/schemas/TemplateEnvReferences' id: type: string kind: $ref: '#/components/schemas/TemplateKind' name: type: string orgID: type: string properties: properties: color: type: string description: type: string type: object templateMetaName: type: string type: object VariableProperties: oneOf: - $ref: '#/components/schemas/QueryVariableProperties' - $ref: '#/components/schemas/ConstantVariableProperties' - $ref: '#/components/schemas/MapVariableProperties' type: object Axes: description: The viewport for a View's visualizations properties: x: $ref: '#/components/schemas/Axis' y: $ref: '#/components/schemas/Axis' required: - x - y type: object XYViewProperties: properties: adaptiveZoomHide: type: boolean axes: $ref: '#/components/schemas/Axes' colorMapping: $ref: '#/components/schemas/ColorMapping' description: An object that contains information about the color mapping colors: description: Colors define color encoding of data into a visualization items: $ref: '#/components/schemas/DashboardColor' type: array generateXAxisTicks: items: type: string type: array generateYAxisTicks: items: type: string type: array geom: $ref: '#/components/schemas/XYGeom' hoverDimension: enum: - auto - x - y - xy type: string legendColorizeRows: type: boolean legendHide: type: boolean legendOpacity: format: float type: number legendOrientationThreshold: type: integer note: type: string position: enum: - overlaid - stacked type: string queries: items: $ref: '#/components/schemas/DashboardQuery' type: array shadeBelow: type: boolean shape: enum: - chronograf-v2 type: string showNoteWhenEmpty: description: If true, will display note when empty type: boolean staticLegend: $ref: '#/components/schemas/StaticLegend' timeFormat: type: string type: enum: - xy type: string xColumn: type: string xTickStart: format: float type: number xTickStep: format: float type: number xTotalTicks: type: integer yColumn: type: string yTickStart: format: float type: number yTickStep: format: float type: number yTotalTicks: type: integer required: - type - geom - queries - shape - axes - colors - note - showNoteWhenEmpty - position type: object TelegramNotificationEndpoint: allOf: - $ref: '#/components/schemas/NotificationEndpointBase' - properties: channel: description: The ID of the telegram channel; a chat_id in https://core.telegram.org/bots/api#sendmessage . type: string token: description: Specifies the Telegram bot token. See https://core.telegram.org/bots#creating-a-new-bot . type: string required: - token - channel type: object type: object CheckViewProperties: properties: adaptiveZoomHide: type: boolean check: $ref: '#/components/schemas/Check' checkID: type: string colors: description: Colors define color encoding of data into a visualization items: $ref: '#/components/schemas/DashboardColor' type: array legendColorizeRows: type: boolean legendHide: type: boolean legendOpacity: format: float type: number legendOrientationThreshold: type: integer queries: items: $ref: '#/components/schemas/DashboardQuery' type: array shape: enum: - chronograf-v2 type: string type: enum: - check type: string required: - type - shape - checkID - queries - colors type: object LatLonColumns: description: Object type to define lat/lon columns properties: lat: $ref: '#/components/schemas/LatLonColumn' lon: $ref: '#/components/schemas/LatLonColumn' required: - lat - lon type: object TaskStatusType: description: '`inactive` cancels scheduled runs and prevents manual runs of the task. ' enum: - active - inactive type: string 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' LatLonColumn: description: Object type for key and column definitions properties: column: description: Column to look up Lat/Lon type: string key: description: Key to determine whether the column is tag/field type: string required: - key - column type: object GeoTrackMapViewLayer: allOf: - $ref: '#/components/schemas/GeoViewLayerProperties' - required: - trackWidth - speed - randomColors - trackPointVisualization type: object properties: colors: description: Colors define color encoding of data into a visualization items: $ref: '#/components/schemas/DashboardColor' type: array randomColors: description: Assign different colors to different tracks type: boolean speed: description: Speed of the track animation type: integer trackWidth: description: Width of the track type: integer TemplateSummary: properties: diff: properties: buckets: items: properties: id: type: string kind: $ref: '#/components/schemas/TemplateKind' new: properties: description: type: string name: type: string retentionRules: $ref: '#/components/schemas/RetentionRules' type: object old: properties: description: type: string name: type: string retentionRules: $ref: '#/components/schemas/RetentionRules' type: object stateStatus: type: string templateMetaName: type: string type: object type: array checks: items: properties: id: type: string kind: $ref: '#/components/schemas/TemplateKind' new: $ref: '#/components/schemas/CheckDiscriminator' old: $ref: '#/components/schemas/CheckDiscriminator' stateStatus: type: string templateMetaName: type: string type: object type: array dashboards: items: properties: id: type: string kind: $ref: '#/components/schemas/TemplateKind' new: properties: charts: items: $ref: '#/components/schemas/TemplateChart' type: array description: type: string name: type: string type: object old: properties: charts: items: $ref: '#/components/schemas/TemplateChart' type: array description: type: string name: type: string type: object stateStatus: type: string templateMetaName: type: string type: object type: array labelMappings: items: properties: labelID: type: string labelName: type: string labelTemplateMetaName: type: string resourceID: type: string resourceName: type: string resourceTemplateMetaName: type: string resourceType: type: string status: type: string type: object type: array labels: items: properties: id: type: string kind: $ref: '#/components/schemas/TemplateKind' new: properties: color: type: string description: type: string name: type: string type: object old: properties: color: type: string description: type: string name: type: string type: object stateStatus: type: string templateMetaName: type: string type: object type: array notificationEndpoints: items: properties: id: type: string kind: $ref: '#/components/schemas/TemplateKind' new: $ref: '#/components/schemas/NotificationEndpointDiscriminator' old: $ref: '#/components/schemas/NotificationEndpointDiscriminator' stateStatus: type: string templateMetaName: type: string type: object type: array notificationRules: items: properties: id: type: string kind: $ref: '#/components/schemas/TemplateKind' new: properties: description: type: string endpointID: type: string endpointName: type: string endpointType: type: string every: type: string messageTemplate: type: string name: type: string offset: type: string status: type: string statusRules: items: properties: currentLevel: type: string previousLevel: type: string type: object type: array tagRules: items: properties: key: type: string operator: type: string value: type: string type: object type: array type: object old: properties: description: type: string endpointID: type: string endpointName: type: string endpointType: type: string every: type: string messageTemplate: type: string name: type: string offset: type: string status: type: string statusRules: items: properties: currentLevel: type: string previousLevel: type: string type: object type: array tagRules: items: properties: key: type: string operator: type: string value: type: string type: object type: array type: object stateStatus: type: string templateMetaName: type: string type: object type: array tasks: items: properties: id: type: string kind: $ref: '#/components/schemas/TemplateKind' new: properties: cron: type: string description: type: string every: type: string name: type: string offset: type: string query: type: string status: type: string type: object old: properties: cron: type: string description: type: string every: type: string name: type: string offset: type: string query: type: string status: type: string type: object stateStatus: type: string templateMetaName: type: string type: object type: array telegrafConfigs: items: properties: id: type: string kind: $ref: '#/components/schemas/TemplateKind' new: $ref: '#/components/schemas/TelegrafRequest' old: $ref: '#/components/schemas/TelegrafRequest' stateStatus: type: string templateMetaName: type: string type: object type: array variables: items: properties: id: type: string kind: $ref: '#/components/schemas/TemplateKind' new: properties: args: $ref: '#/components/schemas/VariableProperties' description: type: string name: type: string type: object old: properties: args: $ref: '#/components/schemas/VariableProperties' description: type: string name: type: string type: object stateStatus: type: string templateMetaName: type: string type: object type: array type: object errors: items: properties: fields: items: type: string type: array indexes: items: type: integer type: array kind: $ref: '#/components/schemas/TemplateKind' reason: type: string type: object type: array sources: items: type: string type: array stackID: type: string summary: properties: buckets: items: properties: description: type: string envReferences: $ref: '#/components/schemas/TemplateEnvReferences' id: type: string kind: $ref: '#/components/schemas/TemplateKind' labelAssociations: items: $ref: '#/components/schemas/TemplateSummaryLabel' type: array name: type: string orgID: type: string retentionPeriod: type: integer templateMetaName: type: string type: object type: array checks: items: allOf: - $ref: '#/components/schemas/CheckDiscriminator' - properties: envReferences: $ref: '#/components/schemas/TemplateEnvReferences' kind: $ref: '#/components/schemas/TemplateKind' labelAssociations: items: $ref: '#/components/schemas/TemplateSummaryLabel' type: array templateMetaName: type: string type: object type: array dashboards: items: properties: charts: items: $ref: '#/components/schemas/TemplateChart' type: array description: type: string envReferences: $ref: '#/components/schemas/TemplateEnvReferences' id: type: string kind: $ref: '#/components/schemas/TemplateKind' labelAssociations: items: $ref: '#/components/schemas/TemplateSummaryLabel' type: array name: type: string orgID: type: string templateMetaName: type: string type: object type: array labelMappings: items: properties: labelID: type: string labelName: type: string labelTemplateMetaName: type: string resourceID: type: string resourceName: type: string resourceTemplateMetaName: type: string resourceType: type: string status: type: string type: object type: array labels: items: $ref: '#/components/schemas/TemplateSummaryLabel' type: array missingEnvRefs: items: type: string type: array missingSecrets: items: type: string type: array notificationEndpoints: items: allOf: - $ref: '#/components/schemas/NotificationEndpointDiscriminator' - properties: envReferences: $ref: '#/components/schemas/TemplateEnvReferences' kind: $ref: '#/components/schemas/TemplateKind' labelAssociations: items: $ref: '#/components/schemas/TemplateSummaryLabel' type: array templateMetaName: type: string type: object type: array notificationRules: items: properties: description: type: string endpointID: type: string endpointTemplateMetaName: type: string endpointType: type: string envReferences: $ref: '#/components/schemas/TemplateEnvReferences' every: type: string kind: $ref: '#/components/schemas/TemplateKind' labelAssociations: items: $ref: '#/components/schemas/TemplateSummaryLabel' type: array messageTemplate: type: string name: type: string offset: type: string status: type: string statusRules: items: properties: currentLevel: type: string previousLevel: type: string type: object type: array tagRules: items: properties: key: type: string operator: type: string value: type: string type: object type: array templateMetaName: type: string type: object type: array tasks: items: properties: cron: type: string description: type: string envReferences: $ref: '#/components/schemas/TemplateEnvReferences' every: type: string id: type: string kind: $ref: '#/components/schemas/TemplateKind' name: type: string offset: type: string query: type: string status: type: string templateMetaName: type: string type: object type: array telegrafConfigs: items: allOf: - $ref: '#/components/schemas/TelegrafRequest' - properties: envReferences: $ref: '#/components/schemas/TemplateEnvReferences' kind: $ref: '#/components/schemas/TemplateKind' labelAssociations: items: $ref: '#/components/schemas/TemplateSummaryLabel' type: array templateMetaName: type: string type: object type: array variables: items: properties: arguments: $ref: '#/components/schemas/VariableProperties' description: type: string envReferences: $ref: '#/components/schemas/TemplateEnvReferences' id: type: string kind: $ref: '#/components/schemas/TemplateKind' labelAssociations: items: $ref: '#/components/schemas/TemplateSummaryLabel' type: array name: type: string orgID: type: string templateMetaName: type: string type: object type: array type: object type: object NotificationEndpointDiscriminator: discriminator: mapping: http: '#/components/schemas/HTTPNotificationEndpoint' pagerduty: '#/components/schemas/PagerDutyNotificationEndpoint' slack: '#/components/schemas/SlackNotificationEndpoint' telegram: '#/components/schemas/TelegramNotificationEndpoint' propertyName: type oneOf: - $ref: '#/components/schemas/SlackNotificationEndpoint' - $ref: '#/components/schemas/PagerDutyNotificationEndpoint' - $ref: '#/components/schemas/HTTPNotificationEndpoint' - $ref: '#/components/schemas/TelegramNotificationEndpoint' 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 Link: description: URI of resource. format: uri readOnly: true type: string Template: items: description: 'A template entry. Defines an InfluxDB resource in a template. ' properties: apiVersion: example: influxdata.com/v2alpha1 type: string kind: $ref: '#/components/schemas/TemplateKind' metadata: description: 'Metadata properties used for the resource when the template is applied. ' properties: name: type: string type: object spec: description: "Configuration properties used for the resource when the template is applied.\nKey-value pairs map to the specification for the resource.\n\nThe following code samples show `spec` configurations for template resources:\n\n- A bucket:\n\n```json\n{ \"spec\": {\n \"name\": \"iot_center\",\n \"retentionRules\": [{\n \"everySeconds\": 2.592e+06,\n \"type\": \"expire\"\n }]\n }\n}\n```\n\n- A variable:\n\n```json\n{ \"spec\": {\n \"language\": \"flux\",\n \"name\": \"Node_Service\",\n \"query\": \"import \\\"influxdata/influxdb/v1\\\"\\r\\nv1.tagValues(bucket: \\\"iot_center\\\",\n tag: \\\"service\\\")\",\n \"type\": \"query\"\n }\n}\n```\n" type: object type: object type: array TemplateChart: properties: height: type: integer properties: $ref: '#/components/schemas/ViewProperties' width: type: integer xPos: type: integer yPos: type: integer type: object ColorMapping: additionalProperties: type: string description: A color mapping is an object that maps time series data to a UI color scheme to allow the UI to render graphs consistent colors across reloads. example: configcat_deployments-autopromotionblocker: '#663cd0' measurement_birdmigration_europe: '#663cd0' series_id_1: '#edf529' series_id_2: '#edf529' type: object MapVariableProperties: properties: type: enum: - map type: string values: additionalProperties: type: string 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 BuilderTagsType: properties: aggregateFunctionType: $ref: '#/components/schemas/BuilderAggregateFunctionType' key: type: string values: items: type: string type: array type: object CheckStatusLevel: description: The state to record if check matches a criteria. enum: - UNKNOWN - OK - INFO - CRIT - WARN type: string BuilderConfig: properties: aggregateWindow: properties: fillValues: type: boolean period: type: string type: object buckets: items: type: string type: array functions: items: $ref: '#/components/schemas/BuilderFunctionsType' type: array tags: items: $ref: '#/components/schemas/BuilderTagsType' type: array type: object RetentionRules: description: 'Retention rules to expire or retain data. The InfluxDB `/api/v2` API uses `RetentionRules` to configure the [retention period](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#retention-period). #### InfluxDB Cloud - `retentionRules` is required. #### InfluxDB OSS - `retentionRules` isn''t required. ' items: $ref: '#/components/schemas/RetentionRule' type: array GeoViewLayerProperties: properties: type: enum: - heatmap - circleMap - pointMap - trackMap type: string required: - type type: object TemplateApply: properties: actions: description: "A list of `action` objects.\nActions let you customize how InfluxDB applies templates in the request.\n\nYou can use the following actions to prevent creating or updating resources:\n\n- A `skipKind` action skips template resources of a specified `kind`.\n- A `skipResource` action skips template resources with a specified `metadata.name`\n and `kind`.\n" items: oneOf: - properties: action: enum: - skipKind type: string properties: properties: kind: $ref: '#/components/schemas/TemplateKind' required: - kind type: object type: object - properties: action: enum: - skipResource type: string properties: properties: kind: $ref: '#/components/schemas/TemplateKind' resourceTemplateName: type: string required: - kind - resourceTemplateName type: object type: object type: array dryRun: description: 'Only applies a dry run of the templates passed in the request. - Validates the template and generates a resource diff and summary. - Doesn''t install templates or make changes to the InfluxDB instance. ' type: boolean envRefs: additionalProperties: oneOf: - type: string - type: integer - type: number - type: boolean description: "An object with key-value pairs that map to **environment references** in templates.\n\nEnvironment references in templates are `envRef` objects with an `envRef.key`\nproperty.\nTo substitute a custom environment reference value when applying templates,\npass `envRefs` with the `envRef.key` and the value.\n\nWhen you apply a template, InfluxDB replaces `envRef` objects in the template\nwith the values that you provide in the `envRefs` parameter.\nFor more examples, see how to [define environment references](https://docs.influxdata.com/influxdb/cloud/influxdb-templates/use/#define-environment-references).\n\nThe following template fields may use environment references:\n\n - `metadata.name`\n - `spec.endpointName`\n - `spec.associations.name`\n\nFor more information about including environment references in template fields, see how to\n[include user-definable resource names](https://docs.influxdata.com/influxdb/cloud/influxdb-templates/create/#include-user-definable-resource-names).\n" type: object orgID: description: 'Organization ID. InfluxDB applies templates to this organization. The organization owns all resources created by the template. To find your organization, see how to [view organizations](https://docs.influxdata.com/influxdb/cloud/organizations/view-orgs/). ' type: string remotes: description: 'A list of URLs for template files. To apply a template manifest file located at a URL, pass `remotes` with an array that contains the URL. ' items: properties: contentType: type: string url: type: string required: - url type: object type: array secrets: additionalProperties: type: string description: "An object with key-value pairs that map to **secrets** in queries.\n\nQueries may reference secrets stored in InfluxDB--for example,\nthe following Flux script retrieves `POSTGRES_USERNAME` and `POSTGRES_PASSWORD`\nsecrets and then uses them to connect to a PostgreSQL database:\n\n```js\nimport \"sql\"\nimport \"influxdata/influxdb/secrets\"\n\nusername = secrets.get(key: \"POSTGRES_USERNAME\")\npassword = secrets.get(key: \"POSTGRES_PASSWORD\")\n\nsql.from(\n driverName: \"postgres\",\n dataSourceName: \"postgresql://${username}:${password}@localhost:5432\",\n query: \"SELECT * FROM example_table\",\n)\n```\n\nTo define secret values in your `/api/v2/templates/apply` request,\npass the `secrets` parameter with key-value pairs--for example:\n\n```json\n{\n ...\n \"secrets\": {\n \"POSTGRES_USERNAME\": \"pguser\",\n \"POSTGRES_PASSWORD\": \"foo\"\n }\n ...\n}\n```\n\nInfluxDB stores the key-value pairs as secrets that you can access with `secrets.get()`.\nOnce stored, you can't view secret values in InfluxDB.\n\n#### Related guides\n\n- [How to pass secrets when installing a template](https://docs.influxdata.com/influxdb/cloud/influxdb-templates/use/#pass-secrets-when-installing-a-template)\n" type: object stackID: description: 'ID of the stack to update. To apply templates to an existing stack in the organization, use the `stackID` parameter. If you apply templates without providing a stack ID, InfluxDB initializes a new stack with all new resources. To find a stack ID, use the InfluxDB [`/api/v2/stacks` API endpoint](#operation/ListStacks) to list stacks. #### Related guides - [Stacks](https://docs.influxdata.com/influxdb/cloud/influxdb-templates/stacks/) - [View stacks](https://docs.influxdata.com/influxdb/cloud/influxdb-templates/stacks/view/) ' type: string template: description: 'A template object to apply. A template object has a `contents` property with an array of InfluxDB resource configurations. Pass `template` to apply only one template object. If you use `template`, you can''t use the `templates` parameter. If you want to apply multiple template objects, use `templates` instead. ' properties: contentType: type: string contents: $ref: '#/components/schemas/Template' sources: items: type: string type: array type: object templates: description: 'A list of template objects to apply. A template object has a `contents` property with an array of InfluxDB resource configurations. Use the `templates` parameter to apply multiple template objects. If you use `templates`, you can''t use the `template` parameter. ' items: properties: contentType: type: string contents: $ref: '#/components/schemas/Template' sources: items: type: string type: array type: object type: array type: object GeoViewProperties: properties: allowPanAndZoom: default: true description: If true, map zoom and pan controls are enabled on the dashboard view type: boolean center: description: Coordinates of the center of the map properties: lat: description: Latitude of the center of the map format: double type: number lon: description: Longitude of the center of the map format: double type: number required: - lat - lon type: object colors: description: Colors define color encoding of data into a visualization items: $ref: '#/components/schemas/DashboardColor' type: array detectCoordinateFields: default: true description: If true, search results get automatically regroupped so that lon,lat and value are treated as columns type: boolean latLonColumns: $ref: '#/components/schemas/LatLonColumns' layers: description: List of individual layers shown in the map items: $ref: '#/components/schemas/GeoViewLayer' type: array mapStyle: description: Define map type - regular, satellite etc. type: string note: type: string queries: items: $ref: '#/components/schemas/DashboardQuery' type: array s2Column: description: String to define the column type: string shape: enum: - chronograf-v2 type: string showNoteWhenEmpty: description: If true, will display note when empty type: boolean type: enum: - geo type: string useS2CellID: description: If true, S2 column is used to calculate lat/lon type: boolean zoom: description: Zoom level used for initial display of the map format: double maximum: 28 minimum: 1 type: number required: - type - shape - queries - note - showNoteWhenEmpty - center - zoom - allowPanAndZoom - detectCoordinateFields - layers type: object TemplateKind: enum: - Bucket - Check - CheckDeadman - CheckThreshold - Dashboard - Label - NotificationEndpoint - NotificationEndpointHTTP - NotificationEndpointPagerDuty - NotificationEndpointSlack - NotificationRule - Task - Telegraf - Variable type: string QueryEditMode: enum: - builder - advanced type: string StaticLegend: description: StaticLegend represents the options specific to the static legend properties: colorizeRows: type: boolean heightRatio: format: float type: number opacity: format: float type: number orientationThreshold: type: integer show: type: boolean valueAxis: type: string widthRatio: format: float type: number type: object responses: AuthorizationError: content: application/json: examples: tokenNotAuthorized: summary: Token is not authorized to access a resource value: code: unauthorized message: unauthorized access schema: properties: code: description: 'The HTTP status code description. Default is `unauthorized`. ' enum: - unauthorized readOnly: true type: string message: description: A human-readable message that may contain detail about the error. readOnly: true type: string description: "Unauthorized. The error may indicate one of the following:\n\n * The `Authorization: Token` header is missing or malformed.\n * The API token value is missing from the header.\n * The token doesn't have sufficient permissions to write to this organization and bucket.\n" InternalServerError: content: application/json: schema: $ref: '#/components/schemas/Error' description: 'Internal server error. The server encountered an unexpected situation. ' securitySchemes: BasicAuthentication: description: "### Basic authentication scheme\n\nUse the HTTP Basic authentication scheme for InfluxDB `/api/v2` API operations that support it:\n\n### Syntax\n\n`Authorization: Basic BASE64_ENCODED_CREDENTIALS`\n\nTo construct the `BASE64_ENCODED_CREDENTIALS`, combine the username and\nthe password with a colon (`USERNAME:PASSWORD`), and then encode the\nresulting string in [base64](https://developer.mozilla.org/en-US/docs/Glossary/Base64).\nMany HTTP clients encode the credentials for you before sending the\nrequest.\n\n_**Warning**: Base64-encoding can easily be reversed to obtain the original\nusername and password. It is used to keep the data intact and does not provide\nsecurity. You should always use HTTPS when authenticating or sending a request with\nsensitive information._\n\n### Examples\n\nIn the examples, replace the following:\n\n- **`EMAIL_ADDRESS`**: InfluxDB Cloud username (the email address the user signed up with)\n- **`PASSWORD`**: InfluxDB Cloud [API token](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#token)\n- **`INFLUX_URL`**: your InfluxDB Cloud URL\n\n#### Encode credentials with cURL\n\nThe following example shows how to use cURL to send an API request that uses Basic authentication.\nWith the `--user` option, cURL encodes the credentials and passes them\nin the `Authorization: Basic` header.\n\n```sh\ncurl --get \"INFLUX_URL/api/v2/signin\"\n --user \"EMAIL_ADDRESS\":\"PASSWORD\"\n```\n\n#### Encode credentials with Flux\n\nThe Flux [`http.basicAuth()` function](https://docs.influxdata.com/flux/v0.x/stdlib/http/basicauth/) returns a Base64-encoded\nbasic authentication header using a specified username and password combination.\n\n#### Encode credentials with JavaScript\n\nThe following example shows how to use the JavaScript `btoa()` function\nto create a Base64-encoded string:\n\n```js\nbtoa('EMAIL_ADDRESS:PASSWORD')\n```\n\nThe output is the following:\n\n```js\n'VVNFUk5BTUU6UEFTU1dPUkQ='\n```\n\nOnce you have the Base64-encoded credentials, you can pass them in the\n`Authorization` header--for example:\n\n```sh\ncurl --get \"INFLUX_URL/api/v2/signin\"\n --header \"Authorization: Basic VVNFUk5BTUU6UEFTU1dPUkQ=\"\n```\n\nTo learn more about HTTP authentication, see\n[Mozilla Developer Network (MDN) Web Docs, HTTP authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication)._\n" scheme: basic type: http TokenAuthentication: description: "Use the [Token authentication](#section/Authentication/TokenAuthentication)\nscheme to authenticate to the InfluxDB API.\n\nIn your API requests, send an `Authorization` header.\nFor the header value, provide the word `Token` followed by a space and an InfluxDB API token.\nThe word `Token` is case-sensitive.\n\n### Syntax\n\n`Authorization: Token INFLUX_API_TOKEN`\n\n### Example\n\n#### Use Token authentication with cURL\n\nThe following example shows how to use cURL to send an API request that uses Token authentication:\n\n```sh\ncurl --request GET \"INFLUX_URL/api/v2/buckets\" \\\n --header \"Authorization: Token INFLUX_API_TOKEN\"\n```\n\nReplace the following:\n\n - *`INFLUX_URL`*: your InfluxDB Cloud URL\n - *`INFLUX_API_TOKEN`*: your [InfluxDB API token](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#token)\n\n### Related endpoints\n\n- [`/authorizations` endpoints](#tag/Authorizations-(API-tokens))\n\n### Related guides\n\n- [Authorize API requests](https://docs.influxdata.com/influxdb/cloud/api-guide/api_intro/#authentication)\n- [Manage API tokens](https://docs.influxdata.com/influxdb/cloud/security/tokens/)\n" in: header name: Authorization type: apiKey x-tagGroups: - name: Overview tags: - Quick start - Authentication - Supported operations - Headers - Pagination - Response codes - name: Popular endpoints tags: - Data I/O endpoints - Security and access endpoints - System information endpoints - name: All endpoints tags: []