1 of 1

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>

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.

License

This page describes how to update and manage you license in Lenses.

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

GET/api/v1/license

Response

Body

maxBrokersinteger

expiryinteger (int64)

clientIdstring

isRespected*boolean

status*LicenseStatusSummary (enum)

ValidExpiredBrokersExceededNoLicense

messagestring

settingsLicenseSettings (object)

security*SecuritySettings (object)

root*RootSecurity (object)

enabled*boolean

basic*BasicSecurity (object)

enabled*boolean

ldap*LdapSecurity (object)

enabled*boolean

kerberos*KerberosSecurity (object)

enabled*boolean

custom*CustomSecurity (object)

enabled*boolean

sso*SSOSecurity (object)

enabled*boolean

serviceAccount*ServiceAccount (object)

enabled*boolean

restrictioninteger

groups*Groups (object)

enabled*boolean

restrictioninteger

maxUsers*MaxUsers (object)

restrictioninteger

sql*SQLSettings (object)

streaming*SQLStreaming (object)

enabled*boolean

restrictioninteger

sql*SQLEngine (object)

enabled*boolean

kafkaSettings*KafkaSettings (object)

acls*boolean

quotas*boolean

consumerOffsetManagement*boolean

audit*AuditSettings (object)

enabled*boolean

integration*boolean

connections*ConnectionsSettings (object)

enabled*boolean

application*ApplicationSettings (object)

topology*boolean

connectorsOnKubernetes*boolean

approval*ApprovalSettings (object)

enabled*boolean

alerts*AlertSettings (object)

enabled*boolean

rulesinteger

integration*AlertIntegration (object)

enabled*boolean

channelsarray of string

itemsstring

maxinteger

data*DataSettings (object)

masking*boolean

customSerde*boolean

sla*boolean

namespace*DataNamespaceSettings (object)

enabled*boolean

maxinteger

backup*S3BackupSettings (object)

enabled*boolean

currentTime*integer (int64)

Request

Response

Updates the license information

PUT/api/v1/license

Body

source*string

clientId*string

details*string

key*string

Response

Body

maxBrokersinteger

expiryinteger (int64)

clientIdstring

isRespected*boolean

status*LicenseStatusSummary (enum)

ValidExpiredBrokersExceededNoLicense

messagestring

settingsLicenseSettings (object)

security*SecuritySettings (object)

root*RootSecurity (object)

enabled*boolean

basic*BasicSecurity (object)

enabled*boolean

ldap*LdapSecurity (object)

enabled*boolean

kerberos*KerberosSecurity (object)

enabled*boolean

custom*CustomSecurity (object)

enabled*boolean

sso*SSOSecurity (object)

enabled*boolean

serviceAccount*ServiceAccount (object)

enabled*boolean

restrictioninteger

groups*Groups (object)

enabled*boolean

restrictioninteger

maxUsers*MaxUsers (object)

restrictioninteger

sql*SQLSettings (object)

streaming*SQLStreaming (object)

enabled*boolean

restrictioninteger

sql*SQLEngine (object)

enabled*boolean

kafkaSettings*KafkaSettings (object)

acls*boolean

quotas*boolean

consumerOffsetManagement*boolean

audit*AuditSettings (object)

enabled*boolean

integration*boolean

connections*ConnectionsSettings (object)

enabled*boolean

application*ApplicationSettings (object)

topology*boolean

connectorsOnKubernetes*boolean

approval*ApprovalSettings (object)

enabled*boolean

alerts*AlertSettings (object)

enabled*boolean

rulesinteger

integration*AlertIntegration (object)

enabled*boolean

channelsarray of string

itemsstring

maxinteger

data*DataSettings (object)

masking*boolean

customSerde*boolean

sla*boolean

namespace*DataNamespaceSettings (object)

enabled*boolean

maxinteger

backup*S3BackupSettings (object)

enabled*boolean

currentTime*integer (int64)

Request

Response

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.

Updates the license information

PUT/api/v1/license

Body

source*string

clientId*string

details*string

key*string

Response

Body

maxBrokersinteger

expiryinteger (int64)

clientIdstring

isRespected*boolean

status*LicenseStatusSummary (enum)

ValidExpiredBrokersExceededNoLicense

messagestring

settingsLicenseSettings (object)

security*SecuritySettings (object)

root*RootSecurity (object)

enabled*boolean

basic*BasicSecurity (object)

enabled*boolean

ldap*LdapSecurity (object)

enabled*boolean

kerberos*KerberosSecurity (object)

enabled*boolean

custom*CustomSecurity (object)

enabled*boolean

sso*SSOSecurity (object)

enabled*boolean

serviceAccount*ServiceAccount (object)

enabled*boolean

restrictioninteger

groups*Groups (object)

enabled*boolean

restrictioninteger

maxUsers*MaxUsers (object)

restrictioninteger

sql*SQLSettings (object)

streaming*SQLStreaming (object)

enabled*boolean

restrictioninteger

sql*SQLEngine (object)

enabled*boolean

kafkaSettings*KafkaSettings (object)

acls*boolean

quotas*boolean

consumerOffsetManagement*boolean

audit*AuditSettings (object)

enabled*boolean

integration*boolean

connections*ConnectionsSettings (object)

enabled*boolean

application*ApplicationSettings (object)

topology*boolean

