← API reference
CANONICAL TYPE REFERENCE

CreateFolderInput

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

nameString!

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.

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.

rootPathString

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

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.

View exact 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
}

One stable address across all schema views. Follow a field’s type to explore connections between domains.