Boomi Platform API Reference (1.0.0) - RuntimeCloud

Toggle Pane

• RuntimeCloud
  • postCreates a RuntimeCloud object
  • getRetrieves an instance of a RuntimeCloud object
  • postModifies or updates a RuntimeCloud object.
  • delDeletes a RuntimeCloud object.
  • postRetrieves multiple RuntimeCloud objects by identifier
  • postQueries for RuntimeCloud objects
  • postRetrieves additional results for a RuntimeCloud query

API docs by Redocly

License: Boomi API License and Rate Limits

Download OpenAPI Specification: Download

RuntimeCloud

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.

Creates a RuntimeCloud object

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

Send an HTTP POST to: https://api.boomi.com/api/rest/v1/{accountId}/RuntimeCloud

Where accountId is the ID of the authenticating account.

The response returns status code 201, which indicates the cloud is successfully created and 400 Bad Request, if required fields are missing or invalid — for example, a missing classification value.

Authorizations:

basicAuth

Request Body schema:

application/jsonapplication/xmlapplication/json

optional

classification required	string 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.
name required	string Name of the private runtime cloud. Required for creating a private runtime cloud. The maximum length must be 255 characters.
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.
allowDeployments	boolean If specified, processes and deployable components are deployed to this private runtime cloud. This feature is not applicable to Integration Packs.
allowTestExecutions	boolean If specified, process executions on a private runtime cloud run in Test mode.
createdBy	string Read-only and system-generated. The user who created the private runtime cloud.
createdDate	string <date-time> Read-only and system-generated. The date and time the private runtime cloud was created.
id	string Read-only. System-generated unique identifier of private runtime cloud.
maxAttachmentsPerAccount	integer <int32> 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.
modifiedBy	string Read-only and system-generated. The user who last modified the private runtime cloud
modifiedDate	string <date-time> Read-only and system-generated. The date and time the private runtime cloud was last modified.

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

classification required	string 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.
name required	string Name of the private runtime cloud. Required for creating a private runtime cloud. The maximum length must be 255 characters.
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.
allowDeployments	boolean If specified, processes and deployable components are deployed to this private runtime cloud. This feature is not applicable to Integration Packs.
allowTestExecutions	boolean If specified, process executions on a private runtime cloud run in Test mode.
createdBy	string Read-only and system-generated. The user who created the private runtime cloud.
createdDate	string <date-time> Read-only and system-generated. The date and time the private runtime cloud was created.
id	string Read-only. System-generated unique identifier of private runtime cloud.
maxAttachmentsPerAccount	integer <int32> 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.
modifiedBy	string Read-only and system-generated. The user who last modified the private runtime cloud
modifiedDate	string <date-time> Read-only and system-generated. The date and time the private runtime cloud was last modified.

Boomi Platform API Endpoint URL. {accountId} is the Account ID of the authenticated Boomi platform account making this request.

https://api.boomi.com/api/rest/v1/{accountId}/RuntimeCloud

Request samples

• Payload

Content type

application/jsonapplication/xmlapplication/json

{

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

}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "@type": "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-12T12:22:54Z",
• "createdDate": "2025-06-12T12:22:54Z",
• "createdBy": "testUser@boomi.com",
• "modifiedBy": "testUser@boomi.com"

}

Retrieves an instance of a RuntimeCloud object

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.

Send an HTTP GET to: https://api.boomi.com/api/rest/v1/{accountId}/RuntimeCloud/{cloudId}

Where accountId is the ID of the authenticating account, and cloudId is the ID of the cloud for which you want to get information.

Authorizations:

basicAuth

path Parameters

id required

string

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

classification required	string 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.
name required	string Name of the private runtime cloud. Required for creating a private runtime cloud. The maximum length must be 255 characters.
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.
allowDeployments	boolean If specified, processes and deployable components are deployed to this private runtime cloud. This feature is not applicable to Integration Packs.
allowTestExecutions	boolean If specified, process executions on a private runtime cloud run in Test mode.
createdBy	string Read-only and system-generated. The user who created the private runtime cloud.
createdDate	string <date-time> Read-only and system-generated. The date and time the private runtime cloud was created.
id	string Read-only. System-generated unique identifier of private runtime cloud.
maxAttachmentsPerAccount	integer <int32> 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.
modifiedBy	string Read-only and system-generated. The user who last modified the private runtime cloud
modifiedDate	string <date-time> Read-only and system-generated. The date and time the private runtime cloud was last modified.

