Sign in
Licenses

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}

Path parameters

idstring required

Unique identifier for the license.

Request body

keystring nullable

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

revokedboolean nullable

Set true to revoke the license.

suspendedboolean nullable

Set true to suspend the license.

fingerprintMatchingStrategy'fuzzy' | 'exact' | 'loose' nullable

Strategy for matching machine fingerprint.

allowedActivationsinteger nullable

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

allowedDeactivationsinteger nullable

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

leaseDurationinteger nullable

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

allowClientLeaseDurationboolean nullable

Allow client to set the lease duration for floating licenses.

allowedFloatingClientsinteger nullable

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

serverSyncGracePeriodinteger nullable

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

serverSyncIntervalinteger nullable

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

allowedClockOffsetinteger nullable

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

disableClockValidationboolean nullable

Disables clock validation checks on the licensed machine for perpetual licenses.

cryptoBindingEnabledboolean nullable

Whether crypto binding is enabled for the license.

expiringSoonEventOffsetinteger nullable

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.

allowVmActivationboolean nullable

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 nullable

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 nullable

Whether IP address and geo-location should be stored.

notesstring nullable

Notes to store with the license.

allowedIpRangesstring[] nullable

Allowed IP ranges. Leave empty to ignore.

allowedCountriesstring[] nullable

List of the allowed countries. Leave empty to ignore.

disallowedCountriesstring[] nullable

List of the disallowed countries. Leave empty to ignore.

allowedIpAddressesstring[] nullable

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

disallowedIpAddressesstring[] nullable

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

userIdstring nullable

Unique identifier for the user.

resellerIdstring nullable

Unique identifier for the reseller user.

organizationIdstring nullable

Unique identifier for the organization.

additionalUserIdsstring[] nullable

Unique identifier for the additional users.

productVersionIdstring nullable

Unique identifier for the product version.

entitlementSetIdstring nullable

Unique identifier for the Entitlement Set.

maintenancePolicyIdstring nullable

Unique identifier for the maintenance policy.

maxAllowedReleaseVersionstring nullable

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.

tagsstring[] nullable

List of tags.

Response

OK

idstring required
createdAtstring date-time required
updatedAtstring date-time required
keystring required
revokedboolean required
suspendedboolean required
perpetualboolean required
totalActivationsinteger required
totalDeactivationsinteger required
validityinteger nullable
expirationStrategy'immediate' | 'delayed' | 'rolling' nullable
subscriptionIntervalstring nullable
subscriptionStartTrigger'creation' | 'activation'
fingerprintMatchingStrategy'fuzzy' | 'exact' | 'loose' required
allowedActivationsinteger required
allowedDeactivationsinteger required
type'node-locked' | 'hosted-floating' | 'on-premise-floating' required
allowedFloatingClientsinteger required
serverSyncGracePeriodinteger required
serverSyncIntervalinteger required
allowedClockOffsetinteger required
cryptoBindingEnabledboolean required
disableClockValidationboolean required
expiringSoonEventOffsetinteger required
leaseDurationinteger required
leasingStrategy'per-machine' | 'per-instance' required
effectiveDatestring date-time nullable
expiresAtstring date-time nullable
activatedAtstring date-time nullable
lastUsedAtstring date-time nullable
allowVmActivationboolean required
allowContainerActivationboolean required
allowClientLeaseDurationboolean required
userLockedboolean required
requireAuthenticationboolean required
disableGeoLocationboolean required
notesstring nullable
productIdstring required
entitlementSetIdstring nullable
productVersionIdstring nullable
maintenancePolicyIdstring nullable
maintenanceExpiresAtstring date-time nullable
currentReleaseVersionstring nullable
maxAllowedReleaseVersionstring nullable
organizationIdstring nullable
userIdstring nullable
resellerIdstring nullable
additionalUserIdsstring[] required
allowedIpRangestring nullable
allowedIpRangesstring[] required
allowedIpAddressesstring[] required
disallowedIpAddressesstring[] required
allowedCountriesstring[] required
disallowedCountriesstring[] required
tagsstring[] required

Changes

Changed in 1 of the 2 revisions of this API.10

  • 66dcb629318010See the full diff
    • ○

      added the new optional request property customAttributes

      new-optional-request-property

    • ○

      added the optional property user/twoFactorRequiredFrom to the response with the 200 status

      response-optional-property-added

    • ○

      added the required property customAttributes to the response with the 200 status

      response-required-property-added

    • ○

      added the required property organization/customAttributes to the response with the 200 status

      response-required-property-added

    • ○

      added the required property organization/reseller/customAttributes to the response with the 200 status

      response-required-property-added

    • ○

      added the required property reseller/customAttributes to the response with the 200 status

      response-required-property-added

    • ○

      added the required property user/customAttributes to the response with the 200 status

      response-required-property-added

    • ○

      added the required property user/organization/customAttributes to the response with the 200 status

      response-required-property-added

    • ○

      added the required property user/organization/reseller/customAttributes to the response with the 200 status

      response-required-property-added

    • ○

      added the required property user/reseller/customAttributes to the response with the 200 status

      response-required-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog