Actions100
- Project Actions
- Project Accept Project Invite
- Project Create Project Invite
- Project List Invites For Project
- Project Create Project
- Project Decline Project Invite
- Project Delete Project Avatar
- Project Request Project Avatar Upload
- Project Delete Project Invite
- Project Get Project Invite
- Project Delete Project Membership
- Project Get Project Membership
- Project Update Project Membership
- Project Delete Project
- Project Get Project
- Project Delete Server Avatar
- Project Request Server Avatar Upload
- Project Get Project Token Invite
- Project Get Self Membership For Project
- Project Get Server
- Project List Memberships For Project
- Project List Project Invites
- Project List Project Memberships
- Project List Projects
- Project List Servers
- Project Resend Project Invite Mail
- Project Update Project Description
- Project Update Server Description
- Storagespace Get Project Statistics
- Storagespace Get Server Statistics
- Storagespace Replace Project Notification Threshold
- Storagespace Replace Server Notification Threshold
- Backup Actions
- Backup Create Project Backup Export
- Backup Delete Project Backup Export
- Backup Create Project Backup Schedule
- Backup List Project Backup Schedules
- Backup Create Project Backup
- Backup List Project Backups
- Backup Delete Project Backup Schedule
- Backup Get Project Backup Schedule
- Backup Update Project Backup Schedule
- Backup Delete Project Backup
- Backup Get Project Backup
- Backup Update Project Backup Description
- SSH SFTP User Actions
- Cronjob Actions
- App Actions
- App Execute Action
- App Get App
- App Get Appinstallation
- App Patch Appinstallation
- App Uninstall Appinstallation
- App Get Appversion
- App Get Installed Systemsoftware For Appinstallation
- App Get Missing Dependencies For Appinstallation
- App Get Systemsoftware
- App Get Systemsoftwareversion
- App Link Database
- App List Appinstallations For User
- App List Appinstallations
- App Request Appinstallation
- App List Apps
- App List Appversions
- App List Systemsoftwares
- App List Systemsoftwareversions
- App List Update Candidates For Appversion
- App Replace Database
- App Request Appinstallation Copy
- App Retrieve Status
- App Unlink Database
- App Set Database Users
- Project File System Actions
- Contract Actions
Overview
This node operation, Project File System Get Directories, allows users to list directories and files within a specified project’s file system. It is useful for scenarios where you need to explore or retrieve directory structures programmatically, such as automating file management tasks, generating file inventories, or integrating with other systems that require knowledge of project file layouts.
For example, you might use this node to:
- Retrieve all subdirectories under a specific folder in a project.
- Search for files matching a certain pattern (using glob expressions) within a project directory.
- Limit the depth of directory traversal to avoid overly large results.
- Filter results by type (files or directories), visibility (hidden or not), or executability.
Properties
| Name | Meaning |
|---|---|
| Project Id | ID of the Project to list the directories for. |
| Directory | The directory path to start listing subdirectories from. |
| Name | Search filter for specific filenames only; supports glob expressions for pattern matching. |
| Max Depth | The nesting depth for recursively listing directory contents; 0 means no recursion. |
| Type | Restrict results to items of type "file" or "directory". Can specify multiple types. |
| Executable | Boolean flag to constrain search results to executable files only if true. |
| Hidden | Boolean flag to include hidden files (those starting with a dot) in the search results if true. |
Output
The output JSON contains an array of directory entries matching the query parameters. Each entry typically includes metadata about the file or directory such as its name, path, type, and possibly attributes like executability or hidden status.
If binary data were involved (e.g., file contents), it would be indicated here, but this operation focuses on directory listings and metadata only.
Dependencies
- Requires an API key credential to authenticate against the mittwald mStudio API.
- The node uses the mittwald mStudio API base URL:
https://api.mittwald.de. - No additional external dependencies are required beyond the configured API authentication.
Troubleshooting
- Invalid Project Id: If the provided project ID does not exist or is incorrect, the API will likely return an error indicating the project was not found. Verify the project ID before running.
- Permission Denied: Insufficient permissions or invalid API credentials can cause authorization errors. Ensure the API key has access rights to the project.
- Empty Results: If no directories or files match the criteria (e.g., due to restrictive filters like name patterns or max depth), the output will be empty. Adjust filters accordingly.
- Incorrect Directory Path: Specifying a non-existent directory path may result in errors or empty results. Confirm the directory path exists within the project.
Links and References
- mittwald mStudio API Documentation (official API docs for reference)
- Glob Pattern Syntax (for understanding filename search patterns)