Skip to main content

Portal Customization

Customize the appearance and branding of your developer portal.

Get portal properties​

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

Update portal properties​

curl -X PUT "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/devPortals/<portal-id>/properties" \
  -H "Authorization: Bearer <your-token>" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Acme Developer Portal",
    "description": "Access our APIs and build great integrations"
  }'

Portal images​

Developer portals support multiple image types for branding.

Upload banner image​

curl -X PUT "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/devPortals/<portal-id>/bannerImage" \
  -H "Authorization: Bearer <your-token>" \
  -F "file=@banner.png"

Upload favicon​

curl -X PUT "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/devPortals/<portal-id>/favicon" \
  -H "Authorization: Bearer <your-token>" \
  -F "file=@favicon.ico"

Download images​

# Banner
curl -X GET "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/devPortals/<portal-id>/bannerImage" \
  -H "Authorization: Bearer <your-token>" --output banner.png

# Favicon
curl -X GET "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/devPortals/<portal-id>/favicon" \
  -H "Authorization: Bearer <your-token>" --output favicon.ico

Assign API Products to a portal​

Add a product to the portal​

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

Remove a product from the portal​

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

List products in the portal​

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