Waiting for engine...
Skip to main content

Boomi Platform API Reference (1.0.0) - JavaRollback

Toggle Pane
API docs by Redocly

License: Boomi API License and Rate Limits

Download OpenAPI Specification: Download

Roll back Java

Use the Roll back Java operation to programmatically return a Runtime, Runtime cluster, Runtime Cloud, Authentication Broker, or Gateway to use the previous version of Java with an EXECUTE operation.

Note: You must have the Runtime Management privilege to use the Roll back Java operation to update any and all containers.

Important: - Suppose you roll back a container from Java 11 to an earlier version of Java. In that case, you must also update your Runtime virtual machine (VM) options to include endorsed directories by enabling the ATOM\INSTALL\DIR\bin\atom.vmoptions property.

  • For Java 11, the default state for this property is disabled, and you need to turn it on when you roll back to earlier versions of Java.
  • You do not need to enable the property if you already have earlier Java versions installed.

Executes an action on a JavaRollback object

Returns a Runtime, Runtime cluster, Runtime cloud, Authentication Broker, or Gateway to use the previous version of Java with an EXECUTE operation.

  • After performing the EXECUTE operation, you can determine the success of returning to an earlier version when the Update to use . link displays on the following pages, indicating that a more recent version is available for upgrade:

  • For Runtimes, Runtime clusters, and Runtime clouds — the Runtime Information panel (Manage > Runtime Management of the user interface).

  • For Brokers — 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).

To verify a successful rollback on a Runtime using the user interface, you can also navigate to Runtime Management > Startup Properties and reference the Java version number listed in the Java Home field.

  • The container must be online to use the Rollback Java operation.

Important: Only the node that runs upgrades (typically the head node) restarts automatically to run the updated Java version for Runtimes, Runtime clusters, and Runtime clouds. You must restart all other cluster nodes to successfully return to a previous version of Java. To successfully return to a previous version of Java for API Management Gateways and Authentication Brokers, you must restart all Gateways and Brokers.

Authorizations:
basicAuth
path Parameters
id
required
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 > <gatewayName> > Gateway Information panel.

  3. Use the Broker ID found in the user interface by navigating to Configure Server > Authentication > <brokerName> > Broker Information panel.

Request Body schema:
optional
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 > <gatewayName> > Gateway Information panel.

  3. Use the Broker ID found in the user interface by navigating to Configure Server > Authentication > <brokerName> > Broker Information panel.

Responses

Response Schema:
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 > <gatewayName> > Gateway Information panel.

  3. Use the Broker ID found in the user interface by navigating to Configure Server > Authentication > <brokerName> > Broker Information panel.

Request samples

Content type
{
  • "atomId": "3456789a-bcde-f012-3456-789abcdef012"
}

Response samples

Content type
{
  • "@type": "JavaRollback",
  • "atomId": "3456789a-bcde-f012-3456-789abcdef012"
}