Manage Environments

This guide covers creating, listing, updating, and deleting environments.

List environments

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

Filter parameters

Parameter	Type	Description
text	string	Free-text search
name	string	Filter by name
status	string	ACTIVE or INACTIVE
pinned	boolean	Only pinned environments
stage	string	DEVELOPMENT or PRODUCTION
platformType	string	Filter by platform
apiGateway	UUID	Filter by gateway

Example — list production environments:

curl -X GET "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/environments?stage=PRODUCTION&status=ACTIVE" \
  -H "Authorization: Bearer <your-token>"

Create an environment

curl -X POST "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/environments" \
  -H "Authorization: Bearer <your-token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "production",
    "displayName": "Production",
    "symbol": "PROD",
    "status": "ACTIVE",
    "color": "#28a745",
    "pinned": true,
    "stage": "PRODUCTION",
    "platformType": "BOOMI",
    "agentType": "MANAGED",
    "subscribeAccessMode": "PUBLIC",
    "publishAccessMode": "RESTRICTED"
  }'

Required fields

Field	Type	Description
name	string	Unique technical name
displayName	string	Human-readable name
symbol	string	Short symbol (max 4 chars)
status	string	ACTIVE or INACTIVE
color	string	Color code
pinned	boolean	Pinned in UI
stage	string	DEVELOPMENT or PRODUCTION
platformType	string	Gateway platform
agentType	string	STANDALONE or MANAGED

Get an environment

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

Update an environment

curl -X PUT "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/environments/<environment-id>" \
  -H "Authorization: Bearer <your-token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "production",
    "displayName": "Production (US-East)",
    "symbol": "PROD",
    "status": "ACTIVE",
    "color": "#28a745",
    "pinned": true,
    "stage": "PRODUCTION",
    "platformType": "BOOMI",
    "agentType": "MANAGED"
  }'

Delete an environment

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