Sigma Computing

Sigma Computing Connections API

The Connections API from Sigma Computing — 13 operation(s) for connections.

GitHub OpenAPI

Operations 22

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /v2/connection/{connectionId}/lookup Look up a warehouse object by its path · Look up connections by path #
Ask an LLM
“How do I find the connection path ID for a schema or table by its name path?”
“Can I resolve a fully qualified database path inside a connection?”
Tell an agent
Look up path {path} in connection {connectionId}.
Resolve the object at {path} within connection {connectionId}.
GET /v2/connections List my warehouse connections · List connections #
Ask an LLM
“Which data warehouse connections does my Sigma organization have?”
“Can I include archived connections or search connections by name?”
Tell an agent
List all my connections.
Search connections for {search}, including archived ones set to {includeArchived}.
POST /v2/connections Connect a cloud data warehouse · Create a connection #
Ask an LLM
“How do I connect Sigma to my cloud data warehouse through the API?”
“Can I set pool sizes and a query timeout when creating a connection?”
Tell an agent
Create a connection named {name} with details {details}.
Add warehouse connection {name} using {details} and a timeout of {timeoutSecs} seconds.
PATCH /v2/connections/{connectionId} Rename a connection (deprecated PATCH) · Update a connection #
Ask an LLM
“Is there an older deprecated endpoint to rename a connection or toggle OAuth?”
“Can the legacy PATCH connection call switch a connection to OAuth?”
Tell an agent
Using the deprecated PATCH, rename connection {connectionId} to {name}.
Set OAuth to {useOauth} on connection {connectionId} with the legacy update.
GET /v2/connections/{connectionId} Get a connection's metadata · Get connection details #
Ask an LLM
“What are the settings of one of my warehouse connections?”
“Where can I see a connection's details by its ID?”
Tell an agent
Get details for connection {connectionId}.
Show the metadata of connection {connectionId}.
DELETE /v2/connections/{connectionId} Delete a warehouse connection · Delete a connection #
Ask an LLM
“How do I remove a data warehouse connection from Sigma?”
“Can I delete a connection by its ID?”
Tell an agent destructive · confirm first
Delete connection {connectionId}.
Remove warehouse connection {connectionId} from my organization.
PUT /v2/connections/{connectionId} Update or restore a connection · Update a connection #
Ask an LLM
“How do I change a connection's settings while keeping the details I want?”
“Can I restore an archived connection?”
Tell an agent
Update connection {connectionId} with its full new details.
Restore archived connection {connectionId} by setting restore to {restore}.
POST /v2/connections/{connectionId}/dbtArtifacts Upload dbt run artifacts for a connection · Add dbt metadata for a connection #
Ask an LLM
“How do I push dbt Core metadata into Sigma for a connection?”
“Can Sigma show dbt descriptions from my run artifacts?”
Tell an agent
Add dbt artifacts {artifacts} to connection {connectionId}.
Upload these dbt run artifacts for connection {connectionId}: {artifacts}.
POST /v2/connections/{connectionId}/grants Grant users or teams access to a connection · Add grants to a connection #
Ask an LLM
“How do I let a team query a warehouse connection?”
“Can I give several users permissions on a connection at once?”
Tell an agent
Add grants {grants} to connection {connectionId}.
Give these users and teams access to connection {connectionId}: {grants}.
GET /v2/connections/{connectionId}/grants List who has access to a connection · List grants for a connection #
Ask an LLM
“Which users and teams have permissions on a connection?”
“How can I audit access to a warehouse connection?”
Tell an agent
List the grants on connection {connectionId}.
Show who can use connection {connectionId}.
DELETE /v2/connections/{connectionId}/grants/{grantId} Revoke a permission on a connection · Delete a grant for a connection #
Ask an LLM
“How do I take away a team's access to a whole connection?”
“Can I delete one grant on a connection?”
Tell an agent destructive · confirm first
Delete grant {grantId} on connection {connectionId}.
Revoke connection {connectionId} access for grant {grantId}.
POST /v2/connections/{connectionId}/sync Sync warehouse changes for a connection path · Sync a connection by path #
Ask an LLM
“How do I make Sigma pick up new columns or tables from my warehouse?”
“Can I sync a single schema or table instead of the whole connection?”
Tell an agent
Sync path {path} on connection {connectionId}.
Refresh schema changes at {path} in connection {connectionId} using the service account set to {useServiceAccount}.
GET /v2/connections/{connectionId}/test Test read and write access on a connection · Test a connection #
Ask an LLM
“Does my connection allow reads and writes for the API user?”
“How do I verify a warehouse connection is working?”
Tell an agent
Test connection {connectionId}.
Check whether connection {connectionId} permits read and write operations.
GET /v2/connections/paths List databases, schemas and tables I can reach · List connection paths #
Ask an LLM
“Which databases, schemas and tables are available to me across connections?”
“Can I list paths for just one connection?”
Tell an agent
List all connection paths available to me.
List the databases, schemas and tables in connection {connectionId}.
POST /v2/connections/paths/{connectionPathId}/grants Grant access to a schema or table path · Add grants to a connection path #
Ask an LLM
“How do I give a team access to only one schema in a connection?”
“Can I grant permissions on a single table path?”
Tell an agent
Add grants {grants} to connection path {connectionPathId}.
Give these users and teams access to path {connectionPathId}: {grants}.
GET /v2/connections/paths/{connectionPathId}/grants List grants on a schema or table path · List grants for a connection path #
Ask an LLM
“Who has permissions on a specific schema or table within a connection?”
“How can I audit access to a single connection path?”
Tell an agent
List the grants on connection path {connectionPathId}.
Show who can access schema or table path {connectionPathId}.
DELETE /v2/connections/paths/{connectionPathId}/grants/{grantId} Revoke a grant on a schema or table path · Delete a grant for a connection path #
Ask an LLM
“How do I remove someone's access to a specific schema or table?”
“Can I revoke one grant from a connection path?”
Tell an agent destructive · confirm first
Delete grant {grantId} on connection path {connectionPathId}.
Revoke path {connectionPathId} access for grant {grantId}.
GET /v2/connections/paths/{inodeId} Get the warehouse path for a table · Get connection path for a table #
Ask an LLM
“Where in my warehouse does a table used in Sigma live?”
“Can I find the connection path for a table by its inode ID?”
Tell an agent
Get the connection path for table {inodeId}.
Show the database and schema location of table inode {inodeId}.
GET /v2/connections/tables/{tableId}/columns List columns of a warehouse table · List columns for a warehouse table #
Ask an LLM
“What columns and data types does a warehouse table have?”
“Can I inspect a table's schema through a Sigma connection?”
Tell an agent
List the columns of warehouse table {tableId}.
Show column names and types for table {tableId}, {pageSize} per page.
POST /v3alpha/connections Create a connection (v3alpha beta) · Create a connection (Beta) #
Ask an LLM
“Is there a beta v3alpha endpoint for creating warehouse connections?”
“Can I try the private-beta connection creation API?”
Tell an agent
Using the v3alpha beta API, create connection {name} with {details}.
Create beta connection {name} through v3alpha from details {details}.
PATCH /v3alpha/connections/{connectionId} Partially update a connection (v3alpha beta) · Update a connection (Beta) #
Ask an LLM
“Can I change only some options of a connection with the v3alpha beta endpoint?”
“Which beta endpoint updates a connection without resending every detail?”
Tell an agent
Rename connection {connectionId} to {name} via the v3alpha beta patch.
Patch only {details} on connection {connectionId} using v3alpha.
GET /v3alpha/connections/{connectionId} Get connection details (v3alpha beta) · Get connection details (Beta) #
Ask an LLM
“How do I read a connection's metadata from the v3alpha beta API?”
“Does the beta v3alpha API return connection details by ID?”
Tell an agent
Get connection {connectionId} from the v3alpha beta API.
Fetch v3alpha details for connection {connectionId}.

