SIsigmacomputing
Connections

List connection paths

List all paths for all connections available to the user.

Usage notes

  • Call this endpoint to retrieve the specific databases, catalogs, schemas, and tables available to the user associated with the API credentials.
  • Pass connectionId to restrict results to a single connection.
get/v2/connections/paths

Request

  • Base URL
    https://api.sigmacomputing.com
  • Auth
    HTTP bearer

Query parameters

pagestring

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

limitnumber double

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.

connectionIdstring

Restrict results to paths within this connection.

Response

The response body.

nextPagestring nullable required

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.

totalnumber double

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

hasMoreboolean

[Deprecated] Indicates whether more results are available.

Changes

No recorded changes to this operation across all 1 revision of this API.