Update a license

Updates the specified license by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

PATCH/v3/licenses/{id}
JWTlicense:write

Path parameters

idstringrequired

Unique identifier for the license.

Request body

keystring

The key associated with the license. If left empty, key is auto-generated.

Length: [16,256]

revokedboolean

Set true to revoke the license.

suspendedboolean

Set true to suspend the license.

fingerprintMatchingStrategystring

Strategy for matching machine fingerprint.

Allowed values: fuzzy, exact, loose

allowedActivationsinteger

Allowed number of activations for the license. Set to 0 or -1 for unlimited activations.

Range: [-1, 2147483647]Format: int32

allowedDeactivationsinteger

Allowed number of deactivations for the license. Set to -1 for unlimited deactivations. This setting is ignored for floating licenses.

Range: [-1, 2147483647]Format: int32

leaseDurationinteger

Duration of lease for floating licenses. Set to 0 or -1 for unlimited lease duration.

Range: [-1, 2147483647]Format: int32

allowClientLeaseDurationboolean

Allow client to set the lease duration for floating licenses.

allowedFloatingClientsinteger

Allowed number of floating clients for the On-Premise LexFloatServer.

Range: [0, 2147483647]Format: int32

serverSyncGracePeriodinteger

The duration for which the server sync failure due to network error is acceptable. Set to -1 for an unlimited grace period.

Range: [-1, 2147483647]Format: int32

serverSyncIntervalinteger

The interval at which license data in client is synced with the server.

Range: [180, 2147483647]Format: int32

allowedClockOffsetinteger

The allowed clock offset between the network time and the local time. Set to -1 to disable clock validation checks.

Range: [-1, 2147483647]Format: int32

cryptoBindingEnabledboolean

Whether crypto binding is enabled for the license.

expiringSoonEventOffsetinteger

Specifies the offset in seconds before the license's expiration date or the license's maintenance expiration date at which the 'license.expiring-soon' or 'license.maintenance-expiring-soon' webhook event is triggered. This early warning ensures that clients are alerted in advance to take necessary actions before the license or license maintenance expires.

Range: [0, 2147483647]Format: int32

allowVmActivationboolean

Indicates whether activation is permitted within a virtual machine environment. Setting this to true allows the license to be activated in virtual machines, which may be necessary for certain deployment scenarios.

allowContainerActivationboolean

Indicates whether activation is permitted within a container environment. Setting this to true allows the license to be activated in containers, which is essential for modern cloud-native applications.

disableGeoLocationboolean

Whether IP address and geo-location should be stored.

notesstring

Notes to store with the license.

Length: [0,4096]

allowedIpRangesarray of string

Allowed IP ranges. Leave empty to ignore.

allowedCountriesarray of string

List of the allowed countries. Leave empty to ignore.

disallowedCountriesarray of string

List of the disallowed countries. Leave empty to ignore.

allowedIpAddressesarray of string

List of the allowed ip addresses. Leave empty to ignore.

disallowedIpAddressesarray of string

List of the disallowed ip addresses. Leave empty to ignore.

userIdstring

Unique identifier for the user.

Length: [0,256]

resellerIdstring

Unique identifier for the reseller user.

Length: [0,256]

organizationIdstring

Unique identifier for the organization.

Length: [0,256]

additionalUserIdsarray of string

Unique identifier for the additional users.

productVersionIdstring

Unique identifier for the product version.

Length: [0,256]

entitlementSetIdstring

Unique identifier for the Entitlement Set.

Length: [0,256]

maintenancePolicyIdstring

Unique identifier for the maintenance policy.

Length: [0,256]

maxAllowedReleaseVersionstring

The max allowed release version. This property is ignored if maintenance policy is set for the license. Only following three formats are allowed x.x, x.x.x, x.x.x.x.

tagsarray of string

List of tags.

metadataarray of object

List of metdata key/value pairs.

customAttributesarray of object

List of custom attribute name/value pairs.

meterAttributesarray of object

List of metered attributes.

Response

200 OK

idstringrequired
createdAtstringrequired

Format: date-time

updatedAtstringrequired

Format: date-time

keystringrequired
revokedbooleanrequired
suspendedbooleanrequired
perpetualbooleanrequired
totalActivationsintegerrequired

Format: int32

totalDeactivationsintegerrequired

Format: int32

fingerprintMatchingStrategystringrequired

Allowed values: fuzzy, exact, loose

allowedActivationsintegerrequired

Format: int32

allowedDeactivationsintegerrequired

Format: int32

typestringrequired

Allowed values: node-locked, hosted-floating, on-premise-floating

allowedFloatingClientsintegerrequired

Format: int32

serverSyncGracePeriodintegerrequired

Format: int32

serverSyncIntervalintegerrequired

Format: int32

allowedClockOffsetintegerrequired

Format: int32

cryptoBindingEnabledbooleanrequired
expiringSoonEventOffsetintegerrequired

Format: int32

leaseDurationintegerrequired

Format: int32

leasingStrategystringrequired

Allowed values: per-machine, per-instance

allowVmActivationbooleanrequired
allowContainerActivationbooleanrequired
allowClientLeaseDurationbooleanrequired
userLockedbooleanrequired
requireAuthenticationbooleanrequired
disableGeoLocationbooleanrequired
productIdstringrequired
additionalUserIdsarray of stringrequired
allowedIpRangesarray of stringrequired
allowedIpAddressesarray of stringrequired
disallowedIpAddressesarray of stringrequired
allowedCountriesarray of stringrequired
disallowedCountriesarray of stringrequired
metadataarray of objectrequired
customAttributesarray of objectrequired
meterAttributesarray of objectrequired
tagsarray of stringrequired
subscriptionIntervalstring
subscriptionStartTriggerstring

Allowed values: creation, activation

effectiveDatestring

Format: date-time

expiresAtstring

Format: date-time

activatedAtstring

Format: date-time

lastUsedAtstring

Format: date-time

notesstring
entitlementSetIdstring
productVersionIdstring
maintenancePolicyIdstring
maintenanceExpiresAtstring

Format: date-time

currentReleaseVersionstring
maxAllowedReleaseVersionstring
organizationIdstring
organizationobject
userIdstring
userobject
resellerIdstring
resellerobject
allowedIpRangestring