Boomi Platform API Endpoint URL. {accountId} is the Account ID of the authenticated Boomi platform account making this request.

https://api.boomi.com/api/rest/v1/{accountId}/RuntimeCloud/{id}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "@type": "RuntimeCloud",
• "id": "326260d6-895e-4c45-a99f-a16de3907189",
• "name": "Private Cloud",
• "classification": "PROD",
• "allowDeployments": true,
• "allowBrowsing": true,
• "allowTestExecutions": true,
• "maxAttachmentsPerAccount": 0,
• "modifiedDate": "2025-05-27T18:32:49Z",
• "createdDate": "2025-05-27T18:32:49Z",
• "createdBy": "testUser@boomi.com",
• "modifiedBy": "testUser@boomi.com"

}

Modifies or updates a RuntimeCloud object.

Updates the private runtime clouds.

• If you update the private runtime cloud created before July 12, 2025, when retrieving its details, only modifiedBy and modifiedDate fields 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.

Send an HTTP POST to: https://api.boomi.com/api/rest/v1/{accountId}/RuntimeCloud/{cloudId}

Where accountId is the ID of the authenticating account, and cloudId is the ID of the cloud you want to update.

Authorizations:

basicAuth

path Parameters

id required

string

Request Body schema:

application/jsonapplication/xmlapplication/json

optional

classification required	string 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.
name required	string Name of the private runtime cloud. Required for creating a private runtime cloud. The maximum length must be 255 characters.
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.
allowDeployments	boolean If specified, processes and deployable components are deployed to this private runtime cloud. This feature is not applicable to Integration Packs.
allowTestExecutions	boolean If specified, process executions on a private runtime cloud run in Test mode.
createdBy	string Read-only and system-generated. The user who created the private runtime cloud.
createdDate	string <date-time> Read-only and system-generated. The date and time the private runtime cloud was created.
id	string Read-only. System-generated unique identifier of private runtime cloud.
maxAttachmentsPerAccount	integer <int32> 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.
modifiedBy	string Read-only and system-generated. The user who last modified the private runtime cloud
modifiedDate	string <date-time> Read-only and system-generated. The date and time the private runtime cloud was last modified.

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

classification required	string 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.
name required	string Name of the private runtime cloud. Required for creating a private runtime cloud. The maximum length must be 255 characters.
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.
allowDeployments	boolean If specified, processes and deployable components are deployed to this private runtime cloud. This feature is not applicable to Integration Packs.
allowTestExecutions	boolean If specified, process executions on a private runtime cloud run in Test mode.
createdBy	string Read-only and system-generated. The user who created the private runtime cloud.
createdDate	string <date-time> Read-only and system-generated. The date and time the private runtime cloud was created.
id	string Read-only. System-generated unique identifier of private runtime cloud.
maxAttachmentsPerAccount	integer <int32> 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.
modifiedBy	string Read-only and system-generated. The user who last modified the private runtime cloud
modifiedDate	string <date-time> Read-only and system-generated. The date and time the private runtime cloud was last modified.

Boomi Platform API Endpoint URL. {accountId} is the Account ID of the authenticated Boomi platform account making this request.

https://api.boomi.com/api/rest/v1/{accountId}/RuntimeCloud/{id}

Request samples

• Payload

Content type

application/jsonapplication/xmlapplication/json

