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.

post/v1/workspaces/{workspace_id}/folders

Request

Base URL
https://api.stacksync.com
URL
https://api.stacksync.com/v1/workspaces/{workspace_id}/folders
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

folder_namestring required

folder_resource_idstring nullable

A unique, readable id of the folder in the region of the workspace (lowercase letters, digits and _); derived from the name when absent

parent_folder_idstring uuid nullable

The folder to create it 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

Response

Created

folder_idstring required

folder_namestring required

folder_resource_idstring required

parent_folder_idstring nullable required

The folder it is in; None at the root