STstacksync
API proxies

Create an API proxy

A proxy on an existing connection; its app is the connection's. The token is in this answer only. Send an Idempotency-Key to retry safely.

post/v1/workspaces/{workspace_id}/api-proxy

Request

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

Path parameters

workspace_idinteger required

The workspace. List the ones your key can reach with GET /v1/workspaces.

Query parameters

region'besg' | 'usnv' required

Region of the resource: besg (Europe) or usnv (United States), as GET /v1/regions lists them

Headers

Idempotency-Keystring nullable

Makes the create retry-safe for 24 hours: a retry with the same key answers the resource the first call created, with the Idempotent-Replayed: true header, and creates nothing. 1 to 255 visible ASCII characters. The same key with a different request answers 422; while the first call still runs, 409.

Request body

connection_idstring uuid4 required

The connection the proxy calls the app with; its app is the proxy's app

api_proxy_namestring nullable

3 to 63 characters: a letter first, then letters, digits, spaces, _ and -; unique among the API proxies of the workspace in the region; generated when absent

is_shared_with_workspaceboolean
api_proxy_resource_idstring nullable
parent_folder_idstring nullable

The folder to create the proxy in, the root when absent

validate_onlyboolean

Run every check of the write and answer 204 without writing: a refused write answers the error the write would

Example request

{
  "api_proxy_name": "Salesforce Proxy",
  "connection_id": "6f1c2a9e-4b7d-4e3a-9c5f-2d8b1e7a4c60"
}

Response

OK

connection_idstring nullable required
api_proxy_idstring required
api_proxy_namestring required
api_proxy_resource_idstring nullable required

Answered by GET /api-proxy/<api_proxy_id>; null in the list, whose core does not select it

app_typestring required
connection_namestring nullable required
is_shared_with_workspaceboolean required

Every workspace member may use the proxy, not only its creator

max_objects_per_requestinteger nullable required

The workspace plan's limit of objects per proxied request; null in the list

parent_folder_idstring nullable required

The folder of the proxy; null at the root, and in the list

created_byinteger required
created_timestring required

HTTP date (RFC 9110), UTC

last_modified_byinteger required
last_modified_timestring required

HTTP date (RFC 9110), UTC

region'besg' | 'usnv' required
api_proxy_tokenstring nullable required

Changes

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