Syncs
Syncs
Set the rate limit of an app
POST
Set the most requests Stacksync makes to one app of the sync per period. The sync may stay on. Leave rate limits at Stacksync's default unless the app asks for less.
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)
Format
uuidapp_id*stringOne of the two apps of the sync, by its app_id (read it from the sync)
region*stringData region of the sync
Value in
"besg""usnv"The rate limit
application/json- body
The rate limit of an app; the sync may stay on
rate*integerThe number of requests allowed per period, 1 to 2147483647
Range
1 <= value <= 2147483647frequency?integerThe period of the rate in seconds: 1 (per second), 60, 3600 or 86400; per second when left out
Default
1Value in
160360086400The rate limit stored
application/json- response
The rate limit stored
data*The most requests Stacksync makes to the app in a period
curl -X POST 'https://api.stacksync.com/v1/workspaces/0/bases/497f6eca-6276-4993-bfeb-53cbbbba6f08/apps/string/rate-limit?region=besg' \ -H 'Content-Type: application/json' \ -d '{ "rate": 20, "frequency": 1}'{ "data": { "rate": 20, "frequency": 1 }}