Skip to main content
Released

More FMERest api calls documented

Related products:FME Flow
  • July 25, 2018
  • 19 replies
  • 226 views

todd_davis
Influencer
Forum|alt.badge.img+23

FME Server has a good range of Rest api calls but they aren't all documented. For instance, named connections are avaliable by fmerest/v3/namedconnections/webservices, version control push by

/fmerest/v3/versioncontrol/remote/push. It would be great if more of these calls could be documented

19 replies

Forum|alt.badge.img+1

yes please - this would be particularly useful for supporting customers


nic_ran
Contributor
Forum|alt.badge.img+16
  • Contributor
  • April 14, 2020

Understanding that some API calls are undocumented for the reason that they are liable to change in subsequent releases, perhaps those "unstable" calls could be hidden by default and only exposed with explicit selection of a checkbox similar to the "Hide Advanced Calls" checkbox on the current API documentation. Maybe something like "Show Beta Functionality", with appropriate warnings beside each such call in the documentation.


Forum|alt.badge.img+2

rylanatsafe
Safer
Forum|alt.badge.img+14
  • Safer
  • October 16, 2020

Thank you to everyone who has voted and commented on this! We have marked this idea as 'Under Consideration' because we have started work on the next iteration–Version 4–of the FME Server REST API.

 

Currently, we plan to have V4 as "Technical Preview" for 2021 and we expect that it will be a full release cycle until it takes place of the V3 REST API (i.e. FME Server 2022). Expect more details to come (e.g. migration guide) as development progresses.

 

We have made note of the requests in this idea description and those in the comments. Any major updates or decisions related to those requests will be posted here.


david_r
Celebrity
  • June 13, 2023

Hi @rylanatsafe​, any news on the availability of v4 and the API for named connections in particular? Ideally, we would like to leverage the API to create and maintain database connections in an automated manner. Use case: update database connections programmatically to point at different staging or test servers. This includes modifying the password.


rylanatsafe
Safer
Forum|alt.badge.img+14

@david_r​ the V4 API endpoints for web and database connection management will be in progress soon.

Updating parameters, such as the db connection password, should be in scope for this work.


LizAtSafe
Safer
Forum|alt.badge.img+18
  • Safer
  • February 10, 2024
The following idea has been merged into this idea:

All the votes have been transferred into this idea.

LizAtSafe
Safer
Forum|alt.badge.img+18
  • Safer
  • February 10, 2024
The following idea has been merged into this idea:

All the votes have been transferred into this idea.

LizAtSafe
Safer
Forum|alt.badge.img+18
  • Safer
  • October 31, 2024
ArchivedIn Development

LizAtSafe
Safer
Forum|alt.badge.img+18
  • Safer
  • October 31, 2024
ArchivedIn Development

LizAtSafe
Safer
Forum|alt.badge.img+18
  • Safer
  • April 5, 2025
The following idea has been merged into this idea:

All the votes have been transferred into this idea.

LizAtSafe
Safer
Forum|alt.badge.img+18
  • Safer
  • April 5, 2025
The following idea has been merged into this idea:

All the votes have been transferred into this idea.

LizAtSafe
Safer
Forum|alt.badge.img+18
  • Safer
  • July 8, 2025
In DevelopmentReleased

rylanatsafe
Safer
Forum|alt.badge.img+14

I am happy to say that the FME Flow V4 API is finally released with 2025.1—it was a long time in the making! A huge thank you to everyone who tested it, submitted improvement ideas, and shared your unique use cases.

Some areas of Flow still do not have exposed API endpoints—many of which were also missing in the V3 API. We're actively working on foundational infrastructure changes and want to avoid breaking backwards compatibility in the V4 API. We appreciate your patience as we continue this work (which is underway today).

The V3 API is scheduled to be removed in FME 2026.1. If you haven’t started yet, now’s a great time to begin migrating to V4. We’ve provided a migration guide (available in your FME Flow 2025.1 deployment at <hostname>/fmeapiv4/docs/index.html) to help. If the guide doesn’t answer all your questions, our support team is here to help!

 


nordpil
Supporter
Forum|alt.badge.img+12
  • Supporter
  • July 10, 2025

@rylanatsafe How much has changed in v4 api since e.g. 2022 versions? We have been avoiding even playing with it in our FME Server 2022 which carries the notice This REST API is still under active development, so please expect changes to the current behavior. We do not recommend using the FME Server REST API V4 in production environments.

Also - let’s say I am in the middle of developing an application that should be compatible with any version 2022+ - then that has to be v3 up until 2025, and it can’t be v3 only to be futureproof for 2026… Or can it be v4 all the way… ?


rylanatsafe
Safer
Forum|alt.badge.img+14
  • Safer
  • July 22, 2025

@nordpil the changes since 2022 are quite significant. The stability of endpoint groups started to improve throughout the 2024.x releases into the 2025.0 release—we were very close to removing tech preview for FME Flow 2025.0 but opted for additional testing and refinement.

If you’d like to send me an email (rylan.maschak at safe.com) detailing the endpoint groups (e.g. /jobs) or specific endpoints, I could look further into the specifics, but generally speaking, not until 2025.1 is it recommended to begin building workflows solely with the V4 API.


j.botterill
Influencer
Forum|alt.badge.img+55
  • Influencer
  • July 23, 2025

regarding this Migration plan document, available in your FME Flow 2025.1 deployment at <hostname>/fmeapiv4/docs/index.html) for help

I queried AI assist and it provided some really good tips, but it hasn’t picked up on the fmeapiv4/docs

FYI

 


nordpil
Supporter
Forum|alt.badge.img+12
  • Supporter
  • July 28, 2025

@rylanatsafe Thanks for the information, I’ll just hold off looking at v4 until we are on Flow 2025 then!


rylanatsafe
Safer
Forum|alt.badge.img+14
  • Safer
  • July 29, 2025

@j.botterill thank you for noting that to us! We will need to remedy that soon. Great catch.