Skip to main content

API Gateways

Register and manage API gateway instances that the Control Plane deploys to.

List API gateways​

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

Create an API gateway​

curl -X POST "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/apiGateways" \
  -H "Authorization: Bearer <your-token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "kong-production",
    "displayName": "Kong Production Gateway",
    "platformType": "KONG"
  }'

Get an API gateway​

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

Update an API gateway​

curl -X PUT "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/apiGateways/<gateway-id>" \
  -H "Authorization: Bearer <your-token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "kong-production",
    "displayName": "Kong Production Gateway (Updated)",
    "platformType": "KONG"
  }'

Delete an API gateway​

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