Waiting for engine...
Skip to main content

Boomi Platform API Reference (1.0.0) - JavaUpgrade

Toggle Pane
API docs by Redocly

License: Boomi API License and Rate Limits

Download OpenAPI Specification: Download

Upgrade Java

Use the Upgrade Java operation to programmatically download and run the Java upgrader script for a specified Runtime, Runtime cluster, Runtime Cloud, Authentication Broker, or API Gateway. The Upgrade Java operation upgrades your selected container to Boomi's latest supported version of Java. Currently, the latest version of Java available is Java 11.

Note: You must have the Runtime Management privilege to use the Upgrade Java operation to update any and all containers. Additionally the container must be eligible for upgrade.

Creates a JavaUpgrade object

Download and run the Java upgrader script for a specified Runtime, Runtime cluster, Runtime cloud, Authentication Broker, or API Gateway. Upgrades your selected container to Boomis latest supported version of Java.

  • After providing the endpoint and a request body that includes the containerID, the CREATE operation immediately upgrades the given container to Boomi's latest supported version of Java. After performing a CREATE operation, you can determine a successful upgrade when the Update to use Java 11. link no longer appears on the following pages:
  • For Runtimes, Runtime clusters, and Runtime clouds — the Runtime Information panel (Manage > Runtime Management of the user interface).
  • For Brokers (applicable for versions newer than 1.8.0_281-b09)— the Broker Information panel (Configure Server > Authentication of the user interface).
  • For API Gateways — the Gateway Information panel (Configure Server > Gateways of the user interface).
  • You must have the Runtime Management privilege to perform the CREATE operation. If you have the Runtime Management Read Access privilege, you cannot use this operation to upgrade your container.
  • The container must be online to use the Upgrade Java operation.
  • The container must be eligible for upgrade.

Important: Only the node that runs upgrades (typically the head node) restarts automatically to run the updated Java version. Therefore, you must restart all other cluster nodes to install the upgrade.

Authorizations:
basicAuth
Request Body schema:
optional
object (JavaUpgradeOptions)
atomId
string

The unique ID assigned by the system to the container
1. Use the Runtime ID for Runtimes, Runtime clusters, and Runtime clouds found in the user interface by navigating to Manage > Runtime Management and viewing the Runtime Information panel for a selected container.
2. Use the Gateway ID found in the user interface by navigating to Configure Server > Gateways > click on a Gateway's name > Gateway Information panel.
3. Use the Broker ID found in the user interface by navigating to Configure Server > Authentication > click on a Broker's name > Broker Information panel.

Responses

Response Schema:
object (JavaUpgradeOptions)
atomId
string

The unique ID assigned by the system to the container
1. Use the Runtime ID for Runtimes, Runtime clusters, and Runtime clouds found in the user interface by navigating to Manage > Runtime Management and viewing the Runtime Information panel for a selected container.
2. Use the Gateway ID found in the user interface by navigating to Configure Server > Gateways > click on a Gateway's name > Gateway Information panel.
3. Use the Broker ID found in the user interface by navigating to Configure Server > Authentication > click on a Broker's name > Broker Information panel.

Request samples

Content type
{
  • "atomId": "01f3696e-6d92-4668-8019-061fec55264c",
  • "scheduleType": "FIRST",
  • "dayOfWeek": "TUESDAY",
  • "hourOfDay": "13",
  • "timeZone": "America/New_York",
  • "JavaUpgradeOptions": {
    • "migrateCertificate": true,
    • "cacertsPath": "/cacerts/path1",
    • "externalJDKPath": "/external/JDK/path1",
    • "prefJreLocation": "EXTERNAL"
    }
}

Response samples

Content type
{
  • "@type": "JavaUpgradeSchedule",
  • "atomId": "01f3696e-6d92-4668-8019-061fec55264c",
  • "scheduleType": "FIRST",
  • "dayOfWeek": "TUESDAY",
  • "hourOfDay": "13",
  • "timeZone": "America/New_York",
  • "JavaUpgradeOptions": {
    • "migrateCertificate": true,
    • "cacertsPath": "/cacerts/path1",
    • "externalJDKPath": "/external/JDK/path1",
    • "prefJreLocation": "EXTERNAL"
    }
}