API proxies
Update an API proxy
Rename it, share it with the workspace (or stop), or switch it to another connection. Only the fields sent change.
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.
api_proxy_id*stringThe API proxy.
uuidregion*RegionsRegion of the resource: besg (Europe) or usnv (United States), as GET /v1/regions lists them
"besg""usnv"application/json- body
api_proxy_name?|3 to 63 characters: a letter first, then letters, digits, spaces, _ and -; unique among the API proxies of the workspace in the region
nullis_shared_with_workspace?|nullconnection_id?|Switch the proxy to another connection of the same 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
connection_id*string|nullapi_proxy_id*Api Proxy Idapi_proxy_name*Api Proxy Nameapi_proxy_resource_id*|Answered by GET /api-proxy/<api_proxy_id>; null in the list, whose core does not select it
app_type*App Typeconnection_name*string|nullis_shared_with_workspace*Is Shared With WorkspaceEvery workspace member may use the proxy, not only its creator
max_objects_per_request*|The workspace plan's limit of objects per proxied request; null in the list
parent_folder_id*|The folder of the proxy; null at the root, and in the list
created_by*Created Bycreated_time*Created TimeHTTP date (RFC 9110), UTC
last_modified_by*Last Modified Bylast_modified_time*Last Modified TimeHTTP date (RFC 9110), UTC
region*Regions"besg""usnv"curl -X PATCH 'https://api.stacksync.com/v1/workspaces/0/api-proxy/497f6eca-6276-4993-bfeb-53cbbbba6f08?region=besg' \ -H 'Content-Type: application/json' \ -d '{ "api_proxy_name": "Salesforce Proxy"}'{ "connection_id": "<connection_id>", "api_proxy_id": "<api_proxy_id>", "api_proxy_name": "<api_proxy_name>", "api_proxy_resource_id": "<api_proxy_resource_id>", "app_type": "<app_type>", "connection_name": "<connection_name>", "is_shared_with_workspace": false, "max_objects_per_request": 0, "parent_folder_id": "<parent_folder_id>", "created_by": 0, "created_time": "<created_time>", "last_modified_by": 0, "last_modified_time": "<last_modified_time>", "region": "besg"}