Sign in

v1

latestOpenAPI 3.0.42026-08-062942352.0 MB
LicenseTemplates

Create a license template

Creates a new license template.

post/v3/license-templates

Request body

namestring required

Name of the policy.

fingerprintMatchingStrategy'fuzzy' | 'exact' | 'loose' required

Strategy for matching machine fingerprint.

allowVmActivationboolean required

Whether to allow an activation inside a virtual machine.

allowContainerActivationboolean required

Whether to allow an activation inside a container.

userLockedboolean required

Locks the activation to the machine user.

disableGeoLocationboolean required

Whether IP address and geo-location should be stored.

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.

validityinteger nullable

The duration after which the license will expire. Set to '0' for no expiry.

expirationStrategy'immediate' | 'delayed' | 'rolling' nullable

The strategy to determine the expiration start date.

subscriptionIntervalstring nullable

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)
subscriptionStartTrigger'creation' | 'activation'
allowedActivationsinteger required

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

allowedDeactivationsinteger required

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

type'node-locked' | 'hosted-floating' | 'on-premise-floating' required

Type of the license key.

keyPatternstring nullable

Regex for the license key pattern.

leaseDurationinteger nullable

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

allowClientLeaseDurationboolean required

Allow client to set the lease duration for floating licenses.

leasingStrategy'per-machine' | 'per-instance' nullable

Leasing strategy for floating licenses.

allowedFloatingClientsinteger nullable

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

serverSyncGracePeriodinteger required

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

serverSyncIntervalinteger required

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

allowedClockOffsetinteger required

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

disableClockValidationboolean nullable

Deprecated. Set AllowedClockOffset to -1 to disable clock validation checks.

cryptoBindingEnabledboolean required

Whether crypto binding is enabled for the license.

expiringSoonEventOffsetinteger required

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

requiredMetadataKeysstring[] nullable

List of required metadata keys which a license must have.

requiredMeterAttributesstring[] nullable

List of required meter attributes which a license must have.

Response

Created

idstring required
createdAtstring date-time required
updatedAtstring date-time required
namestring required
allowVmActivationboolean required
allowContainerActivationboolean required
userLockedboolean required
disableGeoLocationboolean required
allowedIpRangestring nullable
allowedIpRangesstring[] required
allowedCountriesstring[] required
disallowedCountriesstring[] required
allowedIpAddressesstring[] required
disallowedIpAddressesstring[] 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
keyPatternstring required
leaseDurationinteger required
allowClientLeaseDurationboolean required
leasingStrategy'per-machine' | 'per-instance' required
allowedFloatingClientsinteger required
serverSyncGracePeriodinteger required
serverSyncIntervalinteger required
cryptoBindingEnabledboolean required
allowedClockOffsetinteger required
expiringSoonEventOffsetinteger required
requireAuthenticationboolean required
requiredMetadataKeysstring[] required
requiredMeterAttributesstring[] required