← All resources

Resource

folder

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.

GraphQL reference →

Configuration

nameString!Required

Human-facing folder name. Required, and must be unique within the tenant.

descriptionStringOptional

Optional free-text note about the folder's purpose (max 1000 characters).

kindFolderBindingKind!Required

Transport to bind the folder to. STORAGE_BACKEND requires storageBackendId; CONTROLLER requires controllerId; CONTROL_CLOUD requires neither.

Allowed values

CONTROL_CLOUD — The bytes live in ControlApp's own cloud file store, which the platform operates on the tenant's behalf. Control must configure a storage account; storageCapabilities and testFolder report read-only prerequisites. The store mints its own storage keys, so this is the one kind whose rootPath carries no meaning and is ignored.

STORAGE_BACKEND — The bytes live under a path inside one of the tenant's own StorageBackend rows, so the tenant supplies the account and credentials. storageBackendId names the backend and rootPath is a relative prefix within it, never starting with a slash.

CONTROLLER — The bytes live on the filesystem of an edge controller and are reached over file RPC rather than any cloud API, so the folder is only usable while that controller is online. controllerId names it and rootPath is an absolute path on that machine.

storageBackendIdStorageBackendIDOptional

TypeID of the storage backend to bind to (e.g. "sbk_01K…"). Required when kind is STORAGE_BACKEND and must name a backend in this tenant; ignored otherwise.

References storage_backend

controllerIdControllerIDOptional

TypeID of the edge controller to bind to (e.g. "ctl_01K…"). Required when kind is CONTROLLER and must name a controller in this tenant; ignored otherwise.

References controller

rootPathString!Optional

Location within the bound transport. Cloud bindings (CONTROL_CLOUD, STORAGE_BACKEND) take a key prefix, defaulting to "" when omitted; any leading "/" is stripped. CONTROLLER requires an absolute path starting with "/". A ".." segment is rejected in either case.

isDefaultBoolean!Optional

Make this the tenant's default folder (the one that receives files stored without an explicit folder). Defaults to false; rejected if the tenant already has a default.

Read-only values

Show values
idFolderID!Read only

TypeID of this folder (e.g. "fld_01K…"); stable file handles reference it.

computed by the platform

tenantIdTenantID!Read only

TypeID of the owning tenant (e.g. "ten_01K…"); folders are tenant-scoped.

computed by the platform

createdAtString!Read only

ISO-8601 timestamp of when the folder was created.

computed by the platform

updatedAtString!Read only

ISO-8601 timestamp of the folder's last modification; equals createdAt until first update.

computed by the platform

Lifecycle

The CLI can create this resource. The platform assigns its id.

When replacement is needed, the existing resource is removed before its replacement is created.