Transfer API Documentation
This API provides a REST-style interface to the Globus reliable file transfer service. The Transfer API supports monitoring the progress of a user’s file transfer tasks, managing globus connect personal collections, listing remote directories, and submitting new transfer and delete tasks. The API is ideal for integration into Portals or Gateways to provide complex reliable file transfer capabilities without having to develop and support these features on your own. It is also easy to use for scripting, using any standard HTTPS or REST client library in scripting languages like Python and Ruby.
Contents
-
API Overview - overview of the Transfer API with information on how to make requests to the service
-
Task Submission - submit transfer and delete tasks
-
Task Management - monitor and cancel background transfer and delete tasks
-
File Operations - foreground filesystem operations, including directory listing (ls), creating directories (mkdir), renaming files (rename), and retrieving status information (stat)
-
Endpoints and Collections - information on Transfer endpoint and collection definitions and operations for getting information about them
-
Endpoint and Collection Search - find endpoints and collections matching a search query
-
Globus Connect Personal Management - create, update, and delete Globus Connect Personal collection definitions
-
Roles - information on Transfer roles and operations for managing them on Globus Connect Personal collections.
-
Collection Bookmarks - list, create, rename, and delete bookmarks for a collection and path
-
Guest Collection Permission Management - view and modify permissions on guest collections
-
Advanced Collection Management - users with effective roles on collections can monitor and operate on tasks on those collections
-
Task Behavior - information on how asynchronous tasks behave after submission
Globus SDK
The Globus SDK can serve as a useful tool for python developers making Transfer API requests or as an example client for developers working in other languages.
The TransferClient class in particular provides helper methods for most Transfer API resources.