Manage API Products

This guide covers creating, listing, updating, and deleting API Products.

List API Products

curl -X GET "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/apiProducts?page=1&size=10" \
  -H "Authorization: Bearer <your-token>"

Filter parameters

Parameter	Type	Description
text	string	Free-text search
displayName	string	Filter by display name
owner	UUID	Filter by owner
environment	UUID	Filter by deployment environment
tags	string[]	Filter by tags
deployed	boolean	Only deployed products
api	UUID	Filter by contained API
platformType	string	Filter by platform
plan	UUID	Filter by assigned plan
visibility	string	PUBLIC or RESTRICTED
published	string	PUBLISHED or UNPUBLISHED
selfServiceSubscriptionAllowed	boolean	Filter by self-service status
mcpStatus	string	ENABLED or DISABLED
includeDeployedOn	boolean	Include deployment details

Example — find published products with self-service subscriptions:

curl -X GET "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/apiProducts?published=PUBLISHED&selfServiceSubscriptionAllowed=true" \
  -H "Authorization: Bearer <your-token>"

Create an API Product

curl -X POST "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/apiProducts" \
  -H "Authorization: Bearer <your-token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "petstore-product",
    "displayName": "Petstore Product",
    "description": "Access to the Petstore API",
    "visibility": "PUBLIC",
    "published": true,
    "allowSelfServiceSubscription": true,
    "mcpStatus": "DISABLED",
    "tags": ["pets"]
  }'

Required fields

Field	Type	Description
name	string	Unique technical name
displayName	string	Human-readable name
visibility	string	PUBLIC or RESTRICTED
published	boolean	Published status
allowSelfServiceSubscription	boolean	Self-service flag
mcpStatus	string	ENABLED or DISABLED
tags	string[]	Tags (can be empty)

Get an API Product

curl -X GET "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/apiProducts/<product-id>" \
  -H "Authorization: Bearer <your-token>"

Update an API Product

curl -X PUT "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/apiProducts/<product-id>" \
  -H "Authorization: Bearer <your-token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "petstore-product",
    "displayName": "Petstore Premium",
    "description": "Premium access to the Petstore API",
    "visibility": "PUBLIC",
    "published": true,
    "allowSelfServiceSubscription": false,
    "mcpStatus": "DISABLED",
    "tags": ["pets", "premium"]
  }'

Delete an API Product

curl -X DELETE "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/apiProducts/<product-id>" \
  -H "Authorization: Bearer <your-token>"

Add an API to a Product

curl -X PUT "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/apiProducts/<product-id>/apis/<api-id>" \
  -H "Authorization: Bearer <your-token>"

Remove an API from a Product

curl -X DELETE "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/apiProducts/<product-id>/apis/<api-id>" \
  -H "Authorization: Bearer <your-token>"

List APIs in a Product

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

Manage Product image

# Upload
curl -X PUT "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/apiProducts/<product-id>/image" \
  -H "Authorization: Bearer <your-token>" \
  -F "file=@product-logo.png"

# Download
curl -X GET "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/apiProducts/<product-id>/image" \
  -H "Authorization: Bearer <your-token>" --output product-logo.png

# Delete
curl -X DELETE "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/apiProducts/<product-id>/image" \
  -H "Authorization: Bearer <your-token>"