{

• "id": "59f78b7d-73bb-4b86-81f6-1b08c9205c2f",
• "name": "First runtime cloud",
• "classification": "PROD",
• "allowDeployments": true,
• "allowBrowsing": false,
• "allowTestExecutions": true,
• "maxAttachmentsPerAccount": 1

}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "@type": "RuntimeCloud",
• "id": "59f78b7d-73bb-4b86-81f6-1b08c9205c2f",
• "name": "First runtime cloud",
• "classification": "PROD",
• "allowDeployments": true,
• "allowBrowsing": false,
• "allowTestExecutions": true,
• "maxAttachmentsPerAccount": 1,
• "modifiedDate": "2025-06-12T12:27:06Z",
• "createdDate": "2025-06-12T12:22:54Z",
• "createdBy": "testUser@boomi.com",
• "modifiedBy": "testUser@boomi.com"

}

Deletes a RuntimeCloud object.

Send an HTTP DELETE to: https://api.boomi.com/api/rest/v1/{accountId}/RuntimeCloud/{cloudId}

Where accountId is the ID of the authenticating account, and cloudId is the ID of the cloud you want to delete.

Authorizations:

basicAuth

path Parameters

id required

string

Responses

Boomi Platform API Endpoint URL. {accountId} is the Account ID of the authenticated Boomi platform account making this request.

https://api.boomi.com/api/rest/v1/{accountId}/RuntimeCloud/{id}

Response samples

• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "message": "Access denied due to insufficient permissions."

}

Retrieves multiple RuntimeCloud objects by identifier

Authorizations:

basicAuth

Request Body schema:

application/jsonapplication/xmlapplication/json

optional

	Array of objects (BulkId)
type	string Enum: "GET" "DELETE" "UPDATE" "CREATE"

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

	Array of objects
Array required object (RuntimeCloud) index integer <int32> id string statusCode integer <int32> errorMessage string

Boomi Platform API Endpoint URL. {accountId} is the Account ID of the authenticated Boomi platform account making this request.

https://api.boomi.com/api/rest/v1/{accountId}/RuntimeCloud/bulk

Request samples

• Payload

Content type

application/jsonapplication/xmlapplication/json

{

• "request": [

  • {

    • "id": "56789abc-def0-1234-5678-9abcdef01234"

    }

  ],
• "type": "GET"

}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "response": [

  • {

    • "Result": {

      • "allowBrowsing": true,
      • "allowDeployments": true,
      • "allowTestExecutions": true,
      • "classification": "string",
      • "createdBy": "string",
      • "createdDate": "2019-08-24T14:15:22Z",
      • "id": "string",
      • "maxAttachmentsPerAccount": 0,
      • "modifiedBy": "string",
      • "modifiedDate": "2019-08-24T14:15:22Z",
      • "name": "string"

      },
    • "index": 0,
    • "id": "string",
    • "statusCode": 0,
    • "errorMessage": "string"

    }

  ]

}

Queries for RuntimeCloud objects

Retrieves private runtime clouds that exist on requesting account, and you can filter the records using query filters.

Send an HTTP POST to: https://api.boomi.com/api/rest/v1/{accountId}/RuntimeCloud/query

Where accountId is the ID of the authenticating account.

Authorizations:

basicAuth

Request Body schema:

application/jsonapplication/xmlapplication/json

optional

Possible properties include: name, id, classification, allowDeployments, allowBrowsing, allowTestExecutions, maxAttachmentsPerAccount, createdDate, modifiedDate, createdBy, modifiedBy

required

object

required RuntimeCloudSimpleExpression (object) or RuntimeCloudGroupingExpression (object) (RuntimeCloudExpression) One of operator required string Enum: "EQUALS" "LIKE" "NOT_EQUALS" "IS_NULL" "IS_NOT_NULL" "BETWEEN" "GREATER_THAN" "GREATER_THAN_OR_EQUAL" "LESS_THAN" "LESS_THAN_OR_EQUAL" "CONTAINS" "NOT_CONTAINS" property required string Enum: "name" "id" "classification" "allowDeployments" "allowBrowsing" "allowTestExecutions" "maxAttachmentsPerAccount" "createdDate" "modifiedDate" "createdBy" "modifiedBy" argument Array of strings

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

numberOfResults	integer <int32>
queryToken	string By default, the queryToken parameter is not available in the query response. It appears only when the query response contains more than 100 results. The maximum number of results returned per query is 100. To retrieve the next set of results, use the queryToken in the queryMore request.
	Array of objects (RuntimeCloud)

