← All types
In Input object

CreateFolderInput

Input for createFolder: a name plus exactly one transport binding and its root path.

Fields

name

String!Required

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

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

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

Possible values (3)
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.

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.

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.

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.

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.

Referenced by (1)
Exact type SDL
"""
Input for createFolder: a name plus exactly one transport binding and its root path.
"""
input CreateFolderInput {
  """
  Human-facing folder name. Required, and must be unique within the tenant.
  """
  name: String!
  """
  Optional free-text note about the folder's purpose (max 1000 characters).
  """
  description: String
  """
  Transport to bind the folder to. STORAGE_BACKEND requires storageBackendId; CONTROLLER requires controllerId; CONTROL_CLOUD requires neither.
  """
  kind: FolderBindingKind!
  """
  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.
  """
  storageBackendId: StorageBackendID
  """
  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.
  """
  controllerId: ControllerID
  """
  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.
  """
  rootPath: String
  """
  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.
  """
  isDefault: Boolean
}