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, including custom runtime and system properties, across runtimes (basic runtime, runtime cloud, and local cluster).

Required Privileges

You need these privileges in the target environment:

Write access

• ATOM_MANAGEMENT — Configure and administer integration runtimes.

Read access

• ATOM_MANAGEMENT — Configure and administer integration runtimes.

• OR ATOM_MANAGEMENT_READ_ONLY

Retrieves a RuntimeProperties object by identifier

Retrieves the details of standard and system properties, and custom runtime and system properties of a specific 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/{id}. The accountId is the ID of the authenticating account for the request, and id 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 Read-only. System-generated unique identifier of a runtime.

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",
      • "containerHostName": "cloud_cluster2",
      • "containerForceRestart": 0,
      • "useLocalStorageForRuntimeAssets": false,
      • "workingDataLocalStorageDirectory": "/opt/boomi/local",
      • "clusterNetworkTransportType": "UNICAST",
      • "debugLogging": true,
      • "standardOutputAndErrorLogging": true,
      • "forceStartSharedWebServer": true,
      • "containerName": "cloud_cluster2",
      • "containerPurgeImmediately": false,
      • "containerPurgeDays": 37

      },
    • "systemProperties": {

      • "@type": "systemProperties",
      • "heapSize": "513m",
      • "clientDefaultConnectTimeout": 120001,
      • "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

      },
    • "customRuntimeProperties": {

      • "@type": "customRuntimeProperties",
      • "com.boomi.container.is.orchestrated.container": "true",
      • "com.boomi.container.cloudlet.findInitialHostsTimeout": "4",
      • "com.boomi.container.enableUI": "false",
      • "com.boomi.container.metrics.enabled": "false",
      • "com.boomi.container.enableRuntimeRestartOnRuntimePropsUpdate": "true"

      },
    • "customSystemProperties": {

      • "@type": "customSystemProperties",
      • "property": [

        • "-Dcom.sun.management.jmxremote",
        • "-Dcom.sun.management.jmxremote.local.only=true",
        • "-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=*:5005"

        ]

      },
    • "runtimeId": "edfbe7a2-8ffa-4079-84b3-3f469c5ee8e5"

    }

  ],
• "responseStatusCode": 200

}

Modifies or updates a RuntimeProperties object

Adds, removes, or updates standard and system properties, as well as custom runtime and system properties for runtimes, through a single API call. The update operation includes the optional flags, partialUpdate and shouldRestartRuntime.

The Update operation returns HTTP 202 status code.

Authorizations:

basicAuth

path Parameters

id required

string Read-only. System-generated unique identifier of a runtime.

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.
required	object (CustomRuntimeProperties) User-defined runtime properties to configure a basic runtime, runtime cloud, or a local cluster. Required for specific use cases or as directed by Boomi Support.
required	object (CustomSystemProperties) User-defined properties to configure JVM-specific settings used by the runtime.
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, and any new custom properties will be appended to the existing ones. If set to false, property values specified in the request get updated. However, other standard and system property values not included in the request are reset to their default values, and unspecified custom properties are removed
runtimeId	string Read-only. System-generated unique identifier of the runtime.
shouldRestartRuntime	boolean By default, it is set to false. Setting the flag to true triggers a runtime restart after the runtime properties are updated. Setting the flag to false updates the runtime properties without initiating a runtime restart.

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.
required	object (CustomRuntimeProperties) User-defined runtime properties to configure a basic runtime, runtime cloud, or a local cluster. Required for specific use cases or as directed by Boomi Support.
required	object (CustomSystemProperties) User-defined properties to configure JVM-specific settings used by the runtime.
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, and any new custom properties will be appended to the existing ones. If set to false, property values specified in the request get updated. However, other standard and system property values not included in the request are reset to their default values, and unspecified custom properties are removed
runtimeId	string Read-only. System-generated unique identifier of the runtime.
shouldRestartRuntime	boolean By default, it is set to false. Setting the flag to true triggers a runtime restart after the runtime properties are updated. Setting the flag to false updates the runtime properties without initiating a runtime restart.

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

{

• "partialUpdate": "true",
• "runtimeId": "edfbe7a2-8ffa-4079-84b3-3f469c5ee8e5",
• "shouldRestartRuntime": "true",
• "standardProperties": {

  • "containerHostName": "cloud_cluster2",
  • "containerForceRestart": 0,
  • "useLocalStorageForRuntimeAssets": false,
  • "workingDataLocalStorageDirectory": "/opt/boomi/local",
  • "clusterNetworkTransportType": "UNICAST",
  • "debugLogging": true,
  • "standardOutputAndErrorLogging": true,
  • "forceStartSharedWebServer": true,
  • "containerName": "cloud_cluster2",
  • "containerPurgeImmediately": false,
  • "containerPurgeDays": 38

  },
• "systemProperties": {

  • "heapSize": "514m",
  • "clientDefaultConnectTimeout": 120002,
  • "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

  },
• "customRuntimeProperties": {

  • "com.boomi.container.is.orchestrated.container": "true",
  • "com.boomi.container.cloudlet.findInitialHostsTimeout": "5",
  • "com.boomi.container.enableUI": "false",
  • "com.boomi.container.metrics.enabled": "false",
  • "com.boomi.container.enableRuntimeRestartOnRuntimePropsUpdate": "true"

  },
• "customSystemProperties": {

  • "property": [

    • "-Dcom.sun.management.jmxremote",
    • "-Dcom.sun.management.jmxremote.local.only=true",
    • "-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=*:5005"

    ]

  }

}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

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

  • "@type": "standardProperties",
  • "containerHostName": "cloud_cluster2",
  • "containerForceRestart": 0,
  • "useLocalStorageForRuntimeAssets": false,
  • "workingDataLocalStorageDirectory": "/opt/boomi/local",
  • "clusterNetworkTransportType": "UNICAST",
  • "debugLogging": true,
  • "standardOutputAndErrorLogging": true,
  • "forceStartSharedWebServer": true,
  • "containerName": "cloud_cluster2",
  • "containerPurgeImmediately": false,
  • "containerPurgeDays": 38

  },
• "systemProperties": {

  • "@type": "systemProperties",
  • "heapSize": "514m",
  • "clientDefaultConnectTimeout": 120002,
  • "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

  },
• "customRuntimeProperties": {

  • "@type": "customRuntimeProperties",
  • "com.boomi.container.is.orchestrated.container": "true",
  • "com.boomi.container.cloudlet.findInitialHostsTimeout": "5",
  • "com.boomi.container.enableUI": "false",
  • "com.boomi.container.metrics.enabled": "false",
  • "com.boomi.container.enableRuntimeRestartOnRuntimePropsUpdate": "true"

  },
• "customSystemProperties": {

  • "@type": "customSystemProperties",
  • "property": [

    • "-Dcom.sun.management.jmxremote",
    • "-Dcom.sun.management.jmxremote.local.only=true",
    • "-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=*:5005"

    ]

  },
• "runtimeId": "edfbe7a2-8ffa-4079-84b3-3f469c5ee8e5"

}