API ReferenceConnection

Add Available Tags

Adds available tag key/value pairs to the connection. If a tag name already exists, the values will be merged. This is primarily an internal endpoint to update tags for external connections as they are periodically scraped. This endpoint should only be called by clients for Visual crossing connections. Throws if called for Nominal connections which have their tags automatically indexed in the underlying Database.

Path parameters

ridstringRequired

Headers

AuthorizationstringRequired

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

Request

This endpoint expects a map from strings to sets of strings.

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