Performing an Immediate Upgrade for an Event Broker Service Using the REST API for Solace Cloud

You can upgrade an eligible event broker service using the REST API for Solace Cloud. You will know an event broker service is eligible for an upgrade in the following ways:

• You receive a notification from Solace.

• You see a caution symbol on the Event broker service in the Cloud Console.

• You query the availability of an upgrade for an event broker service using the REST API.

Before performing a self-serve upgrade using the REST API, review the Considerations for Performing Immediate Event Broker Service Upgrades Using the REST API

You can complete the entire self-serve upgrade process with the REST API using these steps:

1. Check the availability of a self-serve upgrade for an event broker service

2. Determine the broker versions available for the self-serve upgrade

3. Create a self-serve upgrade for an event broker service

4. (Optional) View the progress of a self-serve event broker service upgrade

You can also schedule event broker service upgrades by creating and managing maintenance windows with the REST API. Creating a maintenance window allows you to schedule event broker service upgrades at regularly occurring intervals. For more information, see Managing Maintenance Activities With the REST API for Solace Cloud

Considerations for Performing Immediate Event Broker Service Upgrades Using the REST API

Here are some considerations when managing maintenance schedules for self-serve event broker service upgrades:

• Review the Considerations for Self-Serve Event Broker Service Upgrades.

• The URL for the request must use base the REST API URL for the regional site of your Solace Cloud deployment, for example, https://api.solace.cloud/. For more information, see the list of available base APIs, or list of available base APIs in the Solace documentaiton.

• Performing an immediate self-serve upgrade for an event broker service using the REST API requires an API token generated from the Cloud Console with permissions based on the activity you want to perform:

  • To check availability of self-serve event broker service upgrades: event_broker_versions:get

  • To get a list of recommended upgrade versions: event_broker_versions:get

  • To create an event broker service upgrade: event_broker_upgrade:post

  • To get an event broker service upgrade: mission_control:access or event_broker_upgrade:post

Checking Availability of a Self-Serve Event Broker Service Upgrade Using the REST API

Before upgrading an event broker service using the REST API, you must check if an upgrade is available for the event broker service. The check upgrade availability for event broker service, perform these steps:

1. Determine the unique identifier for the event broker service you want to upgrade using one of the following methods:

   • In Cluster Manager, select the event broker service and get its unique identifier from the last segment in the URL. For example, 9c5vurtex4b is the identifier from https://console.solace.cloud/services/9c5vurtex4b.

   • Use the Get list of services REST endpoint to find the unique identifier (id) of the event broker service.

   For example, on the Get list of services page, paste your API token into the Bearer field and then click Try It!. To find your event broker service named MyFirstService, you can find that string in the name object, and its corresponding id object is the unique identifier for the service.

2. To get a list of recommended upgrade versions for your event broker service, use the Get the upgrade readiness for an event broker service REST API.

   Define the Path Parameter fields with the information as described in the following table:

   Path Parameter	Definition
   serviceId	The unique identifier of the event broker service that you want to schedule an upgrade for. You can find the ID either: at the end of the URL for your event broker service, for example: https://console.solace.cloud//services/k8vv6x131e1, using a GET call. See Getting a list of event broker services.

   A successful GET request returns code 200 OK. The response returns a JSON body containing data describing the event broker service's upgrade readiness status.

Determining Available Upgrade Versions for an Event Broker Service Using the REST API

If a self-serve event broker service upgrade is available, you can use the REST API for Solace Cloud to query a list of versions available to upgrade the event broker service to. To get a list of available versions, perform these steps:

1. Determine the unique identifier for the event broker service you want to upgrade using one of the following methods:

   • In Cluster Manager, select the event broker service and get its unique identifier from the last segment in the URL. For example, 9c5vurtex4b is the identifier from https://console.solace.cloud/services/9c5vurtex4b.

   • Use the Get list of services REST endpoint to find the unique identifier (id) of the event broker service.

   For example, on the Get list of services page, paste your API token into the Bearer field and then click Try It!. To find your event broker service named MyFirstService, you can find that string in the name object, and its corresponding id object is the unique identifier for the service.

