RuntimeCloud object

The RuntimeCloud object lets you create, query, update, and delete private runtime clouds.

Required privilege: You must have Cloud Management privilege to use the RuntimeCloud API.

Structure

<RuntimeCloud>
  <id/>
  <name/>
  <classification/>
  <allowDeployments/>
  <allowBrowsing/>
  <allowTestExecutions/>
  <maxAttachmentsPerAccount/>
  <createdBy/>
  <createdDate/>
  <modifiedBy/>
  <modifiedDate/>
</RuntimeCloud>

Field	Type	Description
`id`	string	Read-Only. System-generated unique identifier of private runtime cloud.
`name`	string	Name of the private runtime cloud. Required for creating a private runtime cloud. The maximum length must be 255 characters.
`classification`	enum	Specifies the environment, either Production or Test. Required for creating a private runtime cloud. Allowed values: PROD or TEST You can set classification only when you create a private runtime cloud and cannot change it later. You can assign the value TEST if the requesting account has Test Connection Licensing enabled.
`allowDeployments`	boolean	If specified, processes and deployable components are deployed to this private runtime cloud. This feature is not applicable to Integration Packs.
`allowBrowsing`	boolean	If specified, connector operations can use this private runtime cloud to browse and import objects. This property works with the Allow Browsing property that is set in the Cloud Properties dialog. For more information, refer to Cloud Properties.
`allowTestExecutions`	boolean	If specified, process executions on a private runtime cloud run in Test mode.
`maxAttachmentsPerAccount`	integer	Sets the number of basic runtimes that each account can set up in a specified private runtime cloud. The default value is 1 (The account that owns the private runtime cloud can set up as many basic runtimes as needed), and the minimum value is -1.
`createdBy`	string	Read-only and system-generated. The user who created the private runtime cloud.
`createdDate`	dateTime (yyyy-MM-dd'T'HH:mm:ss'Z')	Read-only and system-generated. The date and time the private runtime cloud was created.
`modifiedBy`	string	Read-only and system-generated. The user who last modified the private runtime cloud
`modifiedDate`	dateTime (yyyy-MM-dd'T'HH:mm:ss'Z')	Read-only and system-generated. The date and time the private runtime cloud was last modified.

Supported operations

GET	QUERY	CREATE	UPDATE	EXECUTE	DELETE

CREATE operation

Creates a private runtime cloud in the specified (TEST or PROD) environment.

Request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.platform.boomi.com/">
   <soapenv:Header>
      <wsse:Security
       xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
        <wsse:UsernameToken wsu:Id="UsernameToken" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
          <wsse:Username>BOOMI_USER_NAME</wsse:Username>
          <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">BOOMI_PASSWORD</wsse:Password>
        </wsse:UsernameToken>
      </wsse:Security>
   </soapenv:Header>
   <soapenv:Body>
      <api:create>
          <object xsi:type="api:RuntimeCloud" id="59f78b7d-73bb-4b86-81f6-1b08c9205c2f" name="My Private Cloud 1" classification="PROD" allowDeployments="true" allowBrowsing="true" allowTestExecutions="true" maxAttachmentsPerAccount="1"
             xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/> 
      </api:create>
   </soapenv:Body>
</soapenv:Envelope>

Response:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <bns:createResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bns="http://api.platform.boomi.com/">
            <result xsi:type="bns:RuntimeCloud" id="59f78b7d-73bb-4b86-81f6-1b08c9205c2f" name="My Private Cloud 1" classification="PROD" allowDeployments="true" allowBrowsing="true" allowTestExecutions="true" maxAttachmentsPerAccount="1" modifiedDate="2025-06-12T06:14:01Z" createdDate="2025-06-12T06:14:01Z" createdBy="testUser@boomi.com" modifiedBy="testUser@boomi.com"/>
        </bns:createResponse>
   </S:Body>
</S:Envelope>

GET operation

