SHshareout
Workspaces

Create a workspace connector

Changed on

Admin+. Two kinds. Generic (type: rest_api, bigquery, snowflake; credentials.type: api_key, basic_auth, service_account). Platform (kind: platform + provider): the Connectors catalog — s3, supabase, redshift, aurora, snowflake, bigquery, google-analytics, google-ads, facebook-ads, shopify, tiendanube. Platform credential types: aws_access_key (access_key_id, secret_access_key, optional session_token — s3, redshift, aurora), oauth (access_token — supabase, shopify, tiendanube, facebook-ads), key_pair (snowflake), service_account, authorized_user. Per-provider config: s3 bucket, region, optional prefix, endpoint; supabase project_ref (ref or project URL); redshift region, database and one of workgroup_name / cluster_identifier (+ db_user or secret_arn); aurora resource_arn, secret_arn, database. credentialScope: shared (default) or per_user. Secrets are encrypted and never returned.

post/v1/workspaces/{workspaceId}/connections

Request

  • Base URL
    https://shareout.site
  • URL
    https://shareout.site/v1/workspaces/{workspaceId}/connections
  • Auth
    HTTP bearer

Request body

namestring required

Letters, digits, _ and -; max 64.

kind'generic' | 'platform'
type'rest_api' | 'bigquery' | 'snowflake'

Generic connectors only.

providerstring

Platform connectors only (kind: platform).

credentialScope'shared' | 'per_user'
authTypestring
configobject

Example request

{
  "provider": "s3"
}

Response

Created

Changes

  • e80fee24553eRevision changes
    • breaking

      request property was restricted to a list of enum values

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      the request property became optional

    • info

      added the new bigquery enum value to the request property

    • info

      added the new rest_api enum value to the request property

    • info

      added the new snowflake enum value to the request property

  • 1069d922d239Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status