Skip to main content

API Product Deployment

Deploy API Products to environments to make them available for subscriptions.

Deploy a product to an environment​

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

This is an asynchronous operation. The product's deploymentStatus will transition through DEPLOYMENT_IN_PROGRESS to DEPLOYED or DEPLOYMENT_FAILED.

List deployed products in an environment​

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

Undeploy a product from an environment​

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

Check deployment status​

List products with deployment details:

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

The response includes a deployedOn array showing which environments the product is deployed to, and the deploymentStatus field.