InfluxDB
App Vendor: InfluxData
App Category: Configuration Management Database (CMDB)
Connector Version: 1.1.0
API Version: 2.0.0
About App
InfluxDB is an essential time series data platform that allows developers to build IoT, analytics, and cloud applications all in one place.
The InfluxDB app is configured with the Orchestrate application to perform the following actions:
Action Name | Description |
|---|---|
Write Data | This action writes data to a bucket in the InfluxDB v2.0 database. |
Generic Action | This is a generic action used to make requests to any InfluxDB endpoint. |
Configuration Parameters
The following configuration parameters are required for the InfluxDB app to communicate with the InfluxDB enterprise application. The parameters can be configured by creating instances in the app.
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Hostname | Enter the Hostname to connect with the InfluxDB application. Example: https://influx.example.com | Text | Required | |
Port | Enter the port number to communicate with the InfluxDB application. Example: 443 | Text | Required | |
Database name | Enter the InfluxDB database name to write data. Example: Example Database | Text | Required | |
Username | Enter the username if authentication is enabled. Example: SampleUsername | Text | Optional | |
Verify SSL | Choose your preference to verify SSL while making requests. It is recommended to set this option to yes. Passing no may result in incorrectly establishing the connection | Boolean | Optional | By default, verification is not enabled. |
Timeout | Enter the timeout value in seconds. This is the number of seconds that requests will wait to establish a connection with InfluxDB. | Password | Optional | Allowed range: 15-120 Default value: 15 |
Action: Write Data
This action writes data to a bucket in the InfluxDB v2.0 database.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Data to Write | Enter the data to write as a list. Example: name,project_name=\"eg\",val1=\"3.1.0\" val2=1 | Text | Required | InfluxDB uses the line protocol to write data to the database. For more information about syntax and examples, see InfluxDB Documentation. |
Bucket Name | Enter the bucket name to write the data. Example: my-new-bucket | Text | Required |
Example Request
[
{
"data_to_write": "name,project_name=\"eg\",val1=\"3.1.0\" val2=1",
"bucket_name": "my-new-bucket"
}
]Action: Generic Action
This is a generic action used to make requests to any InfluxDB endpoint.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Method | Enter the HTTP method to make the request. | Text | Required | Allowed values: GET, PUT, POST, DELETE |
Endpoint | Enter the endpoint to make the request to. /api/v2/write | Text | Required | |
Query Params | Enter the query parameters to pass to the API. | Key-Value | Optional | |
Payload | Enter the payload to pass to the API. | Any | Optional | |
Extra Fields | Enter the extra fields to pass to the API. | Key-Value | Optional | Allowed keys: payload_json, download, files, filename, retry_wait, retry_count, custom_output, response_type |
Example Request
[
{
"method": "GET",
"endpoint": "api/v2/write",
"query_params": {
"page": "0",
"size": "100"
}
}
]