Update a license template

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

PATCH/v3/license-templates/{id}
JWTlicenseTemplate:write

Path parameters

idstringrequired

Unique identifier for the license template.

Request body

namestring

Name of the policy. Any printable characters, including letters from any script, punctuation and emoji. Cannot contain line breaks, tabs, other control characters, invisible formatting characters (zero-width and bidirectional marks), and cannot start or end with whitespace.

Length: [1,256]Pattern: ^(?!\s)(?!.*\s$)[^\p{Cc}\p{Cf}\p{Zl}\p{Zp}]+$

fingerprintMatchingStrategystring

Strategy for matching machine fingerprint.

Allowed values: fuzzy, exact, loose

allowVmActivationboolean

Whether to allow an activation inside a virtual machine.

allowContainerActivationboolean

Whether to allow an activation inside a container.

userLockedboolean

Locks the activation to the machine user.

disableGeoLocationboolean

Whether IP address and geo-location should be stored.

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.

subscriptionIntervalstring

The length of time which determines the subscription renewal cadence. ISO8601 durations accepted. Examples: - P1Y (1 year) - P6M (6 months) - P1M (1 month) - P1W (1 week) - P7D (7 days) - PT24H (24 hours)

Length: [0,256]

subscriptionStartTriggerstring

Allowed values: creation, activation

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

typestring

Type of the license key.

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

keyPatternstring

Regex for the license key pattern.

Length: [0,256]

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.

leasingStrategystring

Leasing strategy for floating licenses.

Allowed values: per-machine, per-instance

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 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

The number of seconds to wait before license expiration date to trigger 'license.expiring-soon' webhook event.

Range: [0, 2147483647]Format: int32

requiredMetadataKeysarray of string

List of required metadata keys which a license must have.

requiredMeterAttributesarray of string

List of required meter attributes which a license must have.

Response

200 OK

idstringrequired
createdAtstringrequired

Format: date-time

updatedAtstringrequired

Format: date-time

namestringrequired
allowVmActivationbooleanrequired
allowContainerActivationbooleanrequired
userLockedbooleanrequired
disableGeoLocationbooleanrequired
allowedIpRangesarray of stringrequired
allowedCountriesarray of stringrequired
disallowedCountriesarray of stringrequired
allowedIpAddressesarray of stringrequired
disallowedIpAddressesarray of stringrequired
fingerprintMatchingStrategystringrequired

Allowed values: fuzzy, exact, loose

allowedActivationsintegerrequired

Format: int32

allowedDeactivationsintegerrequired

Format: int32

typestringrequired

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

keyPatternstringrequired
leaseDurationintegerrequired

Format: int32

allowClientLeaseDurationbooleanrequired
leasingStrategystringrequired

Allowed values: per-machine, per-instance

allowedFloatingClientsintegerrequired

Format: int32

serverSyncGracePeriodintegerrequired

Format: int32

serverSyncIntervalintegerrequired

Format: int32

cryptoBindingEnabledbooleanrequired
allowedClockOffsetintegerrequired

Format: int32

expiringSoonEventOffsetintegerrequired

Format: int32

requireAuthenticationbooleanrequired
requiredMetadataKeysarray of stringrequired
requiredMeterAttributesarray of stringrequired
allowedIpRangestring
subscriptionIntervalstring
subscriptionStartTriggerstring

Allowed values: creation, activation