Migrating legacy agents
Last updated
Was this helpful?
Last updated
Was this helpful?
This is the official documentation of the @forestadmin/agent Node.js agent.
You may want to migrate from a legacy agent to this new agent. This guide will help you do so.
The new agent is built with a different architecture and breaks API retro compatibility with the legacy agents in many ways. However, as this new agent provides a more efficient API to let builders focus on their operational needs, we encourage you to migrate to speed up your future admin panel evolutions.
You are using a legacy agent if you are using either the or the packages.
Legacy agents are still supported and will continue to be for a while.
No end-of-life date has been set yet for customers using the latest major version of the legacy agents.
To give more visibility to our developers' community, about agent usability and support in the future, you will find the important lifecycle dates per agent stack and versions.
The new agent brings a lot of new features, but a small subset of what was available in the legacy agents is not yet there.
allowed customizing the behavior of the routes exposed by the agent.
Because our new agent API is higher-level, the protocol used to communicate between the agent and the application can no longer be manipulated.
All use cases that we have seen so far can be implemented using the new system, but because the former system was lower-level, we cannot guarantee it.
A specific is available for this feature.
allowed the creation of charts from SQL queries from the UI.
You will need to follow the specific to convert Live query charts into API charts.
allowed the creation of segments from SQL queries from the UI.
You will need to convert SQL Query segments into .