2. If upgrades are available for the event broker service, you can query the list of available upgrade versions for the event broker service by issuing a GET request to the following URL:

   https://${endpoint}/api/v2/missionControl/eventBrokerService/{serviceId}/recommendedVersions

   Define the Path Parameter fields with the information as described in the following table:

   Path Parameter	Definition
   endpoint	The URL for the Cloud Console, for example https://console.solace.cloud/. For more information, see Logging In to the Solace Cloud Console.
   serviceId	The unique identifier of the event broker service that you want to schedule an upgrade for. You can find the ID either: at the end of the URL for your event broker service, for example: https://console.solace.cloud//services/k8vv6x131e1, using a GET call. See Getting a list of event broker services.

   A successful GET request returns code 200. The response returns a JSON body containing a list of recommended software event broker versions to upgrade the event broker service to, and a list of other available software event broker versions.

   Response	Explanation
   recommendedVersions	A list of recommended versions for upgrading the current event broker service.
   versions	A list of other event broker service versions available for upgrading the current event broker service. Information about each type of version may also be included in the response, including: type, version number, supported service classes, release date, release channel, capabilities, end of full and technical support, and whether the version is recommended.

Creating a Self-Serve Event Broker Service Upgrade Using the REST API

If self-serve upgrades are available for your event broker service, and you have a list of available upgrade versions, you can perform a self-serve event broker service upgrade using the REST API for Solace Cloud. To perform a self-serve upgrade, perform these steps:

1. Determine the unique identifier for the event broker service you want to upgrade using one of the following methods:

   • In Cluster Manager, select the event broker service and get its unique identifier from the last segment in the URL. For example, 9c5vurtex4b is the identifier from https://console.solace.cloud/services/9c5vurtex4b.

   • Use the Get list of services REST endpoint to find the unique identifier (id) of the event broker service.

   For example, on the Get list of services page, paste your API token into the Bearer field and then click Try It!. To find your event broker service named MyFirstService, you can find that string in the name object, and its corresponding id object is the unique identifier for the service.

2. Upgrade the event broker service by using the Create an event broker service upgrade REST API.

   Define the Path Parameter fields with the information as described in the following table:

   Path Parameter	Definition
   serviceId	The unique identifier of the event broker service that you want to schedule an upgrade for. You can find the ID either: at the end of the URL for your event broker service, for example: https://console.solace.cloud//services/k8vv6x131e1, using a GET call. See Getting a list of event broker services.

   Define the Body Parameter fields with the information as described in the following table:

   Body Parameter	Definition
   targetVersion	The target software event broker version you want to upgrade the event broker service to. The recommended software event broker versions are returned in the response to your GET for available upgrade versions in step 3.

   A successful POST request returns code 201 Created.

Viewing Self-Serve Event Broker Service Upgrade Progress Using the REST API

You can view the upgrade progress of a self-serve event broker service upgrade using the REST API. To view the upgrade progress, perform these steps:

1. Determine the unique identifier for the event broker service you want to upgrade using one of the following methods:

   • In Cluster Manager, select the event broker service and get its unique identifier from the last segment in the URL. For example, 9c5vurtex4b is the identifier from https://console.solace.cloud/services/9c5vurtex4b.

   • Use the Get list of services REST endpoint to find the unique identifier (id) of the event broker service.

   For example, on the Get list of services page, paste your API token into the Bearer field and then click Try It!. To find your event broker service named MyFirstService, you can find that string in the name object, and its corresponding id object is the unique identifier for the service.

2. You can query the status of the upgrade by issuing a GET request to: using a Get an event broker service upgrade REST API.

   Define the Path Parameter fields with the information as described in the following table:

   Path Parameters	Definition
   serviceId	The unique identifier of the event broker service that you want to schedule an upgrade for. You can find the ID either: at the end of the URL for your event broker service, for example: https://console.solace.cloud//services/k8vv6x131e1, using a GET call. See Getting a list of event broker services.

A successful GET request returns code 200 OK. The response returns a JSON body containing the details of the event broker service upgrade.