Folders
Create a folder
At the root, or inside another folder of the same region (parent_folder_id). A folder_resource_id or name already used in the region of the workspace is refused with 409. With validate_only, every check runs and 204 answers, nothing is created.
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.
region*RegionsRegion of the resource: besg (Europe) or usnv (United States), as GET /v1/regions lists them
"besg""usnv"Idempotency-Key?|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.
nullapplication/json- body
folder_name*Folder Name1 <= length <= 255folder_resource_id?|A unique, readable id of the folder in the region of the workspace (lowercase letters, digits and _); derived from the name when absent
nullparent_folder_id?|The folder to create it in; the root when absent
nullvalidate_only?Validate OnlyRun every check of the write and answer 204 without writing: a refused write answers the error the write would
falseCreated
application/json- response
folder_id*Folder Idfolder_name*Folder Namefolder_resource_id*Folder Resource Idparent_folder_id*|The folder it is in; None at the root
region*Regions"besg""usnv"curl -X POST 'https://api.stacksync.com/v1/workspaces/0/folders?region=besg' \ -H 'Content-Type: application/json' \ -d '{ "folder_name": "<folder_name>"}'{ "folder_id": "<folder_id>", "folder_name": "<folder_name>", "folder_resource_id": "<folder_resource_id>", "parent_folder_id": "<parent_folder_id>", "region": "besg"}GETGet the folder tree
Every folder of the workspace in one region, nested under its parent, as the web app's sidebar shows it.
PATCHRename a folder
A name another folder has in the region of the workspace is refused with 409, as a create refuses it. With validate_only, every check runs and 204 answers, nothing is saved.