Boomi Platform API Reference (1.0.0) - AtomDiskSpace

Toggle Pane

• AtomDiskSpace
  • getRetrieves an AtomDiskSpace object by identifier
  • getRetrieves an AtomDiskSpace object by token

API docs by Redocly

License: Boomi API License and Rate Limits

Download OpenAPI Specification: Download

AtomDiskSpace

As a Cloud owner, you can use the AtomDiskSpace object to retrieve information about the current disk space usage for a given Runtime cloud attachment. For monitoring purposes, the AtomDiskSpace object can help you determine how close your account is to the maximum disk space quota set on the Account Disk Usage property (Runtime Management --> Cloud Management --> Attachment Quotas tab). Retrieving Runtime disk space is an asynchronous process:

• The client sends a GET request that specifies a container ID to the .
• The platform returns a token for the specified Runtime cloud.
• The client sends one or more GET requests that include the token.
• The platform returns one of the following:
  • Status code 202 while the request is in progress.
  • Status code 200 with the custom contents of the token when the request is complete.

Retrieves an AtomDiskSpace object by identifier

The GET operation returns the current disk usage state of the given Runtime cloud attachment. The initial GET operation returns a token for the specified Runtime cloud attachment. Subsequent GET operations return status code 202 (while the request is in progress) based on the returned token. This first request is required to retrieve the authenticating token, which is used in a subsequent GET request.

Note: accountId must always refer to the account ID of the parent Runtime cloud and not that of the attachment.

Authorizations:

basicAuth

path Parameters

id required

string ID of the Runtime cloud attachment.

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

required	object (AsyncToken)
responseStatusCode required	integer <int32>

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}/async/AtomDiskSpace/{id}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "@type": "AsyncOperationTokenResult",
• "asyncToken": {

  • "@type": "AsyncToken",
  • "token": "AtomDiskSpace-12b08345-ab6a-7b0f-8a91-2e34dec567a8"

  },
• "responseStatusCode": 202

}

Retrieves an AtomDiskSpace object by token

Send a second HTTP GET request where accountId is the ID of the authenticating account for the request, and token is the token returned in the initial response. This second request authenticates the retrieval of the Runtime cloud attachments' disk space usage.

Note: accountId must always refer to the account ID of the parent Runtime cloud and not that of the attachment.

Authorizations:

basicAuth

path Parameters

token required

string Takes in the token from a previous call to return a result.

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

responseStatusCode required	integer <int32>
numberOfResults	integer <int32>
	Array of objects (AtomDiskSpace)

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}/async/AtomDiskSpace/response/{token}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

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

  • {

    • "@type": "AtomDiskSpaceDirectory",
    • "file": "/var/boomi/Cloud_DockerCloud/accounts/parent-cloud-account-123/doccache",
    • "rawSize": 21931,
    • "size": "21 KB"

    },
  • {

    • "@type": "AtomDiskSpaceDirectory",
    • "file": "/var/boomi/Cloud_DockerCloud/accounts/parent-cloud-account-123/tmpdata",
    • "rawSize": 0,
    • "size": "0"

    }

  ],
• "responseStatusCode": 200,
• "numberOfResults": 1

}