STstacksync
Syncs

Edit a sync

Replace the mapping of a sync with the whole sync you send: read it, change tables, columns, directions, rate limits or delete protection, and send it back. A table left out of both apps is removed, a new pair is added. The sync is paused while the edit applies and restarted after it. Send validate_only: true to run every check without changing the sync.

put/v1/workspaces/{workspace_id}/bases/{base_id}

Request

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

Path parameters

workspace_idinteger required

The workspace the resources belong to

base_idstring uuid required

The sync (a sync is called a base in these paths)

Request body

base_idstring uuid required

The sync; must equal the base_id of the path

base_namestring required

The name of the sync

base_region'besg' | 'usnv' required

The data region of the sync

base_resource_idstring

The stable id of the sync

base_statusstring

Accepted and stored as given; leave it out

validate_onlyboolean

Run every check of the edit, including reading the apps, and answer the sync as it would be stored without changing it

Response

The sync after the edit (with validate_only, as it would be stored)

Changes

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