STstacksync
Syncs

Create a sync

Create a sync between two apps from the tables and columns you pair with mapping ids. Stacksync reads both apps, checks every table and column, creates the tables marked create_new_table and stores the sync switched off: switch it on with the switch route. Send validate_only: true to run every check and get the sync as it would be stored without creating it.

post/v1/workspaces/{workspace_id}/bases

Request

  • Base URL
    https://api.stacksync.com
  • URL
    https://api.stacksync.com/v1/workspaces/{workspace_id}/bases
  • Auth
    HTTP bearer

Path parameters

workspace_idinteger required

The workspace the resources belong to

Request body

base_namestring required

The name of the sync. 3 to 63 characters: unaccented letters (A-Z, a-z), numbers, underscores, dashes and spaces only; unique in the workspace

base_region'besg' | 'usnv' required

The data region the sync runs in; the connections must be in it

base_resource_idstring

A stable id of your choosing, 1 to 60 letters, digits or underscores, unique in the workspace; derived from the name when left out

base_statusstring

Accepted and stored as given; leave it out so Stacksync sets the state of the new sync itself

folder_idstring uuid

The folder of the workspace, in base_region, to file the sync under; the root when left out

validate_onlyboolean

Run every check of the create, including reading the apps, and answer the sync as it would be stored (its column names after renames, no base_id) without creating it

Response

The sync created (with validate_only, the sync as it would be stored, without base_id)

Changes

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