Skip to main content

Manage Open Proxies

The Open Proxy Specification is an openly available standard that provides a universal, technology-agnostic way to describe API proxies. It enables API publishers to create and update proxies on different gateways without requiring deep knowledge of each gateway's specific implementation.

When combined with consumer-centric standards like OpenAPI, AsyncAPI, or GraphQL Schema, the Open Proxy Specification provides a complete description of both the proxy configuration and the API contract. You can upload Open Proxy specs directly, import them from Git repositories, or use the analysis endpoints to inspect what an Open Proxy spec would create before committing.

List open proxies​

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

Create an open proxy​

curl -X POST "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/openProxies" \
  -H "Authorization: Bearer <your-token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "external-api-proxy",
    "displayName": "External API Proxy"
  }'

Get an open proxy​

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

Update an open proxy​

curl -X PUT "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/openProxies/<proxy-id>" \
  -H "Authorization: Bearer <your-token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "external-api-proxy",
    "displayName": "External API Proxy (Updated)"
  }'

Delete an open proxy​

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

Analyze an open proxy specification​

Analyze a specification for creating an open proxy:

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

Create from specification​

Create an API from an open proxy specification:

curl -X POST "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/openProxies/<proxy-id>/createApi" \
  -H "Authorization: Bearer <your-token>"

Git integration​

Open proxies can also sync from Git repositories:

curl -X POST "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/openProxies/analyzeGitRepo" \
  -H "Authorization: Bearer <your-token>" \
  -H "Content-Type: application/json" \
  -d '{
    "gitUrl": "git@github.com:your-org/api-specs.git",
    "gitCredential": "<credential-id>"
  }'