API ReferenceConnection

Create Connection

Creates a new connection.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
namestringRequired
connectionDetailsobjectRequired
metadatamap from strings to stringsRequired

Metadata information about the connection which is not relevant to the DB connection itself.

requiredTagNamesset of stringsRequired

Additional tag name that are required to construct a fully qualified series.

shouldScrapebooleanRequired
descriptionstringOptional
availableTagValuesmap from strings to sets of stringsOptional

In most cases, this does not to be set by the user. Throws if populated for Nominal connections, which have their tags automatically indexed in the underlying database. Tags for external connections are periodically scraped. Tags should only be updated manually for Visual crossing connections.

scrapingobjectOptional
limitsobjectOptional
workspacestringOptional

The workspace in which to create the connection. If not provided, the connection will be created in the default workspace for the user’s organization, if the default workspace for the organization is configured.

Response

This endpoint returns an object.
ridstring
displayNamestring

The display name of the connection. For example: “Nominal production TimescaleDB”

connectionDetailsobject
requiredTagNamesset of strings

Additional tag names that should be supplied to construct a fully qualified series. These are suggested, rather than strictly required.

metadatamap from strings to strings
shouldScrapeboolean

The connection will be scraped iff this flag is set and scrapingConfig is present.

connectionStatusobject
isArchivedboolean
descriptionstringOptional
availableTagValuesmap from strings to sets of stringsOptional

Deprecated, use the DataSourceService#getAvailableTagsForConnection endpoint instead

scrapingobjectOptional
limitsobjectOptional