Retrieves the properties of a private runtime cloud with a specific ID. The createdBy,createdDate, modifiedBy, and modifiedDate fields return in a successful response for private runtime clouds created after July 12, 2025. If you update any existing private runtime cloud, then only modifiedBy and modifiedDate are returned in the Get response.

Request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.platform.boomi.com/">

  <soapenv:Header>
     <wsse:Security
      xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
       <wsse:UsernameToken wsu:Id="UsernameToken" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
         <wsse:Username>BOOMI_USER_NAME</wsse:Username>
         <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">BOOMI_PASSWORD</wsse:Password>
       </wsse:UsernameToken>
     </wsse:Security>
  </soapenv:Header>
  <soapenv:Body>
     <api:get>
        <api:objectType>RuntimeCloud</api:objectType>
        <api:objectId>9584bd2b-8b82-4b10-afbf-7f801ed3b854</api:objectId>
     </api:get>
  </soapenv:Body>
</soapenv:Envelope>

Response:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Body>
        <bns:getResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bns="http://api.platform.boomi.com/">
            <bns:result xsi:type="bns:RuntimeCloud" id="9584bd2b-8b82-4b10-afbf-7f801ed3b854" name="Private Cloud 2" classification="PROD" allowDeployments="true" allowBrowsing="true" allowTestExecutions="true" maxAttachmentsPerAccount="0" modifiedDate="2025-05-27T18:32:50Z" createdDate="2025-05-27T18:32:50Z" createdBy="testUser@boomi.com.com" modifiedBy="testUser@boomi.com"/>
        </bns:getResponse>
    </S:Body>
</S:Envelope>

UPDATE operation:

Updates the private runtime clouds.

If you update the private runtime cloud created before July 12, 2025, when retrieving its details, modifiedBy and modifiedDate fields only return in the responses of Get Query, or QueryMore operations.
The id is a required field for updating a private runtime cloud. If you do not specify other fields in the Update operation, the values remain unchanged.

Request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.platform.boomi.com/">
   <soapenv:Header>
      <wsse:Security
       xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
        <wsse:UsernameToken wsu:Id="UsernameToken" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
          <wsse:Username>BOOMI_USER_NAME</wsse:Username>
          <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">BOOMI_PASSWORD</wsse:Password>
        </wsse:UsernameToken>
      </wsse:Security>
   </soapenv:Header>
   <soapenv:Body>
      <api:update>
          <object xsi:type="api:RuntimeCloud"
              id="ec05ec96-5e5b-46dd-9797-721f2f83da3e"
              name="runtime cloud test"
              classification="PROD"
              allowDeployments="true"
              allowBrowsing="true"
              allowTestExecutions="false"
              maxAttachmentsPerAccount="1"
              xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/> 
      </api:update>
   </soapenv:Body>
</soapenv:Envelope>

Response:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Body>
        <bns:updateResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bns="http://api.platform.boomi.com/">
            <result xsi:type="bns:RuntimeCloud" id="ec05ec96-5e5b-46dd-9797-721f2f83da3e" 
            name="runtime cloud test" 
            classification="PROD" 
            allowDeployments="true" 
            allowBrowsing="true" 
            allowTestExecutions="false" 
            maxAttachmentsPerAccount="1" modifiedDate="2025-06-12T06:24:18Z" createdDate="2025-06-10T01:47:16Z" 
            createdBy="testUser@boomi.com" 
            modifiedBy="testUser@boomi.com"/>
        </bns:updateResponse>
    </S:Body>
</S:Envelope>

QUERY operation

Retrieves private runtime clouds that exist on requesting account, and you can filter the records using query filters. The following table shows the supported operators by each field.

