Waiting for engine...
Skip to main content

Boomi Platform API Reference (1.0.0) - AccountCloudAttachmentSummary

Toggle Pane
API docs by Redocly

License: Boomi API License and Rate Limits

Download OpenAPI Specification: Download

AccountCloudAttachmentSummary

The AccountCloudAttachmentSummary object lets cloud owners retrieve a list of cloud attachments for their runtime clouds. This includes attachments from the owner’s account as well as from child accounts with which the cloud is shared. The runtime cloud created by the authenticating account must have Cloud Management privileges to access the summary of cloud attachments. The following metadata can be retrieved using the AccountCloudAttachmentSummary object:

  • Runtime ID
  • Attachment Instance ID
  • Attachment Account ID
  • Attachment Creation Date
  • Cloud Cluster ID
  • Cloud ID

Retrieves an instance of an AccountCloudAttachmentSummary object

Authorizations:
basicAuth
path Parameters
id
required
string

Responses

Response Schema:
attachmentAccountId
string

Read-only. Account ID for the cloud attachment.

attachmentCreationDate
string <date-time>

Read-only. Date the attachment was created on the cloud.

attachmentInstanceId
string

Read-only. Instance ID for the cloud attachment, which is a combination of the attachment's account ID and a system-generated suffix.

cloudClusterId
string

Read-only. Unique ID of the cloud cluster for the attachment.

cloudId
string

Read-only. Unique ID of the logical runtime cloud for the attachment.

runtimeId
string

Read-only. System-generated unique identifier of the cloud attachment

Response samples

Content type
{
  • "@type": "AccountCloudAttachmentSummary",
  • "runtimeId": "0134a8f1-594a-479c-b535-fd8154942952",
  • "attachmentInstanceId": "myaccount-A1B2C3.BJRJC2",
  • "attachmentAccountId": "myaccount-A1B2C3",
  • "cloudClusterId": "9cfec83c-cc54-4a36-bdac-b233e92ba7c5",
  • "cloudId": "abf5efbc-8829-4deb-8e1c-f2d2a4885b15",
  • "attachmentCreationDate": "2025-06-11T07:06:04Z"
}

Retrieves multiple AccountCloudAttachmentSummary objects by identifier.

Authorizations:
basicAuth
Request Body schema:
optional
Array of objects (BulkId)
type
string
Enum: "GET" "DELETE" "UPDATE" "CREATE"

Responses

Response Schema:
Array of objects
Array
required
object (AccountCloudAttachmentSummary)
index
integer <int32>
id
string
statusCode
integer <int32>
errorMessage
string

Request samples

Content type
{
  • "request": [
    • {
      }
    ],
  • "type": "GET"
}

Response samples

Content type
{
  • "response": [
    • {
      }
    ]
}

Queries for an AccountCloudAttachmentSummary object(s)

Retrieves cloud attachments across all runtime clouds that were created by the authenticating account. Without applying query filters, the query returns all non-deleted cloud attachments across all cloud clusters. It is recommended to filter the results using query filters such as by cloud ID, by account ID, or by creation date.

For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to Query filters and Query paging.

Authorizations:
basicAuth
Request Body schema:
optional

Possible properties include: runtimeId, attachmentAccountId, attachmentInstanceId, attachmentCreationDate, cloudClusterId, cloudId, clusterCloudId

required
object
required
AccountCloudAttachmentSummarySimpleExpression (object) or AccountCloudAttachmentSummaryGroupingExpression (object) (AccountCloudAttachmentSummaryExpression)
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: "runtimeId" "attachmentAccountId" "attachmentInstanceId" "attachmentCreationDate" "cloudClusterId" "cloudId" "clusterCloudId"
argument
Array of strings

Responses

Response Schema:
numberOfResults
integer <int32>
queryToken
string
Array of objects (AccountCloudAttachmentSummary)

Request samples

Content type
{
  • "QueryFilter": {
    • "expression": {
      }
    }
}

Response samples

Content type
{
  • "@type": "QueryResult",
  • "result": [
    • {
      },
    • {
      }
    ],
  • "numberOfResults": 2
}

Retrieves additional results for an AccountCloudAttachmentSummary query.

Authorizations:
basicAuth
Request Body schema: text/plain
required
string

Responses

Response Schema:
numberOfResults
integer <int32>
queryToken
string
Array of objects (AccountCloudAttachmentSummary)

Response samples

Content type
{
  • "@type": "QueryResult",
  • "result": [
    • {
      },
    • {
      }
    ],
  • "numberOfResults": 2
}