Connections
Update a connection
Rename a connection, share it with the workspace, or replace its credentials (validated by the app first). Any editor who can see a connection shared with the workspace can update it.
Authorization
AuthorizationstringheaderrequiredBearer <key>, where <key> is a workspace API key or a user API key. See Authentication.
workspace_id*integerThe workspace. List the ones your key can reach with GET /v1/workspaces.
connection_id*stringThe connection.
uuidregion*RegionRegion of the connection: besg or usnv
"besg""usnv"application/json- body
connection_name?|The new name: letters, numbers, dashes, underscores and spaces, 3 to 63 characters
nullis_shared_with_workspace?|True to share the connection with every member of the workspace
nullcredentials?|The new credentials of the app
nullvalidate_only?Validate OnlyRun every check of the write and answer 204 without writing: a refused write answers the error the write would
falseOK
application/json- response
data*curl -X POST 'https://api.stacksync.com/v1/workspaces/0/connections/497f6eca-6276-4993-bfeb-53cbbbba6f08/update?region=usnv' \ -H 'Content-Type: application/json' \ -d '{ "connection_name": "Production Postgres"}'{ "data": { "connection_id": "<connection_id>", "connection_name": "<connection_name>", "app_type": "<app_type>", "is_shared_with_workspace": false, "created_time": "<created_time>", "last_modified_time": "<last_modified_time>", "credentials_options": {}, "connection_resource_id": "<connection_resource_id>", "region": "<region>", "needs_reauthorization": false }}POSTCreate a connection
Create a connection to an app with the credentials given, after testing them against the app. Only the user of the API key can use the connection unless `is_shared_with_workspace` is true. Answers the connection without its secrets.
DELDelete a connection
Refused while a sync, workflow, API proxy or scheduled task uses the connection.