Skip to content

Folder ​

Type: Object

A tenant-scoped, named storage location: a name bound to exactly one transport plus a root path/prefix within it, so files, workflow nodes and scripts can choose where bytes live without knowing how they get there. The binding is flattened here to a kind discriminator plus the at-most-one matching reference ID.

Fields ​

NameTypeArgsDescriptionDeprecated
controllerIdControllerIDTypeID of the bound edge controller (e.g. "ctl_01K…"). Non-null only when kind is CONTROLLER; null otherwise. The controller always belongs to this tenant.
createdAtString!ISO-8601 timestamp of when the folder was created.
descriptionStringOptional free-text note about the folder's purpose (max 1000 characters); null when unset.
idFolderID!TypeID of this folder (e.g. "fld_01K…"); stable file handles reference it.
isDefaultBoolean!True for the single folder per tenant that receives files stored without an explicit folder selection. Exactly one folder per tenant carries this flag.
kindFolderBindingKind!Discriminator for the folder's binding; tells you which of storageBackendId / controllerId is populated.
nameString!Human-facing folder name. Unique per tenant.
rootPathString!Location within the bound transport. For cloud bindings (CONTROL_CLOUD, STORAGE_BACKEND) this is a key prefix — possibly empty, never leading "/". For CONTROLLER it is an absolute filesystem path starting with "/". Never contains a ".." segment.
storageBackendIdStorageBackendIDTypeID of the bound storage backend (e.g. "sbk_01K…"). Non-null only when kind is STORAGE_BACKEND; null otherwise.
tenantIdTenantID!TypeID of the owning tenant (e.g. "ten_01K…"); folders are tenant-scoped.
updatedAtString!ISO-8601 timestamp of the folder's last modification; equals createdAt until first update.

Connect machines, automate workflows, and build custom apps for print production.