Documentation

📖
Documentation
https://help.sigmacomputing.com/docs/get-started-with-sigmas-api
📖
APIReference
https://help.sigmacomputing.com/reference/get-started-sigma-api
📖
GettingStarted
https://help.sigmacomputing.com/reference/get-started-sigma-api
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/sigma-computing/refs/heads/main/authentication/sigma-computing-authentication.yml
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/sigma-computing/refs/heads/main/rate-limits/sigma-computing-rate-limits.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/sigma-computing/refs/heads/main/openapi/sigma-computing-connections-api-openapi.yml

Other Resources

🔗
Examples
https://help.sigmacomputing.com/recipes
🔗
OAuthScopes
https://raw.githubusercontent.com/api-evangelist/sigma-computing/refs/heads/main/scopes/sigma-computing-scopes.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/sigma-computing/refs/heads/main/conventions/sigma-computing-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/sigma-computing/refs/heads/main/errors/sigma-computing-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/sigma-computing/refs/heads/main/data-model/sigma-computing-data-model.yml
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/sigma-computing/refs/heads/main/asyncapi/sigma-computing-webhooks.yml
🔗
Conformance
https://raw.githubusercontent.com/api-evangelist/sigma-computing/refs/heads/main/conformance/sigma-computing-conformance.yml
🔗
Lifecycle
https://raw.githubusercontent.com/api-evangelist/sigma-computing/refs/heads/main/lifecycle/sigma-computing-lifecycle.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/sigma-computing:sigma-computing-connections-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

sigma-computing-connections-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Sigma Computing Connections API
  version: '1.0'
  description: 'Operations tagged connections across 2 of this provider''s published API definitions: sigma-computing-public-rest-api-openapi.json, sigma-computing-rest-api-openapi.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.sigmacomputing.com
  description: Server for GCP (US) hosted organizations
- url: https://api.sa.gcp.sigmacomputing.com
  description: Server for GCP (KSA) hosted organizations
- url: https://aws-api.sigmacomputing.com
  description: Server for AWS US (West) hosted organizations
- url: https://api.us-a.aws.sigmacomputing.com
  description: Server for AWS US (East) hosted organizations
- url: https://api.ca.aws.sigmacomputing.com
  description: Server for AWS Canada hosted organizations
- url: https://api.eu.aws.sigmacomputing.com
  description: Server for AWS Europe hosted organizations
- url: https://api.au.aws.sigmacomputing.com
  description: Server for AWS Australia and APAC hosted organizations
- url: https://api.uk.aws.sigmacomputing.com
  description: Server for AWS UK hosted organizations
- url: https://api.us.azure.sigmacomputing.com
  description: Server for Azure US hosted organizations
- url: https://api.eu.azure.sigmacomputing.com
  description: Server for Azure Europe hosted organizations
- url: https://api.ca.azure.sigmacomputing.com
  description: Server for Azure Canada hosted organizations
- url: https://api.uk.azure.sigmacomputing.com
  description: Server for Azure United Kingdom hosted organizations
- url: https://api.au.azure.sigmacomputing.com
  description: Server for Azure Australia hosted organizations
tags:


# --- truncated at 32 KB (527 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/sigma-computing/refs/heads/main/openapi/sigma-computing-connections-api-openapi.yml