Create Connection

POST

Creates a new connection.

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.

availableTagValuesmap from strings to sets of stringsRequired

shouldScrapebooleanRequired

descriptionstringOptional

scrapingobjectOptional

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.

availableTagValuesmap from strings to sets of strings

metadatamap from strings to strings

shouldScrapeboolean

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

connectionStatusobject

isArchivedboolean

descriptionstringOptional

scrapingobjectOptional

limitsobjectOptional

POST

1 curl -X POST https://api.gov.nominal.io/api/data-source/connection/v1/connections \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "name": "name",
6   "connectionDetails": {
7     "type": "timescale",
8     "timescale": {
9       "database": "database",
10       "host": "host",
11       "port": 1,
12       "username": "username",
13       "passwordSecretRid": "passwordSecretRid"
14     }
15   },
16   "metadata": {
17     "metadata": "metadata"
18   },
19   "requiredTagNames": [
20     "requiredTagNames"
21   ],
22   "availableTagValues": {
23     "availableTagValues": [
24       "availableTagValues"
25     ]
26   },
27   "shouldScrape": true
28 }'

200Successful

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   "availableTagValues": {
18     "availableTagValues": [
19       "availableTagValues"
20     ]
21   },
22   "metadata": {
23     "metadata": "metadata"
24   },
25   "shouldScrape": true,
26   "connectionStatus": {
27     "isConnected": true
28   },
29   "isArchived": true,
30   "description": "description",
31   "scraping": {
32     "type": "influx",
33     "influx": {
34       "filter": [
35         {
36           "type": "not",
37           "not": {
38             "type": "not",
39             "not": {
40               "type": "not",
41               "not": {
42                 "type": "not",
43                 "not": {
44                   "type": "matchBucket",
45                   "matchBucket": []
46                 }
47               }
48             }
49           }
50         },
51         {
52           "type": "not",
53           "not": {
54             "type": "not",
55             "not": {
56               "type": "not",
57               "not": {
58                 "type": "not",
59                 "not": {
60                   "type": "matchBucket",
61                   "matchBucket": []
62                 }
63               }
64             }
65           }
66         }
67       ],
68       "seriesArchetypeConstruction": {
69         "channelNameComponents": [
70           {
71             "type": "bucket",
72             "bucket": {}
73           },
74           {
75             "type": "bucket",
76             "bucket": {}
77           }
78         ],
79         "separator": "separator"
80       }
81     }
82   },
83   "limits": {
84     "maxQueryRange": {
85       "unit": "HOURS",
86       "count": 1
87     }
88   }
89 }

Update Connection

Up Next

Built with

1	curl -X POST https://api.gov.nominal.io/api/data-source/connection/v1/connections \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"name": "name",
6	"connectionDetails": {
7	"type": "timescale",
8	"timescale": {
9	"database": "database",
10	"host": "host",
11	"port": 1,
12	"username": "username",
13	"passwordSecretRid": "passwordSecretRid"
14	}
15	},
16	"metadata": {
17	"metadata": "metadata"
18	},
19	"requiredTagNames": [
20	"requiredTagNames"
21	],
22	"availableTagValues": {
23	"availableTagValues": [
24	"availableTagValues"
25	]
26	},
27	"shouldScrape": true
28	}'

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	"availableTagValues": {
18	"availableTagValues": [
19	"availableTagValues"
20	]
21	},
22	"metadata": {
23	"metadata": "metadata"
24	},
25	"shouldScrape": true,
26	"connectionStatus": {
27	"isConnected": true
28	},
29	"isArchived": true,
30	"description": "description",
31	"scraping": {
32	"type": "influx",
33	"influx": {
34	"filter": [
35	{
36	"type": "not",
37	"not": {
38	"type": "not",
39	"not": {
40	"type": "not",
41	"not": {
42	"type": "not",
43	"not": {
44	"type": "matchBucket",
45	"matchBucket": []
46	}
47	}
48	}
49	}
50	},
51	{
52	"type": "not",
53	"not": {
54	"type": "not",
55	"not": {
56	"type": "not",
57	"not": {
58	"type": "not",
59	"not": {
60	"type": "matchBucket",
61	"matchBucket": []
62	}
63	}
64	}
65	}
66	}
67	],
68	"seriesArchetypeConstruction": {
69	"channelNameComponents": [
70	{
71	"type": "bucket",
72	"bucket": {}
73	},
74	{
75	"type": "bucket",
76	"bucket": {}
77	}
78	],
79	"separator": "separator"
80	}
81	}
82	},
83	"limits": {
84	"maxQueryRange": {
85	"unit": "HOURS",
86	"count": 1
87	}
88	}
89	}