License
This page describes how to update and manage you license in Lenses.
To run Lenses you need to have a valid license key. The license is a JSON file that you provide to the Lenses at the startup. When valid, you are good to go. You can update the license key at the runtime.
Expiration
30 days before the expiration of your license key, an amber notification will appear in Lenses.
After expiration, you have a 5-day graceful period to run Lenses.
Update a license
You can update the license from the UI. Navigate to Admin and License and paste the content of the license file:
Update via the CLI / API
License management is also supported by the CLI to enable automation scenarios.
View license info
lenses-cli license get
Update the license of a Lenses instance at runtime
lenses-cli license update --file <license.json>
Returns the Lenses license details
The request input was invalid
Authentication error
The purchased Lenses license does not provide access to this feature
Authorisation error
The requested resource cannot be found
An internal server error has occurred
GET /api/v1/license HTTP/1.1
Host:
Accept: */*
{
"maxBrokers": 1,
"expiry": 1,
"clientId": "text",
"isRespected": true,
"status": "Valid",
"message": "text",
"settings": {
"security": {
"root": {
"enabled": true
},
"basic": {
"enabled": true
},
"ldap": {
"enabled": true
},
"kerberos": {
"enabled": true
},
"custom": {
"enabled": true
},
"sso": {
"enabled": true
},
"serviceAccount": {
"enabled": true,
"restriction": 1
},
"groups": {
"enabled": true,
"restriction": 1
},
"maxUsers": {
"restriction": 1
}
},
"sql": {
"streaming": {
"enabled": true,
"restriction": 1
},
"sql": {
"enabled": true
}
},
"kafkaSettings": {
"acls": true,
"quotas": true,
"consumerOffsetManagement": true
},
"audit": {
"enabled": true,
"integration": true
},
"connections": {
"enabled": true
},
"application": {
"topology": true,
"connectorsOnKubernetes": true
},
"approval": {
"enabled": true
},
"alerts": {
"enabled": true,
"rules": 1,
"integration": {
"enabled": true,
"channels": [
"text"
],
"max": 1
}
},
"data": {
"masking": true,
"customSerde": true,
"sla": true,
"namespace": {
"enabled": true,
"max": 1
}
},
"backup": {
"enabled": true
}
},
"currentTime": 1
}
Updates the license information
The request input was invalid
Authentication error
The purchased Lenses license does not provide access to this feature
Authorisation error
The requested resource cannot be found
An internal server error has occurred
PUT /api/v1/license HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 65
{
"source": "text",
"clientId": "text",
"details": "text",
"key": "text"
}
{
"maxBrokers": 1,
"expiry": 1,
"clientId": "text",
"isRespected": true,
"status": "Valid",
"message": "text",
"settings": {
"security": {
"root": {
"enabled": true
},
"basic": {
"enabled": true
},
"ldap": {
"enabled": true
},
"kerberos": {
"enabled": true
},
"custom": {
"enabled": true
},
"sso": {
"enabled": true
},
"serviceAccount": {
"enabled": true,
"restriction": 1
},
"groups": {
"enabled": true,
"restriction": 1
},
"maxUsers": {
"restriction": 1
}
},
"sql": {
"streaming": {
"enabled": true,
"restriction": 1
},
"sql": {
"enabled": true
}
},
"kafkaSettings": {
"acls": true,
"quotas": true,
"consumerOffsetManagement": true
},
"audit": {
"enabled": true,
"integration": true
},
"connections": {
"enabled": true
},
"application": {
"topology": true,
"connectorsOnKubernetes": true
},
"approval": {
"enabled": true
},
"alerts": {
"enabled": true,
"rules": 1,
"integration": {
"enabled": true,
"channels": [
"text"
],
"max": 1
}
},
"data": {
"masking": true,
"customSerde": true,
"sla": true,
"namespace": {
"enabled": true,
"max": 1
}
},
"backup": {
"enabled": true
}
},
"currentTime": 1
}
Where do I get my license key?
If you are a customer, your license key is available in the customer portal. Contact your account representative for the details.
Last updated
Was this helpful?