Flows API Menu
  • Globus Flows
  • Globus Automation Overview
  • Authoring Flows
  • Flows Permissions
  • Hosted Action Providers
    • Hello World Action Provider
    • Action Provider: Transfer - Transfer Task
    • Action Provider: Transfer - Delete Task
    • Action Provider: Transfer - Set Permission
    • Action Provider: Transfer - List Directory Contents
    • Action Provider: Transfer - Make Directory
    • Action Provider: Transfer - Get Collection Information
    • Action Provider: Search - Ingest Task
    • Action Provider: Search - Delete Task
    • Action Provider: Send Notification Email
    • Action Provider: Wait For User Selection
    • Action Provider: Expression Evaluation
    • Action Provider: Datacite Mint
Skip to main content
Globus Docs
  • APIs
    Auth Flows Groups Search Transfer Python SDK Helper Pages
  • How To
  • Guides
    Globus Connect Server High Assurance Collections for Protected Data Command Line Interface Premium Storage Connectors Security Modern Research Data Portal
  • Support
    FAQs Mailing Lists Contact Us Check Support Tickets
  1. Home
  2. Globus APIs
  3. Globus Flows
  4. Hosted Action Providers

Action Provider: Transfer - List Directory Contents

URL: https://actions.globus.org/transfer/ls

Scope: https://auth.globus.org/scopes/5fac2e64-c734-4e6b-90ea-ff12ddbf9653/transfer_ls

Synchronous / Asynchronous: Synchronous

The Globus Transfer - List Directory action provider uses the `Globus Transfer Directory API to retrieve a listing of contents from an (endpoint, path) pair. Although providing a path is optional, the default path used depends on endpoint type, and it is best to explicitly set a path. This Action Provider supports all options as defined in the List Directory Contents Transfer API documentation.

Additionally, it adds two features not found in the base Globus Transfer List Directory operation.

  1. An input Boolean parameter path_only may be specified which indicates that regardless of the file type of the path, we only will return information about the path itself. This changes the behavior when the path references a folder. Rather than returning the contents of the folder, this will return information about the folder itself. Thus, when this option is present, the output will contain only one file entry.

  2. For each file entry returned, an additional property, is_folder, is included. This is set to true if the file type is folder. This can be helpful, particularly within Flows, to perform branching or other logic dependent on whether a path points to a folder or a regular file.

  • Globus Flows
  • Globus Automation Overview
  • Authoring Flows
  • Flows Permissions
  • Hosted Action Providers
    • Hello World Action Provider
    • Action Provider: Transfer - Transfer Task
    • Action Provider: Transfer - Delete Task
    • Action Provider: Transfer - Set Permission
    • Action Provider: Transfer - List Directory Contents
    • Action Provider: Transfer - Make Directory
    • Action Provider: Transfer - Get Collection Information
    • Action Provider: Search - Ingest Task
    • Action Provider: Search - Delete Task
    • Action Provider: Send Notification Email
    • Action Provider: Wait For User Selection
    • Action Provider: Expression Evaluation
    • Action Provider: Datacite Mint
© 2010- The University of Chicago Legal Privacy Accessibility