Update Connection

1 curl -X PUT https://api.gov.nominal.io/api/data-source/connection/v1/connection/rid/details \ 2 -H "Authorization: Bearer <token>" \ 3 -H "Content-Type: application/json" \ 4 -d '{}'

1 { 2 "rid": "rid", 3 "displayName": "displayName", 4 "connectionDetails": { 5 "type": "timescale", 6 "timescale": { 7 "database": "database", 8 "host": "host", 9 "port": 1, 10 "username": "username", 11 "passwordSecretRid": "passwordSecretRid" 12 } 13 }, 14 "requiredTagNames": [ 15 "requiredTagNames" 16 ], 17 "metadata": { 18 "metadata": "metadata" 19 }, 20 "shouldScrape": true, 21 "connectionStatus": { 22 "isConnected": true 23 }, 24 "isArchived": true, 25 "description": "description", 26 "scraping": { 27 "type": "influx", 28 "influx": { 29 "filter": [ 30 { 31 "type": "not", 32 "not": { 33 "type": "not", 34 "not": { 35 "type": "not", 36 "not": { 37 "type": "not", 38 "not": { 39 "type": "matchBucket", 40 "matchBucket": [] 41 } 42 } 43 } 44 } 45 }, 46 { 47 "type": "not", 48 "not": { 49 "type": "not", 50 "not": { 51 "type": "not", 52 "not": { 53 "type": "not", 54 "not": { 55 "type": "matchBucket", 56 "matchBucket": [] 57 } 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 }

Updates an existing connection.

Path parameters

ridstringRequired

Request

This endpoint expects an object.

namestringOptional

descriptionstringOptional

metadatamap from strings to stringsOptional

connectionDetailsobjectOptional

requiredTagNamesset of stringsOptional

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

shouldScrapebooleanOptional

limitsobjectOptional

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