Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

InfluxData Templates API

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 youadd, update, and remove installed template resources over time, avoid duplicatingresources when applying the same or similar templates more than once, andapply 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/)

InfluxData Templates API is one of 45 APIs that InfluxData publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Templates. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, and a getting-started guide.

This API exposes 8 operations across 5 paths, and defines 79 schemas. It is described by OpenAPI 3.0.0, at version 2.0.1.

Requests are made against a single base URL, /api/v2.

8 operations 5 paths 79 schemas 1 DELETE2 GET1 PATCH4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2.0.1
Base URL
https://us-east-1-1.aws.cloud2.influxdata.com/api/v2
Authentication
API Key, HTTP Basic
License
Resource Areas
1

Authentication & Security 2

InfluxData Templates API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (TokenAuthentication). It accepts HTTP basic authentication (BasicAuthentication). By default, every request must be authenticated.

  • TokenAuthentication — Use the [Token authentication](section/Authentication/TokenAuthentication) scheme to authenticate to the InfluxDB API. In your API requests, send an Authorizat…
  • BasicAuthentication — Basic authentication scheme Use the HTTP Basic authentication scheme for InfluxDB /api/v2 API operations that support it: Syntax Authorization: Basic BASE64ENC…

Paths & Operations 8

Across 5 paths, the API surfaces 8 operations — 1 DELETE, 2 GET, 1 PATCH, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Templates 8

Export and apply InfluxDB templates. Manage stacks of templated InfluxDB resources. InfluxDB templates are prepackaged configurations for resources. Use InfluxDB templates to conf…

GET
/stacks
List installed stacks
ListStacks 3 params → 200400401500default
POST
/stacks
Create a stack
CreateStack body → 201401422500default
GET
/stacks/{stack_id}
Retrieve a stack
ReadStack 1 param → 200default
PATCH
/stacks/{stack_id}
Update a stack
UpdateStack 1 param body → 200default
DELETE
/stacks/{stack_id}
Delete a stack and associated resources
DeleteStack 2 params → 204default
POST
/stacks/{stack_id}/uninstall
Uninstall a stack
UninstallStack 1 param → 200default
POST
/templates/apply
Apply or dry-run a template
ApplyTemplate body → 200201422500default
POST
/templates/export
Export a new template
ExportTemplate body → 200default

Schemas 79

The contract defines 79 schemas that model the data the API accepts and returns. The most detailed are ScatterViewProperties (32 properties), HeatmapViewProperties (31 properties), LinePlusSingleStatProperties (30 properties), XYViewProperties (29 properties). Each schema is shown below with its type and property counts.

TableViewProperties
object
10 properties 10 required
BuilderTagsType
object
3 properties
TemplateEnvReferences
array
StaticLegend
object
StaticLegend represents the options specific to the static legend
7 properties
QueryEditMode
string
GeoViewLayerProperties
object
1 property 1 required
ColorMapping
object
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.
ViewProperties
RetentionRules
array
Retention rules to expire or retain data. The InfluxDB /api/v2 API uses RetentionRules to configure the [retention period](https://docs.influxdata.com/influxdb…
BuilderConfig
object
4 properties
GaugeViewProperties
object
11 properties 11 required
CustomCheck
Link
string
URI of resource.
DashboardQuery
object
4 properties
TemplateSummaryLabel
object
7 properties
TemplateSummary
object
5 properties
TemplateApply
object
9 properties
TaskStatusType
string
inactive cancels scheduled runs and prevents manual runs of the task.
ThresholdCheck
AxisScale
string
Scale is the axis formatting scale. Supported: "log", "linear"
TelegramNotificationEndpoint
object
BuilderFunctionsType
object
1 property
Threshold
MapVariableProperties
object
2 properties
DeadmanCheck
Labels
array
NotificationEndpointBase
object
11 properties 2 required
ThresholdBase
object
2 properties
ConstantVariableProperties
object
2 properties
DashboardColor
object
Defines an encoding of data value into color space.
5 properties 5 required
SingleStatViewProperties
object
12 properties 11 required
LatLonColumns
object
Object type to define lat/lon columns
2 properties 2 required
HistogramViewProperties
object
16 properties 12 required
RangeThreshold
CheckBase
object
15 properties 3 required
CheckStatusLevel
string
The state to record if check matches a criteria.
Stack
object
4 properties
SlackNotificationEndpoint
object
GeoPointMapViewLayer
CheckDiscriminator
RenamableField
object
Describes a field that can be renamed and made visible or invisible.
3 properties
MosaicViewProperties
object
29 properties 17 required
GeoHeatMapViewLayer
MarkdownViewProperties
object
3 properties 3 required
GeoViewLayer
object
Check
TemplateChart
object
5 properties
SimpleTableViewProperties
object
6 properties 6 required
LatLonColumn
object
Object type for key and column definitions
2 properties 2 required
BandViewProperties
object
29 properties 8 required
NotificationEndpointDiscriminator
ScatterViewProperties
object
32 properties 18 required
HTTPNotificationEndpoint
object
TelegrafRequest
object
5 properties
RetentionRule
object
3 properties 1 required
NotificationEndpointType
string
VariableProperties
object
GeoViewProperties
object
15 properties 10 required
TemplateExportByName
object
3 properties
Label
object
4 properties
LinePlusSingleStatProperties
object
30 properties 11 required
Axes
object
The viewport for a View's visualizations
2 properties 2 required
BuilderAggregateFunctionType
string
PagerDutyNotificationEndpoint
object
Axis
object
Axis used in a visualization.
6 properties
Template
array
HeatmapViewProperties
object
31 properties 17 required
TemplateExportByID
object
3 properties
QueryVariableProperties
object
2 properties
GeoCircleViewLayer
DecimalPlaces
object
Indicates whether decimal places should be enforced, and how many digits it should show.
2 properties
XYViewProperties
object
29 properties 9 required
LesserThreshold
CheckViewProperties
object
11 properties 5 required
TemplateKind
string
XYGeom
string
GeoTrackMapViewLayer
object
4 properties
GreaterThreshold
Error
object
4 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

influxdata-templates-api-openapi.yml Raw ↑

Other APIs InfluxData publishes across the network.

InfluxData Authorizations (API tokens) API
InfluxData Backup API
InfluxData Bucket Schemas API
InfluxData Buckets API
InfluxData Cells API
InfluxData Checks API
InfluxData Config API
InfluxData Dashboards API
InfluxData Data I/O endpoints API
InfluxData DBRPs API
InfluxData Debug API
InfluxData Delete API