Removal of Microservice API Version 1 - Important Notice for Cumulocity Microservice Developers

Overview

As previously announced in the Change Log, Microservice API version 1 is deprecated and scheduled for removal by March 1, 2025. After this date, you will no longer be able to upload or subscribe to microservices using this version of the API.

What Does This Mean for You?

If your organization is using Microservice API version 1, you must take action to migrate your impacted microservices to version 2 before the deadline. Failure to do so may disrupt your microservices and associated operations. Specifically, you will no longer be able to upload or subscribe to microservices using this version of the API.

Action Required

Here’s what you need to do to prepare for this change:

1. Verify the API Version of Your Microservices**

  • Review the apiVersion property in the microservice manifest for all your microservices (see Microservice Manifest Documentation).
  • Identify any microservices still using API version 1.

2. Migrate Microservices Using API Version 1**

  • Update the apiVersion property in the microservice manifest to version 2.
    "apiVersion":"2"
    
  • Test the functionality of your microservice with version 2 and analyze any potential errors.
  • Upload the updated microservice to your tenant.

For more detailed guidance, refer to the Microservice API Version 2 Migration Guide.

We appreciate your attention to this matter and your cooperation in ensuring a smooth transition. If you have any questions, need assistance, or encounter issues during the migration, please reach out to Nick Ponomar nick.ponomar@cumulocity.com or post in the forum for community assistance.

Stay updated by monitoring this forum and checking the Change Logs regularly.

Thank you,
The Cumulocity Team

4 Likes