License Renewal
The OpenLegacy Platform requires a valid license to enable platform services and applications. If a license expires, access to certain platform capabilities may be restricted until a new license is applied. This guide explains how to renew the platform license after expiration.
Overview
The OpenLegacy Platform uses a Master License and Project Tag Licenses to control platform usage and API quotas.
The Master License governs the overall platform entitlement.
Project Tag Licenses control how many APIs or services can run under each project.
When a license is renewed, the process differs slightly between SaaS and Enterprise deployments.
How It Works
The Master License enables the platform.
Each Project Tag License represents a licensed API or service.
Services start successfully only if a valid Project Tag license key is configured.
Master License Renewal
SaaS Edition
In the SaaS edition, the Master License is automatically extended by the OpenLegacy Backoffice when the license is renewed.
No action is required from administrators.
Enterprise Edition
In the Enterprise edition, the Master License must be manually installed.
After renewal:
OpenLegacy Support sends the updated Master License to the administrator.
The administrator must upload or configure the new Master License in the platform.
Project Tag License Renewal
Project Tag Licenses control how many APIs or services are allowed.
When licenses are renewed:
The platform will prompt administrators to update the Project Tag license key
The new key must be applied to the running services
Updating Project Tag License Keys
- Step 1 — Retrieve Updated License Keys
Obtain the extended Project Tag license keys from the licensing system.
- Step 2 — Update Service Configuration
The Admin or DevOps engineer must update the license key used by the service.
Depending on the deployment, update either:
- Environment variables
- Service configuration files
Example: PROJECT_TAG_LICENSE_KEY=<updated-license-key>
- Step 3 — Restart Services
After updating the configuration:
Restart the affected services
Confirm that the services start successfully
The updated license will now be applied.
License Behavior for Expired Project Tags
If a Project Tag License expires and is not renewed:
The APIs associated with that license will not count toward the licensed quota
The services using that license will stop serving on the next startup
This allows organizations to reduce their licensed capacity if fewer APIs are needed in the next licensing period.
Example
If your license allowed 100 APIs last year, but only 60 APIs are needed next year:
Renew only the required 60 Project Tag licenses
The remaining licenses will not count toward your quota
License Renewal Requirement
A license cannot be renewed unless the corresponding Hub Project Tag exists.
The Hub Project Tag must be present before the renewed license can be applied.
Best Practice
Only renew Project Tag Licenses that are required for the upcoming licensing period.
If certain APIs are no longer needed:
Do not renew those Project Tag licenses
They will not count toward your quota
This allows organizations to optimize license usage based on actual API needs.
Updated about 6 hours ago