connectorsOnKubernetes*boolean

approval*ApprovalSettings (object)

enabled*boolean

alerts*AlertSettings (object)

enabled*boolean

rulesinteger

integration*AlertIntegration (object)

enabled*boolean

channelsarray of string

itemsstring

maxinteger

data*DataSettings (object)

masking*boolean

customSerde*boolean

sla*boolean

namespace*DataNamespaceSettings (object)

enabled*boolean

maxinteger

backup*S3BackupSettings (object)

enabled*boolean

currentTime*integer (int64)

Request

Response

Returns the Lenses license details

GET/api/v1/license

Response

Body

maxBrokersinteger

expiryinteger (int64)

clientIdstring

isRespected*boolean

status*LicenseStatusSummary (enum)

ValidExpiredBrokersExceededNoLicense

messagestring

settingsLicenseSettings (object)

security*SecuritySettings (object)

root*RootSecurity (object)

enabled*boolean

basic*BasicSecurity (object)

enabled*boolean

ldap*LdapSecurity (object)

enabled*boolean

kerberos*KerberosSecurity (object)

enabled*boolean

custom*CustomSecurity (object)

enabled*boolean

sso*SSOSecurity (object)

enabled*boolean

serviceAccount*ServiceAccount (object)

enabled*boolean

restrictioninteger

groups*Groups (object)

enabled*boolean

restrictioninteger

maxUsers*MaxUsers (object)

restrictioninteger

sql*SQLSettings (object)

streaming*SQLStreaming (object)

enabled*boolean

restrictioninteger

sql*SQLEngine (object)

enabled*boolean

kafkaSettings*KafkaSettings (object)

acls*boolean

quotas*boolean

consumerOffsetManagement*boolean

audit*AuditSettings (object)

enabled*boolean

integration*boolean

connections*ConnectionsSettings (object)

enabled*boolean

application*ApplicationSettings (object)

topology*boolean

connectorsOnKubernetes*boolean

approval*ApprovalSettings (object)

enabled*boolean

alerts*AlertSettings (object)

enabled*boolean

rulesinteger

integration*AlertIntegration (object)

enabled*boolean

channelsarray of string

itemsstring

maxinteger

data*DataSettings (object)

masking*boolean

customSerde*boolean

sla*boolean

namespace*DataNamespaceSettings (object)

enabled*boolean

maxinteger

backup*S3BackupSettings (object)

enabled*boolean

currentTime*integer (int64)

Request

Response

const response = await fetch('/api/v1/license', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "source": "text",
      "clientId": "text",
      "details": "text",
      "key": "text"
    }),
});
const data = await response.json();

{
  "clientId": "text",
  "isRespected": false,
  "status": "Valid",
  "message": "text",
  "settings": {
    "security": {
      "root": {
        "enabled": false
      },
      "basic": {
        "enabled": false
      },
      "ldap": {
        "enabled": false
      },
      "kerberos": {
        "enabled": false
      },
      "custom": {
        "enabled": false
      },
      "sso": {
        "enabled": false
      },
      "serviceAccount": {
        "enabled": false
      },
      "groups": {
        "enabled": false
      },
      "maxUsers": {}
    },
    "sql": {
      "streaming": {
        "enabled": false
      },
      "sql": {
        "enabled": false
      }
    },
    "kafkaSettings": {
      "acls": false,
      "quotas": false,
      "consumerOffsetManagement": false
    },
    "audit": {
      "enabled": false,
      "integration": false
    },
    "connections": {
      "enabled": false
    },
    "application": {
      "topology": false,
      "connectorsOnKubernetes": false
    },
    "approval": {
      "enabled": false
    },
    "alerts": {
      "enabled": false,
      "integration": {
        "enabled": false,
        "channels": [
          "text"
        ]
      }
    },
    "data": {
      "masking": false,
      "customSerde": false,
      "sla": false,
      "namespace": {
        "enabled": false
      }
    },
    "backup": {
      "enabled": false
    }
  }
}

{
  "clientId": "text",
  "isRespected": false,
  "status": "Valid",
  "message": "text",
  "settings": {
    "security": {
      "root": {
        "enabled": false
      },
      "basic": {
        "enabled": false
      },
      "ldap": {
        "enabled": false
      },
      "kerberos": {
        "enabled": false
      },
      "custom": {
        "enabled": false
      },
      "sso": {
        "enabled": false
      },
      "serviceAccount": {
        "enabled": false
      },
      "groups": {
        "enabled": false
      },
      "maxUsers": {}
    },
    "sql": {
      "streaming": {
        "enabled": false
      },
      "sql": {
        "enabled": false
      }
    },
    "kafkaSettings": {
      "acls": false,
      "quotas": false,
      "consumerOffsetManagement": false
    },
    "audit": {
      "enabled": false,
      "integration": false
    },
    "connections": {
      "enabled": false
    },
    "application": {
      "topology": false,
      "connectorsOnKubernetes": false
    },
    "approval": {
      "enabled": false
    },
    "alerts": {
      "enabled": false,
      "integration": {
        "enabled": false,
        "channels": [
          "text"
        ]
      }
    },
    "data": {
      "masking": false,
      "customSerde": false,
      "sla": false,
      "namespace": {
        "enabled": false
      }
    },
    "backup": {
      "enabled": false
    }
  }
}