MFT REST Calls

MFT supports REST calls for the most common administrative functions.

API Specification Files And Schema Used For REST Calls

The REST OpenAPI specification files located in MFT-Install/server/webapps/cfcc/public/docs are as follows:
  • admin.json - The JSON schema is used for all Admin REST calls supported by Command Center, and Internet Server when the Admin service is enabled.
  • ft.json - The JSON schema is used for only File Transfer REST calls. These calls are only supported on Internet Server.
Note: These OpenAPI specification files can be imported in Postman, TIBCO ActiveMatrix BusinessWorks™ 6.4, and Swagger UI. For information on how to configure and execute the REST calls, see TIBCO ActiveMatrix BusinessWorks™ REST Reference.

Before you use the JSON schemas, update the following line in the JSON files:

"host" : "localhost:7443",

"localhost" must be changed to the host name of the Internet Server where the calls are executed.

"7443" must be changed to the HTTP or HTTPS port of the Internet Server where the calls are executed.

Redoc Used for API Documentation

MFT uses Redoc for API documentation.

Documentation for Command Center and Internet Server Administrative (Admin) REST calls can be accessed with the following URLs respectively:
  • https://localhost:8443/cfcc/public/docs/redoc.html
  • https://localhost:7443/cfcc/public/docs/redoc.html
Documentation for the Internet Server File Transfer (FT) REST calls can be accessed with the following URL:
  • https://localhost:7443/cfcc/public/docs/redoc_ft.html
Note: Internet Server supports Admin (if Admin server is enabled) and FT REST calls. Admin REST calls are only available when the Admin service is installed on the Internet Server instance.