Manage Applications

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

List applications

curl -X GET "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/applications?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
status	string	ACTIVE or INACTIVE
deploymentStatus	string	Filter by deployment status
apiGateway	UUID	Filter by gateway
deployed	boolean	Only deployed applications
includeDeployedOn	boolean	Include deployment details

Create an application

curl -X POST "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/applications" \
  -H "Authorization: Bearer <your-token>" \
  -H "Content-Type: application/json" \
  -d '{
    "displayName": "Mobile Application",
    "status": "ACTIVE"
  }'

Required fields

Field	Type	Description
displayName	string	Human-readable name
status	string	ACTIVE or INACTIVE

Optional fields

Field	Type	Description
description	string	Description (max 1000 chars)
owner	UUID	Owner user ID
oauthCallbackUrl	string	OAuth callback URL
oauthScope	string	OAuth scope

Get an application

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

Update an application

curl -X PUT "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/applications/<application-id>" \
  -H "Authorization: Bearer <your-token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "mobile-app",
    "displayName": "Mobile Application v2"
  }'

Delete an application

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

Application image

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

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

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

Application subscriptions

List all subscriptions for an application:

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