Introduction
In this article, we walk you through importing the FME Flow REST API v4 into Postman.
Postman is very helpful for testing and developing APIs. Now, with FME Flow's REST API in the OpenAPI Specification (OAS), we can easily import the API specification into Postman. This was impossible with v3; REST calls were manually created in Postman for testing.
FME Flow REST API V4 was officially released in FME 2025.1, and V3 has entered deprecation. Users can access V3, but there will be no fixes or additional development. Please note that V3 will no longer be accessible in FME 2026.1, so we encourage all users to upgrade existing endpoints from V3 to V4 as soon as possible. A migration guide is available within the V4 documentation.
Step-by-step Instructions
1. Download FME Flow Rest API JSON
Visit http://<yourFMEFlowHost>/fmeapiv4/docs/index.html and replace <yourFMEFlowHost> with the appropriate hostname.
Locate the hyperlink /fmeapiv4/v3/api-docs
Right-click the hyperlink and select Save Link As. This will download the OAS in JSON format to your local system.
2. Import FME Flow OAS JSON file into Postman
With Postman open, click the Import button.
In the resulting dialog, drag the downloaded JSON file onto the dialog or click on files to select the file to import. Please note that the URL does not work at the moment.
In the Choose how to import your Specification window, select Postman Collection and click the Import button.
Once imported, rename the Collection (if necessary, for example, you have more than one version of FME Flow in your environment). This helps avoid changes to the API versions over time.
You can make use of Postman variables for the {baseURL}, {basicAuthUsername}, and {basicAuthPassword}.