Boomi Platform API Reference (1.0.0) - AtomStartupProperties

Toggle Pane

• AtomStartupProperties
  • getRetrieves an instance of an AtomStartupProperties object
  • postRetrieves multiple AtomStartupProperties objects by identifier

API docs by Redocly

License: Boomi API License and Rate Limits

Download OpenAPI Specification: Download

AtomStartupProperties

The Atom Startup Properties object represents the start-up properties for a Runtime, Runtime cluster, or Runtime cloud. These properties come from the Java virtual machine (JVM) to which you deploy the Runtime, Runtime cluster, or Runtime cloud. The fields in the Atom Startup Properties object correspond to properties listed on the Startup Properties panel of the Runtime Management page. The specific fields returned depend on the system configuration and can vary from one Runtime to the next.

Note: This API is not applicable for runtimes attached to clouds.

Startup Properties Reference

Property	Type	Description
atomArch	string	The architecture of the Runtime, Runtime cluster, or Runtime cloud — either 64-bit or 32-bit.
atomFreeDiskSpace	long	The amount of free disk space, in bytes, on the drive that holds the Runtime, Runtime cluster, or Runtime cloud installation directory. Some systems do not report this information.
atomHome	string	The installation directory of the Runtime, Runtime cluster, or Runtime cloud.
atomTimeZone	string	The Java timezone for the runtime.
atomType	string	The type of runtime (Runtime, Runtime cluster, Cloud). Cloud attachments are not applicable for the API.
containerImageVersion	string	The Docker image version for containerized runtimes.
customProcbrowserScript	string	The customized procbrowser script file name.
customProcrunnerScript	string	The customized procrunner script file name.
customProcworkerScript	string	The customized procworker script file name.
customRestartScript	string	The customized restart script file name.
fileEncoding	string	Default character encoding for data processed by the Runtime, Runtime cluster, or Runtime cloud. Common values are UTF-8, Windows-1252, and US-ASCII.
infrastructureProvider	string	The infrastructure provider where the Runtime, Runtime cluster, or Runtime cloud is running. Possible values are: - AWS (Amazon Web Services) - Azure (Microsoft Azure) - Docker - Legacy Docker (for Docker installations that occurred before the April 2020 release) - GCE (Google Compute Engine) - Kubernetes - QUICKSTART.
isContainerized	boolean	If true, the runtime is running in a Docker container.
isUsingExternalJDK	boolean	If true, the runtime is using an external Java installation that is not managed by Boomi.
javaHome	string	The Java installation directory. This is the path that your Runtime, Runtime cluster, or Runtime cloud uses to access the Java Runtime.
javaVendor	string	The vendor of the Java installation used by the runtime.
javaVersion	string	The version number of the Java Runtime (in the case of a Runtime) or the JDK (in the case of a Runtime cluster or Runtime cloud) in which the Runtime, Runtime cluster, or Runtime cloud runs.
javaVMName	string	The name of the Java virtual machine to which you deploy the Runtime, Runtime cluster, or Runtime cloud.
jreFolderJavaVersion	string	The Java version of the runtime's managed Java installation.
lastAtomUpdateTime	dateTime (yyyy-MM-dd'T'HH:mm:ss'Z' — for example, 2014-02-05T15:32:00Z)	Displays the last time a Runtime Java was upgraded in the Java Version page.
lastRestartTime	dateTime (yyyy-MM-dd'T'HH:mm:ss'Z' — for example, 2014-02-05T15:32:00Z)	The date and time the Runtime, Runtime cluster, or Runtime cloud was last started or restarted.
localFreeDiskSpace	long	It is the total amount of free disk space left in the local directory where working data is stored. This will be displayed only when localDir is enabled. Refer to the topic Managing local and work directories for more information.
maxCpuTime	long	The average amount of time that a process takes to complete. The upper limit is typically set to unlimited and is represented in seconds.
maxDataSize	long	Specified in kilobytes; this property indicates the maximum size of the process' data segment.
maxFileLocks	long	The maximum number of locks that a process may establish.
maxFileSize	long	The maximum file or folder size that the process can create.
maxMemory	long	The maximum amount of RAM, in bytes, available to processes deployed to the Runtime, Runtime cluster, or Runtime cloud.
maxOpenFiles	int	In Linux only, the maximum number of files that you can open simultaneously. Open files include those that are open for read and write activity and open network connections.
maxProcesses	long	The maximum number of processes that are possible for creation within the system.
maxStackSize	long	Specified in kilobytes; this property indicates the amount of memory a process can allocate on the stack.
osArch	string	The architecture implemented for the microprocessor running the Runtime, Runtime cluster, or Runtime cloud. Common values are amd64, i386, ppc, x86, x86_64.
osName	string	The operating system on which you deploy the Runtime, Runtime cluster, or Runtime cloud.
osVersion	string	The version of the operating system in which you deploy the Runtime, Runtime cluster, or Runtime cloud.
prevJavaVersion	string	Rollback version. The Atom’s Java version prior to the last upgrade. Used as the rollback version in the rollback widget.
proxyHost	string	The host name of the HTTP proxy server.
proxyPassSet	boolean	If true, there is a password set for the defined proxy.
proxyPort	int	The HTTP port number. The default is 80.
securityPolicyLevel	string	The Java security policy of the Runtime cluster or Runtime cloud (LOW, HIGH).
sslProxyHost	string	The host name of the HTTPS proxy server.
sslProxyPort	int	The HTTPS port number. The default is 443.
systemCpuCount	int	The number of central processing units (CPUs) in the system on which you install the Runtime, Runtime cluster, or Runtime cloud.
systemTotalMemory	long	The total amount of memory, in bytes, in the system on which you install the Runtime, Runtime cluster, or Runtime cloud. Some systems do not report this information.
tempFreeDiskSpace	long	The amount of free disk space, in bytes, on the drive that holds the system’s Temporary directory. Some systems do not report this information.
unlimitedCrypto	boolean	The default is false, meaning the Java installation has limited strength cryptography. Certain functionality requires full-strength cryptography. Set this to true if you installed the Java Cryptography Extension (JCE) Unlimited Strength Jurisdiction Policy Files.

