Waiting for engine...
Skip to main content

Backing Up and Migrating Agents using Export and Import

Teams building governance tooling on top of Agent Garden dashboards, scorecards, and backup jobs need a reliable way to move an agent's configuration in and out of the platform. export_agent and import_agent give you exactly that. A documented, supported contract for backing up, migrating, or restoring an agent's configuration whenever you need to, without rebuilding it by hand.

Exporting an agent​

Cross-Account Migration​

Best for: Moving a certified agent from one Boomi account into another.

Gives you the ability to:

  • Export once from the source account with export_agent
  • Extract the YAML file from that export and POST it to /agents/import in the target account — always creates a new agent there, without touching anything in the source
  • Repeat the same POST against as many target accounts as needed for a bulk rollout

Example: A Center of Excellence account exports its certified customer-service agent once, then a script extracts the YAML file from that export and POSTs it to /agents/import in each of several regional subsidiary accounts, setting up an identical new agent in every one.

When to pick this path:

  • You're setting up the same agent in accounts you don't have direct build access to
  • Consistency across copies matters more than editing an existing agent in place

Next step: Agents API reference

Completing the Move: Credentials, Packaging, and Retirement​​

Every import creates its tools in a redacted state. An exported agent never carries API keys or OAuth tokens, so whoever owns the new agent has to add credentials to each imported tool before anything runs. Once that's done, package and deploy as usual:

  • create_agent_package to snapshot a deployable version,
  • then create_agent_deployment to push it to an environment and runtime.
warning

Task-level knowledge base and glossary associations don't migrate knowledge_bases and meta_hub_glossaries associations at the task level are dropped during YAML export. They're retained only long enough to populate the export PDF, then stripped before the YAML file is written — import never sees them. A migrated or restored agent silently loses these associations, with no warning at import time. Re-associate any knowledge bases or glossaries manually after import.

Retirement is independent of all of this. When a restored backup turns out to be temporary, or a migrated deployment in one account is no longer needed, delete_agent_deployment removes that one deployment by ID. The agent record and its package history stay intact everywhere.

Next Steps​​

  1. Backing up or restoring a single agent? Refer to export_agent and import_agent in the Agents API reference.

  2. Migrating to another account? Use the same two endpoints with the cross-account pattern above.

  3. Ready to go live? Refer to create_agent_package and create_agent_deployment in the Agents API reference.

  4. Retiring a deployment? Refer to delete_agent_deployment in the Agents API reference.

On this Page