Boomi Platform API Endpoint URL. {accountId} is the Account ID of the authenticated Boomi platform account making this request.

https://api.boomi.com/api/rest/v1/{accountId}/RuntimeCloud/query

Request samples

• Payload

Content type

application/jsonapplication/xmlapplication/json

Example

SimpleExpressionGroupingExpressionSimpleExpression

{

• "QueryFilter": {

  • "expression": {

    • "argument": [

      • "PROD"

      ],
    • "operator": "EQUALS",
    • "property": "classification"

    }

  }

}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "@type": "QueryResult",
• "result": [

  • {

    • "@type": "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",
    • "createdDate": "2025-06-12T12:22:54Z",
    • "createdBy": "testUser@boomi.com"

    }

  ],
• "numberOfResults": 1

}

Retrieves additional results for a RuntimeCloud query

Authorizations:

basicAuth

Request Body schema: text/plain

required

string

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

numberOfResults	integer <int32>
queryToken	string By default, the queryToken parameter is not available in the query response. It appears only when the query response contains more than 100 results. The maximum number of results returned per query is 100. To retrieve the next set of results, use the queryToken in the queryMore request.
	Array of objects (RuntimeCloud)

Boomi Platform API Endpoint URL. {accountId} is the Account ID of the authenticated Boomi platform account making this request.

https://api.boomi.com/api/rest/v1/{accountId}/RuntimeCloud/queryMore

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "@type": "QueryResult",
• "result": [

  • {

    • "@type": "RuntimeCloud",
    • "id": "e999ff6c-f834-4021-a169-d792c5714171",
    • "name": "My runtime cloud 1",
    • "classification": "PROD",
    • "allowDeployments": true,
    • "allowBrowsing": true,
    • "allowTestExecutions": true,
    • "maxAttachmentsPerAccount": 1,
    • "modifiedDate": "2025-05-28T04:12:40Z",
    • "createdDate": "2025-05-28T04:12:40Z",
    • "createdBy": "testUser@boomi.com",
    • "modifiedBy": "testUser@boomi.com"

    },
  • {

    • "@type": "RuntimeCloud",
    • "id": "1368ec8a-9ba7-436c-b99f-adf447b287f9",
    • "name": "My runtime cloud 2",
    • "classification": "PROD",
    • "allowDeployments": true,
    • "allowBrowsing": true,
    • "allowTestExecutions": true,
    • "maxAttachmentsPerAccount": 1,
    • "modifiedDate": "2025-05-28T04:12:40Z",
    • "createdDate": "2025-05-28T04:12:40Z",
    • "createdBy": "testUser@boomi.com",
    • "modifiedBy": "testUser@boomi.com"

    },
  • {

    • "@type": "RuntimeCloud",
    • "id": "09e48685-1a0c-4e1f-9958-b852366dd048",
    • "name": "My runtime cloud 3",
    • "classification": "PROD",
    • "allowDeployments": true,
    • "allowBrowsing": true,
    • "allowTestExecutions": true,
    • "maxAttachmentsPerAccount": 1,
    • "modifiedDate": "2025-05-28T04:12:40Z",
    • "createdDate": "2025-05-28T04:12:40Z",
    • "createdBy": "testUser@boomi.com",
    • "modifiedBy": "testUser@boomi.com"

    },
  • {

    • "@type": "RuntimeCloud",
    • "id": "ed4309b9-05db-4ef8-92d5-50116ff11410",
    • "name": "My runtime cloud 4",
    • "classification": "PROD",
    • "allowDeployments": true,
    • "allowBrowsing": true,
    • "allowTestExecutions": true,
    • "maxAttachmentsPerAccount": 3,
    • "modifiedDate": "2025-05-28T04:29:15Z",
    • "createdDate": "2025-05-28T04:26:35Z",
    • "createdBy": "testUser@boomi.com",
    • "modifiedBy": "testUser@boomi.com"

    }

  ],
• "numberOfResults": 4

}