API Control Plane Management API

The Boomi API Control Plane is a centralized management hub for governing APIs across multiple gateways and platforms. It follows a hub-and-spoke architecture: the Control Plane (SaaS-hosted) serves as the central management layer, while distributed Data Planes — your API gateways — connect through lightweight agents. This enables centralized governance regardless of whether your gateways run in the cloud or on-premises.

The Management API provides programmatic access to the same backend used by the Administration and Developer Portals. Built on API-first principles, every feature available in the UI is also available through this API. This allows you to embed the Control Plane into CI/CD pipelines, workflow systems, and custom scripts — or build entirely custom management experiences.

For the full user documentation covering the UI and configuration guides, see the API Control Plane User Documentation.

Who is this for?

• Platform administrators managing APIs, environments, and users across multiple gateways
• API providers publishing, versioning, and governing APIs
• DevOps engineers automating deployments and integrating API management into CI/CD pipelines
• Developers building custom integrations, subscribing to APIs, and creating consumer applications

Base URL

All API requests are made to your tenant-specific endpoint:

https://<your-subdomain>.backend.<region>.controlplane.boomi.com

Replace <your-subdomain> with your tenant identifier and <region> with your deployment region (e.g., na for North America).

Swagger UI

An interactive API explorer is available at:

https://<your-subdomain>.backend.<region>.controlplane.boomi.com/swagger-ui/index.html

Quick start

Once you have your bearer token, you can start making requests. Here's an example that lists your APIs:

curl -X GET "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/apis" \
  -H "Authorization: Bearer <your-token>" \
  -H "Accept: application/json"

Response:

{
  "content": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "name": "petstore",
      "displayName": "Petstore API",
      "status": "ACTIVE",
      "platformType": "BOOMI",
      "tags": ["pets", "demo"]
    }
  ],
  "size": 10,
  "number": 1,
  "totalPages": 1,
  "totalElements": 1,
  "last": true
}

What's covered

This documentation covers all resources managed through the API:

Section	Description
Authentication	How to obtain and use bearer tokens
Common Patterns	Pagination, errors, filtering, and other conventions
APIs	Create, version, and manage API definitions
API Products	Bundle APIs into products for consumption
Environments	Manage deployment environments
Gateways & Agents	Configure API gateways and agents
Applications	Manage consumer applications
Subscriptions	Manage API subscriptions and approvals
Plans	Define rate-limiting and access plans
Organizations	Manage organizations
Users	User management and roles
Developer Portals	Customize developer portals
Governance	API governance, linting, and scoring
Administration	System configuration, audit logs, and metrics