Skip to main content

API Versions

Each API can have multiple versions, allowing you to manage different iterations of your API specification simultaneously.

List versions for an API​

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

Response:

{
  "content": [
    {
      "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "name": "1.0.0",
      "displayName": "Version 1.0.0",
      "status": "ACTIVE",
      "api": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    }
  ],
  "size": 10,
  "number": 1,
  "totalPages": 1,
  "totalElements": 1,
  "last": true
}

Create a version​

curl -X POST "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/apis/<api-id>/versions" \
  -H "Authorization: Bearer <your-token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "2.0.0",
    "displayName": "Version 2.0.0",
    "status": "ACTIVE"
  }'

Get a version​

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

Update a version​

curl -X PUT "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/apis/<api-id>/versions/<version-id>" \
  -H "Authorization: Bearer <your-token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "2.0.0",
    "displayName": "Version 2.0.0 (Stable)",
    "status": "ACTIVE"
  }'

Delete a version​

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

Response: 204 No Content