Migrating data to an external store (Using the API)

A store is a location used to store runtime data from the Boomi Flow platform externally. Having an external data store, outside the realms of where the Flow platform stores your runtime data, gives you even more granular control. For example, you can have the data reside on your favorite cloud, or even on-prem, if you like.

An external data store can be used for specific data residency and compliance requirements, giving you the freedom to decide where your runtime data ultimately resides, based on your unique business needs.

Here is how you can migrate your existing Flow runtime data to an external store:
  1. Click API.

    This opens the in-built Flow API editor.
  2. Copy-paste api/admin/1/stores in the address bar and click GET. The platform responds with a list of data, including endpoint, id, name, and platformKey of the store. If there are multiple stores, you will see the data for all the stores listed in the Response field.
  3. Copy the value in the id field. It will be something like 8a9f0718-80c6-41e1-9581-0d0f3156efa4. If there are multiple stores, select the id of the store you want to migrate the data to.
  4. The migration endpoint is api/admin/1/{id}/migrate. So, for example, if your id is 8a9f0718-80c6-41e1-9581-0d0f3156efa4; your endpoint will be api/admin/1/8a9f0718-80c6-41e1-9581-0d0f3156efa4/migrate. Copy-paste the endpoint with your id in the address bar.
  5. The body of the request will contain batchSize; which stands for how many pieces of runtime data you want to migrate to the external storage service this time around. For example, the request can be {batchSize: 50}.
  6. Click POST.

That’s it! We are all done! Once the migration is complete, you will see a checkbox next to the store under the Global Store column in the Data Stores tab of the drawing tool.

You’ve got mail!

The Flow platform would have sent you an email on the migration – with details on whether the migration has gone through; or not. Every builder associated with the tenant will get this email.

When the migration is successful the email will list the number of flows (and subflows) and a detailed description of the runtime data that was migrated. Going forward, now the external data store will be used along with the Boomi Flow internal runtime data storage to store your runtime data.

If the migration was not successful, you may want to make sure that your external store is working, and try the procedure again. Do you think you could use a bit of support? Please click the Help button on the bottom right-hand corner of this page with your question, and someone from Team Flow will get in touch with you asap.

The migration operation (successful for not), will always associate the store with the tenant and enable it – so it will be used in saving runtime data.

NOTE // 

Wondering what you need to do additionally, if you have flows in production? Nada. Absolutely nothing! The elves of the Flow platform will do all the work! The end-users of your Flow apps will not even realize the backend of their apps have gotten an update!


Check out the glossary for a definition of terms and key concepts that appear in the Boomi Flow website, drawing tool, technical documentation, blogs, and marketing communications.

If you want to take a closer look, click on the images to enlarge them. Have a question? Click the Help button on the bottom right-hand corner of this page to ask.