Web Gateway administration API reference

The WebSphere® MQ Managed File Transfer Web Gateway defines a RESTful HTTP application programming interface (API) for administration of file transfer artifacts.

This reference information describes the API for administering Web Gateway objects such as file spaces. For information on the API for non-administrative tasks, see Web Gateway API reference.

Resource types

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

Filespace
A logical area containing files that have been sent to the user or group associated with that file space.

User
A set of mappings between web user ID and IBM® WebSphere MQ Message Descriptor (MQMD) user ID. These mappings control the MQMD user ID that is used for a file transfer request.

HTTP verbs

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

HTTP verb WebSphere MQ Managed File Transfer operations
POST
  • Create an instance of a file space.
  • Modify the configuration of an existing file space.
  • Create a set of mappings between web user ID and MQMD user ID.
  • Modify or add to the set of mappings between web user ID and MQMD user ID.
GET
  • View the current configuration of a file space. This configuration includes the file space name, the maximum size of the file space and the list of people who are authorized to write to the file space.
  • List all the file spaces that currently exist.
  • View the current set of mappings between web user ID and MQMD user ID.
DELETE
  • Delete an instance of a file space.
  • Delete the set of mappings, or a subset of the mappings, between web user ID and MQMD user ID.