Automatic Runtime Cloud Provisioning APIs

Boomi’s September 2025 release makes it easier than ever to manage runtime clouds. Instead of relying only on the Boomi UI, you can now use new and enhanced APIs to create a cloud, manage its attachments, and adjust quotas directly through scripts or automation.

This means you can streamline cloud provisioning, integrate it into your workflows, and scale faster—whether you’re a partner or running a single cloud or managing a large environment.

Let’s deep dive and see how this can be a game changer for your Boomi integrations.

What’s New?

Before diving into the implementation, let's get acquainted with the new APIs driving these capabilities:

• RuntimeCloud: Create and manage the logical Runtime Cloud.
• AccountCloudAttachmentPropertiesDefault: Provides default properties for cloud attachments on each cloud cluster. Similar to the existing AccountCloudAttachmentProperties API, which manages the quotas for individual attachments.
• AccountCloudAttachmentSummary: Lists the cloud attachments associated with your cloud, useful for monitoring and management.

How to Automate Runtime Cloud Provisioning

Here's an overview of creating a local runtime cloud and adding attachments using scripting and automation methods. Your setup may vary and may require additional configuration.

1. Set up your environment

Ensure you have the necessary permissions and access to the Boomi API. To authenticate your requests, you need your API token and account details.

The examples here use placeholder IDs, such as, {accountId}, {cloudId}, and {runtimeId}. Replace these with your actual values.

2. Create a logical Runtime Cloud

Using the RuntimeCloud API, create a new private Runtime Cloud. This creates the logical cloud in the Boomi platform and returns the new cloudId to use in subsequent API calls.

• Use GET and QUERY APIs to check existing clouds.
• Create cloud with: POST /api/rest/v1/{accountId}/RuntimeCloud/
• Update cloud settings with: POST /api/rest/v1/{accountId}/RuntimeCloud/{cloudId}

Refer to the official Boomi API documentation for supported fields and response schemas.

Sample request

POST /api/rest/v1/{accountId}/RuntimeCloud/

{
  "name": "My Private Cloud 1",
  "allowDeployments": true,
  "allowBrowsing": true,
  "allowTestExecutions": true,
  "maxAttachmentsPerAccount": 1,
  "classification": "PROD"
}

3. Install a cloud cluster for your cloud

Follow the instructions for Unattended runtime installation for runtime clouds using the cloudId from your newly created logical runtime cloud.

• The cloud cluster defines the virtual hardware used to execute processes.
• A runtime cloud may use multiple cloud clusters to distribute work.
• Note the runtimeId of your clusters—you’ll need it later.

You can choose to divide users of your cloud among different clusters if desired.

4. Configure default attachment quotas

Once your cloud cluster is installed, use the AccountCloudAttachmentPropertiesDefault API to set default properties for attachments. Defaults are set per cloud cluster.

Sample request

POST /api/rest/v1/{accountId}/AccountCloudAttachmentPropertiesDefault/{runtimeId}

{
  "containerId": "1b7a821e-2d32-4fa1-bdba-6b7caeaec33d",
  "accountDiskUsage": "429496729600",
  "httpRequestRate": "31313313",
  "as2Workload": "GENERAL",
  "downloadRunnerlogs": "true"
}

Observe the change from cloudId → runtimeId, since this configuration is applied at the cloud cluster level. A complete list of quotas is available in the API documentation.

5. Add attachments to the cloud

Use the Atom API to create new attachments on your cloud. You may add attachments from the cloud owner’s account, or you may choose to share your cloud via an Account Group and allow child accounts to create attachments on your cloud. Here is a sample API call for a user creating an attachment to your cloud using the existing Atom API:

Sample request

POST /api/rest/v1/{accountId}/Atom

{
  "cloudId": "23456789-abcd-ef01-2345-6789abcdef01",
  "name": "My Prod Attachment"
}

6. Check your cloud attachments

Use the AccountCloudAttachmentSummary API to get a list of attachments on your Runtime Cloud. This API provides a quick summary of all of the attachments on your cloud including those created by the cloud owner and attachments created by child accounts to which the cloud has been shared.

By default, the API queries all attachments across all of your runtime clouds in your account. Most often, you will want to filter down the results using Query Filters. A typical use is to limit the results to one particular cloud, though you may also want to query for all attachments created after a certain date, or for all attachments on a particular cloud cluster.

This API returns metadata about your cloud's clusters and attachments based on platform knowledge, regardless of whether those runtimes are currently online or accessible. The first result may represent the cloud cluster itself (its runtimeId matches cloudClusterId).

Sample request (filter to a specific cloud)

POST /api/rest/v1/{{ACCOUNT_ID}}/AccountCloudAttachmentSummary/query

{
  "QueryFilter": {
    "expression": {
      "operator": "and",
      "nestedExpression": [
        {
          "argument": ["23456789-abcd-ef01-2345-6789abcdef01"],
          "operator": "EQUALS",
          "property": "cloudId"
        }
      ]
    }
  }
}

Sample response

{
  "@type": "QueryResult",
  "result": [
    {
      "@type": "AccountCloudAttachmentSummary",
      "runtimeId": "7a3f1b2c-4d5e-6f70-8a9b-c0d1e2f3a4b5",
      "attachmentInstanceId": "jamesq-9TY4MN",
      "attachmentAccountId": "jamesq-9TY4MN",
      "cloudClusterId": "7a3f1b2c-4d5e-6f70-8a9b-c0d1e2f3a4b5",
      "cloudId": "23456789-abcd-ef01-2345-6789abcdef01",
      "attachmentCreationDate": "2025-07-08T18:56:05Z"
    },
    {
      "@type": "AccountCloudAttachmentSummary",
      "runtimeId": "2b1a3c4d-5e6f-7a8b-9c0d-e1f2g3h4i5j6",
      "attachmentInstanceId": "jamesq-9TY4MN.7ACT69",
      "attachmentAccountId": "jamesq-9TY4MN",
      "cloudClusterId": "7a3f1b2c-4d5e-6f70-8a9b-c0d1e2f3a4b5",
      "cloudId": "23456789-abcd-ef01-2345-6789abcdef01",
      "attachmentCreationDate": "2025-07-08T19:29:17Z"
    }
  ],
  "numberOfResults": 2
}

With these updates, you can now completely manage a runtime cloud through API calls—whether you prefer using scripts, writing custom code, or leveraging Boomi integrations with the AtomSphere API or the Partner connector. This makes provisioning and managing runtime clouds faster, simpler, and far more flexible.

Start exploring these APIs and make runtime cloud management a seamless part of your workflow.