Skip to main content

API Specifications

API specifications (OpenAPI/Swagger) can be attached to API versions. You can upload specs directly or sync them from Git repositories.

Get the specification for a version​

curl -X GET "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/apis/<api-id>/versions/<version-id>/spec" \
  -H "Authorization: Bearer <your-token>"

This returns the raw specification file content.

Upload a specification​

curl -X PUT "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/apis/<api-id>/versions/<version-id>/spec" \
  -H "Authorization: Bearer <your-token>" \
  -H "Content-Type: application/json" \
  -d @openapi-spec.json

You can also upload a YAML specification:

curl -X PUT "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/apis/<api-id>/versions/<version-id>/spec" \
  -H "Authorization: Bearer <your-token>" \
  -H "Content-Type: application/x-yaml" \
  --data-binary @openapi-spec.yaml

Delete a specification​

curl -X DELETE "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/apis/<api-id>/versions/<version-id>/spec" \
  -H "Authorization: Bearer <your-token>"

Get version and specification together​

To retrieve both the version metadata and its specification in a single call:

curl -X GET "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/apis/<api-id>/versions/<version-id>/versionAndSpec" \
  -H "Authorization: Bearer <your-token>"

Import an API from a specification​

You can create a new API directly from a specification file:

curl -X POST "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/apis/import" \
  -H "Authorization: Bearer <your-token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "imported-api",
    "displayName": "Imported API",
    "spec": "<base64-encoded-spec-or-spec-content>"
  }'

Export an API​

Export an API with its specification:

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