List connections

GET

/v2/connections

GET

/v2/connections

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

200Retrieved

1 {
2   "entries": [
3     {
4       "organizationId": "string",
5       "connectionId": "string",
6       "isSample": true,
7       "isAuditLog": true,
8       "lastActiveAt": "2024-01-15T09:30:00Z",
9       "name": "string",
10       "type": "string",
11       "useOauth": true,
12       "createdBy": "string",
13       "updatedBy": "string",
14       "createdAt": "2024-01-15T09:30:00Z",
15       "updatedAt": "2024-01-15T09:30:00Z",
16       "isArchived": true,
17       "account": "string",
18       "warehouse": "string",
19       "user": "string",
20       "httpPath": "string",
21       "role": "string",
22       "timeout": {
23         "default": 1.1,
24         "worksheet": 1.1,
25         "dashboard": 1.1,
26         "download": 1.1
27       },
28       "poolSizes": {
29         "isPoolConfigured": true,
30         "adhocPoolSize": 1.1,
31         "catalogPoolSize": 1.1,
32         "resultPoolSize": 1.1,
33         "schedulePoolSize": 1.1
34       },
35       "writeAccess": true,
36       "friendlyName": true,
37       "writebacks": [
38         {
39           "database": "string",
40           "schema": "string",
41           "writebackSchemaId": "string",
42           "description": "string"
43         }
44       ],
45       "writebackSchemas": [
46         {
47           "database": "string",
48           "schema": "string",
49           "writebackSchemaId": "string",
50           "description": "string"
51         }
52       ],
53       "inputTableAuditLogSchema": {
54         "database": "string",
55         "schema": "string",
56         "writebackSchemaId": "string"
57       },
58       "materializationWarehouse": "string",
59       "exportsWarehouse": "string",
60       "oauthMetadataUrl": "string",
61       "oauthClientId": "string",
62       "oauthScopes": [
63         "string"
64       ],
65       "oauthIdpType": "aws_databricks",
66       "oauthUsePkce": true,
67       "oauthUseJwt": true,
68       "oauthAudience": "string",
69       "isIndependentOAuth": true,
70       "userAttributes": {
71         "role": "string",
72         "warehouse": "string"
73       },
74       "roleSwitching": "allRoles"
75     }
76   ],
77   "nextPage": "string",
78   "total": 1.1,
79   "hasMore": true
80 }

Get a list of available connections and the connection IDs.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Query parameters

pagestringOptional

Use to specify further pages using the string returned in the nextPage portion of the response.

limitdoubleOptional

Number of results to return per page, with a maximum of 1,000 per request. Use the page option in subsequent requests to retrieve the next set of results.

includeArchivedbooleanOptional

searchstringOptional

Search filter for the name of the connection.

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.

totaldoubleOptional

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

hasMorebooleanOptional

[Deprecated] Indicates whether more results are available.