RuntimeProperties

Toggle Pane

• RuntimeProperties
  • getRetrieves a RuntimeProperties object by identifier
  • getRetrieves a RuntimeProperties object by token
  • postModifies or updates a RuntimeProperties object

API docs by Redocly

Boomi Enterprise Platform REST API Reference (1.0.0)

License: Boomi API License and Rate Limits

Download OpenAPI Specification: Download

RuntimeProperties

The RuntimeProperties object lets you manage and configure runtime and system properties across runtimes (basic runtime, runtime cloud, and local cluster) programmatically.

Required privileges: You must have Runtime Management or Runtime Management Read Access privilege to use the RuntimeProperties API.

Retrieves a RuntimeProperties object by identifier

Retrieves the details of Basic and Advanced properties of the runtime. Retrieving runtime and system properties is an asynchronous process:

1. Send a GET request that specifies both the account ID and runtime ID to the Boomi Enterprise Platform. https://api.boomi.com/api/rest/v1/{accountId}/async/RuntimeProperties/{runtimeId}. The accountId is the ID of the authenticating account for the request, and runtimeId is the ID of the runtime.

2. The platform returns a token.

3. Send one or more GET requests that include the token. https://api.boomi.com/api/rest/v1/{accountId}/async/RuntimeProperties/response/{token}

4. The platform returns a list of the properties associated with the specific runtime.

   Note: The runtime that you are calling must be online.

Authorizations:

basicAuth

path Parameters

id required

string

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

required	object (AsyncToken)
responseStatusCode required	integer <int32> 202

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

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

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

  • "@type": "AsyncToken",
  • "token": "RuntimeProperties-881d2af4-c8c6-4bae-94b7-85b5a52c21bc"

  },
• "responseStatusCode": 202

}

Retrieves a RuntimeProperties object by token

Retrieves the runtime properties using the token.

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> 200
numberOfResults	integer <int32> Optional
	Array of objects (RuntimeProperties)

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

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

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

  • {

    • "@type": "RuntimeProperties",
    • "standardProperties": {

      • "@type": "standardProperties",
      • "containerName": "Test01_Cloud",
      • "containerHostName": "Test01_Cloud",
      • "containerPurgeImmediately": false,
      • "containerPurgeDays": 30,
      • "containerForceRestart": 0,
      • "useLocalStorageForRuntimeAssets": false,
      • "maxForkedExecutionTimeInCloud": 60000

      },
    • "systemProperties": {

      • "@type": "systemProperties",
      • "heapSize": "512m",
      • "tempDirectory": "/var/folders/98/yr8w302j4n5_fcc_hq9hprsh0000gn/T",
      • "clientDefaultConnectTimeout": 120000,
      • "clientDefaultReadTimeout": 120000,
      • "javaClassPathPrepend": "/Applications/Boomi_AtomSphere/Cloud/Cloud_QA_Test01_Cloud/jre/lib/tools.jar",
      • "javaSecurityCompatibility": "JVM_DEFINED",
      • "jgroupsClusteredLibraryVersion": 3,
      • "preferIpv4Stack": true,
      • "retryHttpPost": false

      },
    • "runtimeId": "73485da4-79f6-4805-9159-91b2bf7555ab"

    }

  ],
• "responseStatusCode": 200

}

Modifies or updates a RuntimeProperties object

Adds, removes, or updates standard and system properties for runtimes through a single API call, supporting partial update. The update operation includes a partialUpdate flag, which can be set to either true or false. This flag determines how existing container properties will be updated.

• If set to true, only the property values specified in the request get updated. All other existing properties within the container will remain unchanged.
• If set to false, property values specified in the request get updated. However, other Basic and Advanced property values not included in the request are reset to their default values.

The Update operation returns HTTP 202 status code.

Authorizations:

basicAuth

path Parameters

id required

string

Request Body schema:

application/jsonapplication/xmlapplication/json

optional

required	object (StandardProperties) Runtime-specific settings. For more information about Standard Properties, refer to Basic and Advanced Properties
required	object (SystemProperties) System properties are settings that apply to the Java Virtual Machine (JVM) and its configuration.
partialUpdate	boolean Supplied only in an UPDATE operation. Determines how existing container properties get updated. By default, it is set to false. If set to true, only the property values specified in the request get updated. All other existing properties within the container will remain unchanged. If set to false, property values specified in the request get updated. However, other Basic and Advanced property values not included in the request are reset to their default values.
runtimeId	string Read-only. System-generated unique identifier of the runtime.

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

required	object (StandardProperties) Runtime-specific settings. For more information about Standard Properties, refer to Basic and Advanced Properties
required	object (SystemProperties) System properties are settings that apply to the Java Virtual Machine (JVM) and its configuration.
partialUpdate	boolean Supplied only in an UPDATE operation. Determines how existing container properties get updated. By default, it is set to false. If set to true, only the property values specified in the request get updated. All other existing properties within the container will remain unchanged. If set to false, property values specified in the request get updated. However, other Basic and Advanced property values not included in the request are reset to their default values.
runtimeId	string Read-only. System-generated unique identifier of the runtime.

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

Request samples

• Payload

Content type

application/jsonapplication/xmlapplication/json

{

• "runtimeId": "1fb4f171-0486-4b66-9b3d-6c323a254adb",
• "partialUpdate": true,
• "standardProperties": {

  • "containerName": "Basic_Atom",
  • "containerHostName": "Basic_Atom",
  • "containerPurgeImmediately": false,
  • "containerPurgeDays": 31,
  • "containerForceRestart": 0,
  • "debugLogging": true,
  • "standardOutputAndErrorLogging": true,
  • "forceStartSharedWebServer": true

  },
• "systemProperties": {

  • "heapSize": "512m",
  • "clientDefaultConnectTimeout": 120000,
  • "clientDefaultReadTimeout": 120000,
  • "javaClassPathPrepend": "/usr/lib/jvm/java-11-amazon-corretto/lib/tools.jar",
  • "javaSecurityCompatibility": "JVM_DEFINED",
  • "jgroupsClusteredLibraryVersion": 3,
  • "jmxRemoteAuthentication": false,
  • "jmxRemotePort": 6005,
  • "jmxRemoteSsl": false,
  • "preferIpv4Stack": true,
  • "retryHttpPost": false

  }

}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "@type": "RuntimeProperties",
• "standardProperties": {

  • "@type": "standardProperties",
  • "containerName": "Basic_Atom",
  • "containerHostName": "Basic_Atom",
  • "containerPurgeImmediately": false,
  • "containerPurgeDays": 31,
  • "containerForceRestart": 0,
  • "debugLogging": true,
  • "standardOutputAndErrorLogging": true,
  • "forceStartSharedWebServer": true

  },
• "systemProperties": {

  • "@type": "systemProperties",
  • "heapSize": "512m",
  • "clientDefaultConnectTimeout": 120000,
  • "clientDefaultReadTimeout": 120000,
  • "javaClassPathPrepend": "/usr/lib/jvm/java-11-amazon-corretto/lib/tools.jar",
  • "javaSecurityCompatibility": "JVM_DEFINED",
  • "jgroupsClusteredLibraryVersion": 3,
  • "jmxRemoteAuthentication": false,
  • "jmxRemotePort": 6005,
  • "jmxRemoteSsl": false,
  • "preferIpv4Stack": true,
  • "retryHttpPost": false

  },
• "runtimeId": "1fb4f171-0486-4b66-9b3d-6c323a254adb",
• "partialUpdate": true

}