Web Gateway API reference

The WebSphere® MQ Managed File Transfer Web Gateway defines a RESTful HTTP application programming interface (API) for creating transfers, downloading files from file spaces and viewing the status of submitted transfers using HTTP requests and responses.

This reference topic describes the API for user actions. For administrative actions such as creating and deleting file spaces, see Web Gateway administration API reference.

Resource types

The following WebSphere MQ Managed File Transfer object types are supported by this specification:

File: A file transferred to or from a WebSphere MQ Managed File Transfer agent.
Filespace: A logical area containing files that have been sent to the user or group associated with that file space.
Transfer: An instance of a WebSphere MQ Managed File Transfer transfer.

HTTP verbs

The HTTP verbs in the following table are supported by this specification.

HTTP verb	WebSphere MQ Managed File Transfer operations
POST	Upload a file or files to a destination agent
GET	Retrieve the status of a previous transfer Retrieve a list of files in a file space Download a file from a file space
DELETE	Delete, and optionally download, a file from a file space