v1

latestSwagger 2.02026-07-178567199.3 KB

sources

Create new data source

post/sources

Request body

idstring

Unique identifier representing a specific data source.

namestring

User facing name of data source

Format of the data source

usernamestring

Username for authentication to data source

passwordstring

Password is in cleartext.

sharedSecretstring

JWT signing secret for optional Authorization: Bearer to InfluxDB

clusterIdstring

Cluster ID for InfluxDB Cloud Dedicated sources

accountIdstring

Account ID for InfluxDB Cloud Dedicated sources

managementTokenstring

Management token for InfluxDB Cloud Dedicated sources

databaseTokenstring

Database token for InfluxDB Cloud Dedicated or other InfluxDB 3 sources

tagsCSVPathstring

Path to a directory containing CSV files with tags for InfluxDB Cloud Dedicated sources

urlstring url required

URL for the time series data source backend (e.g. http://localhost:8086)

metaUrlstring url

URL for the influxdb meta node

insecureSkipVerifyboolean

True means any certificate presented by the source is accepted. Typically used for self-signed certs. Probably should only be used for testing.

defaultboolean

Indicates whether this source is the default source

telegrafstring

Database where telegraf information is stored for this source

defaultRPstring

Default retention policy used in Host-related queries proxied to InfluxDB from the Host List and Host pages.

defaultDBstring

Default database used in queries for InfluxDB Cloud Dedicated when database list is not available

organizationstring

Organization that this source belongs to, when Chronograf auth is in use

rolestring

Not used currently. Can be used to designate a minimum role required to access this source.

versionstring

Version of influxDB being run, unknown if not found

Example request

{
  "id": "4",
  "name": "Influx 1",
  "type": "influx",
  "url": "http://localhost:8086",
  "default": false,
  "telegraf": "telegraf",
  "defaultRP": "customRP",
  "organization": "default",
  "authentication": "basic",
  "role": "viewer",
  "links": {
    "self": "/chronograf/v1/sources/4",
    "kapacitors": "/chronograf/v1/sources/4/kapacitors",
    "proxy": "/chronograf/v1/sources/4/proxy",
    "write": "/chronograf/v1/sources/4/write",
    "queries": "/chronograf/v1/sources/4/queries",
    "permissions": "/chronograf/v1/sources/4/permissions",
    "users": "/chronograf/v1/sources/4/users",
    "roles": "/chronograf/v1/sources/4/roles",
    "health": "/chronograf/v1/sources/4/health"
  }
}

Response

Data source successfully created