Syncs
Rename a sync
Change the name of a sync. The name must follow the name rule and be free in the workspace. Send validate_only: true to check the name without renaming.
Authorization
AuthorizationstringheaderrequiredBearer <key>, where <key> is a workspace API key or a user API key. See Authentication.
workspace_id*integerThe workspace the resources belong to
base_id*stringThe sync (a sync is called a base in these paths)
uuidregion*stringData region of the sync
"besg""usnv"The new name
application/json- body
The new name of the sync
base_name*stringThe new name. 3 to 63 characters: unaccented letters (A-Z, a-z), numbers, underscores, dashes and spaces only; unique in the workspace
validate_only?booleanRun every check of the write and answer without writing: a refused write answers the error it would answer
falseThe sync renamed
application/json- response
The renamed sync
message*stringBase name updated successfully
base_id*stringThe sync
uuidcurl -X POST 'https://api.stacksync.com/v1/workspaces/0/bases/497f6eca-6276-4993-bfeb-53cbbbba6f08/update?region=besg' \ -H 'Content-Type: application/json' \ -d '{ "base_name": "Salesforce accounts to Postgres - production"}'{ "message": "Base name updated successfully", "base_id": "3f6c1d2e-8a4b-4c7d-9e21-5b6f7a8c9d01"}DELDelete a sync
Switch the sync off and delete it. Its data in both apps is kept; the sync's own storage is cleaned up in the background. The sync can no longer be read or listed.
POSTSwitch a sync on or off
Start or pause a sync. The sync answers in state `processing` while it starts or stops; read its status to follow. A sync switched off can be switched on again only after a short wait, which the error names in seconds.