Search

Getting Started with the FME Flow REST API

Sienna Emery
Sienna Emery
  • Updated

Introduction

This tutorial series walks you through what the FME Flow REST API is, how to access it, and how to use it in FME Workbench. A REST API allows users to interact with the server by creating requests and receiving responses. This allows users to interact with FME Flow programmatically and without using the FME Flow user interface.

As of FME Flow 2025.1, the V3 REST API has been deprecated. The current API will remain accessible, but no new features or general bug fixes will be implemented. Starting with FME Flow 2026.1, the V3 API will be removed. We encourage all users to prepare their systems for this change. 

The V4 REST API offers enhanced security and usability, including new and reorganized endpoints, as well as the removal of certain endpoints. For information on migrating from V3 to V4, please see the FME Flow REST API V4 documentation and click on the heading Migrating from REST API V4.
 

Articles

It is recommended that you work through the following articles in order. 

Tips for Working With the FME Flow REST API in FME Workbench

In this article, you will find our REST API documentation and some useful transformers that you may consider including in your workspace when working with the FME Flow REST API.

Authorization in the FME Flow REST API | Token Management

This article shows you how to authenticate FME Flow REST API calls by creating a token that can be used to authenticate a request.

Submitting a Job through the FME Flow REST API

This article explains how to submit a job via the FME Flow REST API from a third-party application.

Using the FME Flow REST API to Create Job History Reports

This article describes how to use the FME Flow REST API in a workspace to create job history reports.

Monitoring FME Flow Job Activity using the REST API

This article will demonstrate how to use the REST API to retrieve these statistics and build a visual report that can be displayed in FME Flow Dashboards to help monitor FME Flow activity, performance, or usage over time.
 

Additional Resources

 

 

Was this article helpful?

We're sorry to hear that.

Please tell us why.

As of January 14th, 2026, comments on knowledge base articles have been closed. To make sure questions don’t get missed and to enable more community support, we’ve moved discussions to the FME Community. If you have a question or a comment about this article, please create a new post or create a support ticket.