Skip to main content

Folders

A folder is a named location in a hierarchy that organizes content within a Space, addressed by a path such as Detections/AWS. A folder's resource ID is prefixed FLD_.

A folder groups content resources for browsing. It is organization only and does not change how the resources inside it run. Folders nest to any depth. Each one names its parent folder in parentFolderId, and a folder with no parent sits at the Space root. Any content resource can carry a folderPath that places it in a folder, and the same folder tree holds detections, dashboards, and every other content kind side by side.

Path model​

A folder is addressed by its path from the Space root, with / separating each level. folderPath holds the path of the location the folder sits in, not including the folder's own name. A folder named AWS inside a Detections folder has folderPath Detections and a full address of Detections/AWS. A folder at the Space root has an empty folderPath and a null parentFolderId.

Inputs​

FieldTypeRequiredDescription
namestringRequiredThe folder name. Cannot contain /, \, :, *, ?, ", <, >, or |, cannot contain control characters, cannot start or end with a dot, cannot have leading or trailing whitespace, and cannot be . or ...
folderPathstringRequiredThe path of the location the folder sits in, / separated, not including name. Empty for a folder at the Space root.

Outputs​

FieldTypeDescription
parentFolderIdstringThe folder this one sits in, prefixed FLD_. Null for a folder at the Space root.

Plus the common resource fields.

  • Content, the parent category and the home of the folder-organization mechanics every content resource shares.
  • Spaces, the boundary a folder tree lives within.
  • Changesets, how edits to a folder are staged and committed.