List connections

GET

/v2/connections

GET

/v2/connections

$ curl https://api.sigmacomputing.com/v2/connections \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json"

200Retrieved

1 {
2   "entries": [
3     {
4       "organizationId": "org-9f8b7c6d5e4a3b2c1d0e",
5       "connectionId": "conn-1234567890abcdef",
6       "isSample": false,
7       "isAuditLog": true,
8       "lastActiveAt": "2024-04-20T14:45:00Z",
9       "name": "Sales Data Warehouse",
10       "type": "snowflake",
11       "useOauth": true,
12       "createdBy": "user-7a8b9c0d1e2f3g4h5i6j",
13       "updatedBy": "user-7a8b9c0d1e2f3g4h5i6j",
14       "createdAt": "2023-11-10T08:00:00Z",
15       "updatedAt": "2024-04-15T12:00:00Z",
16       "isArchived": false,
17       "account": "sf_account_01",
18       "warehouse": "analytics_wh",
19       "user": "analytics_user",
20       "role": "ANALYST_ROLE",
21       "timeout": {
22         "default": 120,
23         "worksheet": 180,
24         "dashboard": 300,
25         "download": 600
26       },
27       "poolSizes": {
28         "isPoolConfigured": true,
29         "adhocPoolSize": 10,
30         "catalogPoolSize": 5,
31         "resultPoolSize": 15,
32         "schedulePoolSize": 8
33       },
34       "writeAccess": true,
35       "friendlyName": true,
36       "writebacks": [
37         {
38           "database": "sales_db",
39           "schema": "writeback_schema",
40           "writebackSchemaId": "wb-schema-001"
41         }
42       ],
43       "writebackSchemas": [
44         {
45           "database": "sales_db",
46           "schema": "oauth_writeback",
47           "writebackSchemaId": "wb-schema-002"
48         }
49       ],
50       "inputTableAuditLogSchema": {
51         "database": "audit_db",
52         "schema": "input_table_log",
53         "writebackSchemaId": "audit-schema-01"
54       },
55       "materializationWarehouse": "materialization_wh",
56       "exportsWarehouse": "export_wh",
57       "oauthMetadataUrl": "https://auth.snowflake.com/.well-known/openid-configuration",
58       "oauthClientId": "client-abc123xyz",
59       "oauthScopes": [
60         "openid",
61         "profile",
62         "email"
63       ],
64       "oauthIdpType": "snowflake",
65       "oauthUsePkce": true,
66       "oauthUseJwt": false,
67       "oauthAudience": "https://api.snowflake.com",
68       "isIndependentOAuth": false,
69       "userAttributes": {
70         "role": "ANALYST_ROLE",
71         "warehouse": "analytics_wh"
72       },
73       "roleSwitching": "allRoles"
74     }
75   ],
76   "nextPage": "eyJwYWdlIjoiMg==",
77   "total": 25,
78   "hasMore": true
79 }

Get a list of available connections and the connection IDs.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Query parameters

pagestringOptional

limitdoubleOptional

includeArchivedbooleanOptional

searchstringOptional

Response

The response body.

entrieslist of objects

Array of results returned by the endpoint

nextPagestring or null

Returns a string that can be used as the page parameter in the next request to fetch the next page of results. The last page of results returns null.

totaldouble

Total number of results. Useful to determine if there is a need to paginate.

hasMoreboolean

[Deprecated] Indicates whether more results are available.