Get connection
- OpenAPI 3.1.0 document: https://api.rollstack.com/public/v1/openapi.json
- The whole reference in Markdown: https://docs.rollstack.com/llms-full.txt
- An index of the reference: https://docs.rollstack.com/llms.txt
GET https://api.rollstack.com/public/v1/connections/{type}/{id}
A data source connection, without its credentials. listConnections gives its type and id.
Requires the connections:read scope.
Operation ID: getConnection.
Path parameters
type(string, required): The data source the connection reads from:Tableau,Looker,Metabase,PowerBI,Lightdash,Omni,SigmaorSalesforce, or theSnowflake,DatabricksorBigQuerydata warehouse. Endpoints that act on a connection take it in their path, with the connection'sid. One ofTableau,Looker,Metabase,PowerBI,Lightdash,Omni,Sigma,Salesforce,Snowflake,Databricks,BigQuery.id(string, required): Unique identifier for the connection, fromlistConnections, which also returns itstype.
Response 200
Success
application/json
id(string, required): Unique identifier for the connection. Pass it withtypeto the other/connections/{type}/{id}endpoints.type(string, required): The data source the connection reads from:Tableau,Looker,Metabase,PowerBI,Lightdash,Omni,SigmaorSalesforce, or theSnowflake,DatabricksorBigQuerydata warehouse. Endpoints that act on a connection take it in their path, with the connection'sid. One ofTableau,Looker,Metabase,PowerBI,Lightdash,Omni,Sigma,Salesforce,Snowflake,Databricks,BigQuery.name(string, required): The connection's name, as members see it in Rollstack.config(object, required): The connection's settings other than its credentials, which Rollstack never returns. Each type has only the settings that apply to it.baseUrl(string): The URL of the instance the connection reads from, such as your Looker, Metabase or Snowflake URL. For Sigma, the API base URL of your Sigma organization's region. Power BI and Omni connections have none: an Omni connection's account is ininstanceSlug.siteName(string or null): Tableau only: the Tableau site the connection reads from, as your Tableau URLs name it after#/site/.nullfor a Tableau Server's default site.instanceSlug(string): Omni only: your Omni account name, the subdomain of your Omni URL (acmeinhttps://acme.omniapp.co).organizationSlug(string): Sigma only: your Sigma organization, as your Sigma URLs name it afterapp.sigmacomputing.com/(acmeinhttps://app.sigmacomputing.com/acme).projectId(string): Lightdash only: the ID of the Lightdash project whose dashboards the connection reads.embeddingMode(string): Looker only: how Rollstack opens the connection's Looker dashboards to capture their charts.signed: through embed URLs signed with the connection's embed secret.private: through Looker's API, by exporting dashboards as PDFs, which is slower and less reliable.cookielesscurrently works likesigned. One ofsigned,cookieless,private.authorizationMode(string): Looker, Power BI and Sigma only: whose permissions in the tool apply when members read data.per_user: each member's own, through their own API key in Looker or found by their email in Power BI, if the connection was created with a Power BI email.impersonated(Looker only): one admin API key acts as each member's Looker user, found by their email.shared: everyone gets the same access, that of the connection's API key in Looker or of the app registration in Power BI. Sigma:internal, each member's own Sigma account, found by their email;embed_users, the same, else an embed user Rollstack creates with the account type and teams set in the app.authMethod(string): Metabase, Snowflake, Databricks and BigQuery only: how Rollstack signs in. For Metabase,apiKeyuses an admin API key and applies each member's Metabase permissions, found by their email, whilepasswordsigns each member in with their own Metabase password. For Snowflake, Databricks and BigQuery,oauthhas each member connect their own account through a browser sign-in, whileservicehas everyone read through one Snowflake service user, with a key pair, one Databricks service principal or one Google Cloud service account.
autoProvision(boolean, required): Whether members who join the organization get access to the connection automatically. Whenfalse, its owner and admins add members withaddConnectionUsers.isActive(boolean, required): Whether at least one member's access to the connection works, so data can be read through it.falsewhen none does: for example, members still have to enter their own credentials in the app, no user in the tool has their email, or their credentials were found invalid.defaultUserId(number or null, required): The user id of the connection's default user, which the app calls its service account. Everyone with access to the connection reads its data through this member's access instead of their own.nullwhen there's none, so each member reads with their own access.owner(object or null, required): The member who owns the connection, usually the one who created it. Only the owner can delete the connection and add or remove its admins.nullif no member holds the owner role.id(number, required): The owner's user id, aslistMembersreturns it.email(string, required): The owner's email address.
admins(array of object, required): The members who manage the connection, each with their role on it: its owner and its admins.userId(number, required): The member's user id, aslistMembersreturns it.role(string, required): The member's role on the connection.owner: owns the connection; only they can delete it and add or remove admins.admin: can change the connection's settings and credentials, and manage who has access to it. One ofowner,admin.
hasCredentials(true, required): Alwaystrue. Credentials are write-only: Rollstack never returns them. Change them withreplaceConnectionCredentials.createdAt(string (date-time), required): When the connection was created.updatedAt(string (date-time), required): When the connection was last updated, for example renamed or given new credentials.