List Connections

1 curl -G https://api.gov.nominal.io/api/data-source/connection/v1/connections \ 2 -H "Authorization: Bearer <token>" \ 3 -d "workspaces[]"=workspaces

1 [ 2 { 3 "rid": "rid", 4 "displayName": "displayName", 5 "connectionDetails": { 6 "type": "timescale", 7 "timescale": { 8 "database": "database", 9 "host": "host", 10 "port": 1, 11 "username": "username", 12 "passwordSecretRid": "passwordSecretRid" 13 } 14 }, 15 "requiredTagNames": [ 16 "requiredTagNames" 17 ], 18 "metadata": { 19 "metadata": "metadata" 20 }, 21 "shouldScrape": true, 22 "connectionStatus": { 23 "isConnected": true 24 }, 25 "isArchived": true, 26 "description": "description", 27 "availableTagValues": { 28 "availableTagValues": [ 29 "availableTagValues" 30 ] 31 }, 32 "scraping": { 33 "type": "influx", 34 "influx": { 35 "filter": [ 36 { 37 "type": "not", 38 "not": { 39 "type": "not", 40 "not": { 41 "type": "not", 42 "not": { 43 "type": "matchBucket", 44 "matchBucket": [] 45 } 46 } 47 } 48 }, 49 { 50 "type": "not", 51 "not": { 52 "type": "not", 53 "not": { 54 "type": "not", 55 "not": { 56 "type": "matchBucket", 57 "matchBucket": [] 58 } 59 } 60 } 61 } 62 ], 63 "seriesArchetypeConstruction": { 64 "channelNameComponents": [ 65 { 66 "type": "bucket", 67 "bucket": {} 68 }, 69 { 70 "type": "bucket", 71 "bucket": {} 72 } 73 ], 74 "separator": "separator" 75 } 76 } 77 }, 78 "limits": { 79 "maxQueryRange": { 80 "unit": "HOURS", 81 "count": 1 82 } 83 } 84 } 85 ]

Lists all connections.

Query parameters

includeArchivedbooleanOptional

workspacesset of stringsRequired

Response

This endpoint returns a set of objects.

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

Headers

Query parameters

Response