Query Filter Field	Supported Operators
`id`	EQUALS
`name`	EQUALS, NOT_EQUALS, IS_NULL, IS_NOT_NULL, LIKE, STARTS_WITH
`classification`	EQUALS, NOT_EQUALS, IS_NULL, IS_NOT_NULL
`allowDeployments`	EQUALS, NOT_EQUALS, IS_NULL, IS_NOT_NULL
`allowBrowsing`	EQUALS, NOT_EQUALS, IS_NULL, IS_NOT_NULL
`allowTestExecutions`	EQUALS, NOT_EQUALS, IS_NULL, IS_NOT_NULL
`maxAttachmentsPerAccount`	EQUALS, NOT_EQUALS, IS_NULL, IS_NOT_NULL, LESS_THAN(_OR_EQUAL), GREATER_THAN(_OR_EQUAL), BETWEEN
`createdBy`	EQUALS, NOT_EQUALS, IS_NULL, IS_NOT_NULL
`createdDate`	EQUALS, NOT_EQUALS, IS_NULL, IS_NOT_NULL, LESS_THAN(_OR_EQUAL), GREATER_THAN(_OR_EQUAL), BETWEEN
`modifiedBy`	EQUALS, NOT_EQUALS, IS_NULL, IS_NOT_NULL
`modifiedDate`	EQUALS, NOT_EQUALS, IS_NULL, IS_NOT_NULL, LESS_THAN(_OR_EQUAL), GREATER_THAN(_OR_EQUAL), BETWEEN

Request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.platform.boomi.com/">
   <soapenv:Body>
      <api:query>
         <!--Optional:-->
         <api:objectType>RuntimeCloud</api:objectType>
         <!--Optional:-->
         <api:queryConfig>
            <api:QueryFilter>
               <api:expression operator="and" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="api:GroupingExpression">
                    <api:nestedExpression operator="NOT_EQUALS" property="allowBrowsing" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="api:SimpleExpression">
                    <argument>true</argument>
                    </api:nestedExpression>
                <nestedExpression operator="BETWEEN" property="maxAttachmentsPerAccount" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="api:SimpleExpression">
                        <argument>5</argument>
                        <argument>16</argument>
                </nestedExpression>
              </api:expression>
            </api:QueryFilter>
         </api:queryConfig>
      </api:query>
   </soapenv:Body>
</soapenv:Envelope>

Response:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Body>
        <bns:queryResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bns="http://api.platform.boomi.com/">
            <bns:results numberOfResults="1">
                <bns:result xsi:type="bns:RuntimeCloud" id="c0235ead-1be2-44ea-bc7f-d1966022d18d" name="myCloud" classification="PROD" allowDeployments="true" allowBrowsing="true" allowTestExecutions="false" maxAttachmentsPerAccount="2" modifiedDate="2025-05-28T04:10:11Z" modifiedBy="testUser@boomi.com"/>
            </bns:results>
        </bns:queryResponse>
    </S:Body>
</S:Envelope>

DELETE operation

Request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.platform.boomi.com/">
  <soapenv:Header>
     <wsse:Security
      xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
       <wsse:UsernameToken wsu:Id="UsernameToken" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
         <wsse:Username>BOOMI_USER_NAME</wsse:Username>
         <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">BOOMI_PASSWORD</wsse:Password>
       </wsse:UsernameToken>
     </wsse:Security>
  </soapenv:Header>
  <soapenv:Body>
     <api:delete>
        <api:objectType>RuntimeCloud</api:objectType>
        <api:objectId>c0235ead-1be2-44ea-bc7f-d1966022d18d</api:objectId>
     </api:delete>
  </soapenv:Body>
</soapenv:Envelope>

Response:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
  <S:Body>
     <bns:deleteResponse xmlns:bns="http://api.platform.boomi.com/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
        <successful>true</successful>
     </bns:deleteResponse>
  </S:Body>
</S:Envelope>

Structure​

Supported operations​​

CREATE operation​

GET operation​

UPDATE operation:​

QUERY operation​

DELETE operation​

Structure

Supported operations

CREATE operation

GET operation

UPDATE operation:

QUERY operation

DELETE operation