Skip to main content

Files list task

Task type: dphi.space.cg2.files.list

Purpose​

List files in a remote folder and return a structured file tree.

Definition​

  - id: list_files
    type: dphi.space.cg2.files.list
    description: List files onboard
    folder: /
    volume: payload
    depth: 2

Inputs​

  • id: Name of the task.
  • description: Description of the task.
  • folder: Target folder inside the selected volume. Requires volume.
  • depth: Max depth to include (defaults to 2).
  • volume: Optional volume name to resolve the remote base path. If both volume and folder are omitted, the task scans the tenant root. If folder is provided, volume is required.

Outputs​

  • files: Parsed file tree data.
  • uri: Location of the downlinked archive.
  • contentType: Archive MIME type.
  • contentLength: Archive size in bytes.

Common failure reasons​

  • Target folder is invalid.
  • folder is provided without volume.
  • Downlink archive is missing or malformed.