Skip to main content

Discovery & Deployment

Discovery is the fastest way to establish the Control Plane as the single point of truth for your API landscape. Instead of manually registering every API, you can scan connected gateways to automatically find APIs that already exist on them. The discovery process reads the gateway's configuration, identifies APIs that are not yet tracked in the Control Plane, and lets you import them — complete with their specifications, endpoints, and metadata.

Deployment is the reverse operation: pushing API configurations from the Control Plane down to the gateways. When you deploy an API, API Product, or subscription to an environment, the Control Plane communicates with the connected agent to configure the gateway accordingly. Deployments are asynchronous — the status transitions from DEPLOYMENT_IN_PROGRESS to either DEPLOYED or DEPLOYMENT_FAILED.

API Discovery​

Discover APIs that exist on a connected gateway but haven't been registered in the Control Plane yet. Discovery requires an active agent connection on the target environment.

Trigger discovery​

curl -X POST "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/discovery" \
  -H "Authorization: Bearer <your-token>" \
  -H "Content-Type: application/json" \
  -d '{
    "environment": "<environment-id>"
  }'

Get discovery results​

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

Deployment management​

List deployed APIs in an environment​

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

Deploy an API​

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

Undeploy an API​

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

List deployed API Products​

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

Deploy an API Product​

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

Undeploy an API Product​

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

List deployed subscriptions​

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

Environment details​

Get extended details about an environment including gateway connection status:

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