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 file transfer endpoints, 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 API with authentication instructions and examples
-
Endpoint Activation - associate user credentials with an endpoint
-
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), and renaming files (rename)
-
Endpoint Management - create, update, and delete endpoint definitions and servers
-
Endpoint Search - find endpoints matching a search query, by display_name and other endpoint fields
-
Endpoint Roles - control which users have different administrator rights or 'roles' on an endpoint
-
Endpoint Bookmarks - list, create, rename, and delete bookmarks for an endpoint and path
-
Endpoint ACL Management - view and modify access rules on endpoints that support an ACL
-
Advanced Endpoint Management - endpoint administrators can monitor and operate on tasks to and from their endpoints
Mailing List
The developer-discuss@globus.org mailing list is the best place to get help using the Transfer API. Announcements about new features and deprecations are also sent to the list, so all users of the API are encouraged to subscribe.