Find the right API
Boomi provides multiple service areas, each designed for a different capability of the Boomi Platform.
If you are not sure where to start, use this guide to identify the service area that best matches your use case.
Whichever service area you choose, you need credentials first. Refer to Authenticating your API.
Quick reference
| If you want to... | Use |
|---|---|
| Automate integration processes and platform resources | Platform APIs |
| Query and mutate data with a single flexible endpoint | GraphQL APIs |
| Manage partner sub-accounts on behalf of your customers | Platform Partner APIs |
| Create, configure, or run AI agents | Agentstudio APIs |
| Manage models and golden records | Data Hub APIs |
| Move and transform data | Data Integration APIs |
| Package and promote assets | Bundles APIs |
| Manage connector resources | Connector APIs |
| Retrieve audit information | Audit Log Staging APIs |
| Subscribe to platform events | Event Notifications APIs |
| Manage managed file transfers | MFT APIs |
When to use an API instead of the user interface
You can do most Boomi work in the Boomi Enterprise Platform user interface. APIs give you a second way in, from your own code. This lets you automate repetitive work, apply the same change across many objects at once, and connect Boomi to the systems you already use.
Use an API when you want to:
- Trigger a process from another system, such as a CI/CD pipeline, a service desk, or your own application
- Repeat an administrative task across many objects, such as deploying one package to every environment in an account
- Pull execution, audit, or account data into your own monitoring and reporting tools
- Provision accounts, users, or environments as part of an automated workflow
Work with integration processes
Use Platform APIs if you want to:
- Automate tasks that you normally perform in the Boomi Enterprise Platform UI
- Create, update, execute, or delete integration processes
- Create and manage platform resources, such as components, connections, environments, Runtimes, and Runtime clusters
- Monitor process executions
- Manage accounts, users, API tokens, and other platform resources
Available API styles
- REST – For most automation and integration scenarios
- GraphQL – For flexible querying and retrieving only the data you need
- SOAP – For compatibility with existing SOAP-based integrations
Work with GraphQL APIs
Use GraphQL APIs if you want to:
- Query and mutate data through a single endpoint, requesting only the fields you need
- Work across multiple service areas without learning a separate REST reference for each one
GraphQL is available for the following service areas. Each links to its own Operations (queries and mutations) and Types reference:
| Service area | Operations | Types |
|---|---|---|
| Platform | Operations | Types |
| Bundles | Operations | Types |
| Event Streams Admin | Operations | Types |
| Event Streams Query | Operations | Types |
| Partner Portal | Operations | Types |
| Agent Control Tower | Operations | Types |
| API Metrics | Operations | Types |
| Catalog Service | Operations | Types |
Manage partner sub-accounts
Use Platform Partner APIs if you want to:
- Manage secondary (sub-) accounts on behalf of your customers
- Create and delete sub-accounts, in addition to standard Platform API operations
- Override the authenticated account to run a request against a specific sub-account
- Cancel executions or provision accounts across the account hierarchy you manage
Work with AI agents
Use Agent Garden APIs if you want to:
- Create, configure, deploy, or manage AI agents
- Manage the tools and sources an agent can use, including installing or uninstalling integration, hub, OpenAPI, prompt, and MCP tools
- Package an agent configuration and deploy it to a target environment
- Invoke an agent session at runtime, including sending file attachments as part of the conversation
Work with golden records
Use Data Hub APIs if you want to:
- Create and manage models, domains, sources, and repositories
- Create, query, and update golden records
- Review and resolve quarantined records
Move and transform data
Use Data Integration APIs if you want to:
- Create, run, and manage data pipelines
- Manage data pipeline connections and environments
- Monitor pipeline runs and retrieve run history
Package and promote assets
Use Bundles APIs if you want to:
- Create and manage bundles
- Promote assets across environments
Work with connectors
Use Connector REST APIs if you want to:
- Create and manage connector resources
- Upload connector archives and versions, and validate connector descriptor files
- Manage connector groups, classifications, and icons
- Submit and manage connector release, version change, version review, and visibility requests
- Create, update, and retrieve connector metadata
Retrieve audit information
Use Audit Log Staging APIs if you want to:
- Retrieve audit events and operational history
- Submit a blob audit log request, check its processing status, and cancel it if needed
Subscribe to platform events
Use Event Notifications APIs if you want to:
- Subscribe to and receive platform event notifications
- Create, update, and delete event subscriptions for your account, including bulk operations
- Retrieve available destination types, event types, and log levels
- Create an Event Streams topic and subscription
Manage managed file transfers
Use MFT APIs if you want to:
- Create and manage Managed File Transfer resources
- Automate Managed File Transfer operations
Still not sure?
If you are trying to automate actions that you normally perform in the Boomi Enterprise Platform user interface, start with Platform APIs.
If you are working with a specific Boomi capability, such as Agent Garden, Data Hub, or Managed File Transfer, choose the corresponding service area for that capability.
Each API overview includes getting started guides, authentication information, and links to the complete API reference. For a single list of all Boomi APIs, refer to View all APIs.
