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}
JWT
licensePolicy:write

Parameters

NameTypeInDescription
id*stringpathUnique identifier for the license template.

Request Body Schema

PropertyTypeDescriptionConstraints
namestringName of the policy.min: 1, max: 256
fingerprintMatchingStrategystringStrategy for matching machine fingerprint.enum: [fuzzy, exact, loose]
allowVmActivationbooleanWhether to allow an activation inside a virtual machine.
allowContainerActivationbooleanWhether to allow an activation inside a container.
userLockedbooleanLocks the activation to the machine user.
disableGeoLocationbooleanWhether IP address and geo-location should be stored.
allowedIpRangesarrayAllowed IP ranges. Leave empty to ignore.items: string
allowedCountriesarrayList of the allowed countries. Leave empty to ignore.items: string
disallowedCountriesarrayList of the disallowed countries. Leave empty to ignore.items: string
allowedIpAddressesarrayList of the allowed ip addresses. Leave empty to ignore.items: string
disallowedIpAddressesarrayList of the disallowed ip addresses. Leave empty to ignore.items: string
subscriptionIntervalstringThe 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)min: 0, max: 256
subscriptionStartTriggerstringenum: [creation, activation]
allowedActivationsintegerAllowed number of activations for the license. Set to 0 or -1 for unlimited activations.min: -1, max: 2147483647, format: int32
allowedDeactivationsintegerAllowed number of deactivations for the license. Set to -1 for unlimited deactivations. This setting is ignored for floating licenses.min: -1, max: 2147483647, format: int32
typestringType of the license key.enum: [node-locked, hosted-floating, on-premise-floating]
keyPatternstringRegex for the license key pattern.min: 0, max: 256
leaseDurationintegerDuration of lease for floating licenses. Set to 0 or -1 for unlimited lease duration.min: -1, max: 2147483647, format: int32
allowClientLeaseDurationbooleanAllow client to set the lease duration for floating licenses.
leasingStrategystringLeasing strategy for floating licenses.enum: [per-machine, per-instance]
allowedFloatingClientsintegerAllowed number of floating clients for the On-Premise LexFloatServer.min: 0, max: 2147483647, format: int32
serverSyncGracePeriodintegerThe duration for which the server sync failure due to network error is acceptable. Set to -1 for unlimited grace period.min: -1, max: 2147483647, format: int32
serverSyncIntervalintegerThe interval at which license data in client is synced with the server.min: 180, max: 2147483647, format: int32
allowedClockOffsetintegerThe allowed clock offset between the network time and the local time. Set to -1 to disable clock validation checks.min: -1, max: 2147483647, format: int32
cryptoBindingEnabledbooleanWhether crypto binding is enabled for the license.
expiringSoonEventOffsetintegerThe number of seconds to wait before license expiration date to trigger 'license.expiring-soon' webhook event.min: 0, max: 2147483647, format: int32
requiredMetadataKeysarrayList of required metadata keys which a license must have.items: string
requiredMeterAttributesarrayList of required meter attributes which a license must have.items: string

Request Example

{
  "name": "string",
  "fingerprintMatchingStrategy": "fuzzy",
  "allowVmActivation": true,
  "allowContainerActivation": true,
  "userLocked": true,
  "disableGeoLocation": true,
  "allowedIpRanges": [
    "string"
  ],
  "allowedCountries": [
    "string"
  ],
  "disallowedCountries": [
    "string"
  ],
  "allowedIpAddresses": [
    "string"
  ],
  "disallowedIpAddresses": [
    "string"
  ],
  "validity": 2147483647,
  "expirationStrategy": "immediate",
  "subscriptionInterval": "string",
  "subscriptionStartTrigger": "creation",
  "allowedActivations": -1,
  "allowedDeactivations": -1,
  "type": "node-locked",
  "keyPattern": "string",
  "leaseDuration": -1,
  "allowClientLeaseDuration": true,
  "leasingStrategy": "per-machine",
  "allowedFloatingClients": 2147483647,
  "serverSyncGracePeriod": -1,
  "serverSyncInterval": 180,
  "allowedClockOffset": -1,
  "disableClockValidation": true,
  "cryptoBindingEnabled": true,
  "expiringSoonEventOffset": 2147483647,
  "requiredMetadataKeys": [
    "string"
  ],
  "requiredMeterAttributes": [
    "string"
  ]
}
Triggers webhook: licenseTemplate.updated
POST <your-webhook-url>
{
  "event": "licenseTemplate.updated",
  "data": {
    "id": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "name": "string",
    "allowVmActivation": true,
    "allowContainerActivation": true,
    "userLocked": true,
    "disableGeoLocation": true,
    "allowedIpRange": "string",
    "allowedIpRanges": [
      "string"
    ],
    "allowedCountries": [
      "string"
    ],
    "disallowedCountries": [
      "string"
    ],
    "allowedIpAddresses": [
      "string"
    ],
    "disallowedIpAddresses": [
      "string"
    ],
    "validity": 0,
    "expirationStrategy": "immediate",
    "subscriptionInterval": "string",
    "subscriptionStartTrigger": "creation",
    "fingerprintMatchingStrategy": "fuzzy",
    "allowedActivations": 0,
    "allowedDeactivations": 0,
    "type": "node-locked",
    "keyPattern": "string",
    "leaseDuration": 0,
    "allowClientLeaseDuration": true,
    "leasingStrategy": "per-machine",
    "allowedFloatingClients": 0,
    "serverSyncGracePeriod": 0,
    "serverSyncInterval": 0,
    "cryptoBindingEnabled": true,
    "allowedClockOffset": 0,
    "expiringSoonEventOffset": 0,
    "requireAuthentication": true,
    "requiredMetadataKeys": [
      "string"
    ],
    "requiredMeterAttributes": [
      "string"
    ]
  },
  "triggeredAt": "string"
}

Responses

200 OK
{
  "id": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "name": "string",
  "allowVmActivation": true,
  "allowContainerActivation": true,
  "userLocked": true,
  "disableGeoLocation": true,
  "allowedIpRange": "string",
  "allowedIpRanges": [
    "string"
  ],
  "allowedCountries": [
    "string"
  ],
  "disallowedCountries": [
    "string"
  ],
  "allowedIpAddresses": [
    "string"
  ],
  "disallowedIpAddresses": [
    "string"
  ],
  "validity": 0,
  "expirationStrategy": "immediate",
  "subscriptionInterval": "string",
  "subscriptionStartTrigger": "creation",
  "fingerprintMatchingStrategy": "fuzzy",
  "allowedActivations": 0,
  "allowedDeactivations": 0,
  "type": "node-locked",
  "keyPattern": "string",
  "leaseDuration": 0,
  "allowClientLeaseDuration": true,
  "leasingStrategy": "per-machine",
  "allowedFloatingClients": 0,
  "serverSyncGracePeriod": 0,
  "serverSyncInterval": 0,
  "cryptoBindingEnabled": true,
  "allowedClockOffset": 0,
  "expiringSoonEventOffset": 0,
  "requireAuthentication": true,
  "requiredMetadataKeys": [
    "string"
  ],
  "requiredMeterAttributes": [
    "string"
  ]
}