STstacksync
App schema

Generate an app schema

Read the tables of a connection and the columns of the tables named, so a sync can be built from exact table and column names. The credentials are read from the connection, never sent. Readable with a read-only key.

post/v1/workspaces/{workspace_id}/helpers/generate-app-schema

Request

  • Base URL
    https://api.stacksync.com
  • URL
    https://api.stacksync.com/v1/workspaces/{workspace_id}/helpers/generate-app-schema
  • Auth
    HTTP bearer

Path parameters

workspace_idinteger required

The workspace the resources belong to

Query parameters

region'besg' | 'usnv' required

Data region of the connection

Request body

connection_idstring uuid required

The connection to read the schema through

table_namesstring[]

The tables to read the columns of, by table_name or table_id exactly as the schema lists them; the answer lists every table but fills columns for these only

Response

The tables of the app, with the columns of the tables named

app_typestring required

The app of the connection, as shown in Stacksync

can_create_tablesboolean required

Whether a sync may create a new table in this app (table_options.create_new_table: true)

Changes

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