Required Privileges

You need these privileges in the target environment:

Write access

• N/A

Read access

• API — Use the Boomi Platform API to access account data.
• ATOM_MANAGEMENT — Configure and administer integration runtimes.
• OR ATOM_MANAGEMENT_READ_ONLY

Retrieves an instance of an AtomStartupProperties object

Retrieves the startup properties for the Runtime, Runtime cluster, or Runtime cloud with the specified ID.

Authorizations:

basicAuth

path Parameters

id required

string A unique ID for the Runtime, Runtime cluster, or Runtime cloud. (This API is not applicable for runtimes attached to clouds)

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

	Array of objects (Property)
id	string A unique ID for the Runtime, Runtime cluster, or Runtime cloud. (This API is not applicable for runtimes attached to clouds).

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

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "@type": "Atom",
• "id": "3456789a-bcde-f012-3456-789abcdef012",
• "name": "My Local Atom",
• "status": "OFFLINE",
• "type": "ATOM",
• "hostName": "WN7X64-11A2BB3",
• "dateInstalled": "2016-02-05T14:49:21Z",
• "currentVersion": "17.08.0.0",
• "purgeHistoryDays": 18,
• "purgeImmediate": false,
• "forceRestartTime": 9

}

Retrieves multiple AtomStartupProperties objects by identifier

To learn more about bulk, refer to the topic Bulk GET operations.

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 (AtomStartupProperties) 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}/AtomStartupProperties/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": {

      • "Property": [

        • {

          • "name": "string",
          • "value": "string"

          }

        ],
      • "id": "3456789a-bcde-f012-3456-789abcdef012"

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

    }

  ]

}