Get Connection

Gets a connection by its RID.

Path parameters

ridstringRequired

Headers

AuthorizationstringRequired

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

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