Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Panel

PATCH /license-orders/activation_key

where:

Request JSON Objects

Valid JSON parameters include the following.

ParameterTypeRequiredDefinition

customer_id 

integerYesCustomer ID.
product_template_id integerYesProduct template ID.
license_typestringYesLicense type, choices: local, network.
licensee_typestringYesLicensee type, choices: fixed, customer, not_specified.
licensee stringYes*No

Licensee.

*Required

License, required 

if licensee type is fixed.

hostid_match_rate integerYesHostID match rate.
min_hostids integerYesMinimum HostIDs.
activations_allowed integerYesActivations allowed.
enabled booleanYesWhether license order is enabled or not.
descriptionstringNoDescription.
settings_descriptionstringNoSettings description.
removal booleanYesWhether license should be removed from host.
deactivations_allowed booleanintegerNoWhether deactivation is allowed.
HostidsarrayYesList of HostIDs.
Features arrayYesList of features.

HostID parameters include the following.

ParameterTypeRequiredDefinition

name

stringYesHostID name.
min_amount integerYesMinimum required.
max_amountintegerYesMaximum allowed.

Feature parameters include the following.

ParameterTypeRequiredDefinition

name

stringYesFeature name.
version stringYesVersion.
expiration_type stringYesExpiration type, choices: fixed, days_from_activation, no_expiration.
expiration_datestringYes*

Expiration date.

*Required , required if expiration type is fixed.

days_from_activation stringYes*

Expiration days from activation.

*Required if expiration type is days_from_activation.

issued_type stringYesIssued type, choices: fixed, not_issued, activation_time.
issued_datestringYes*

Issued date

, required if

.

*Required if issued type is fixed.

options stringNoOptions.
additional_settings stringNoAdditional settings.
enabled booleanYesNoWhether feature is enabled or notdays_from_activation stringYesExpiration days from activation, required if expiration type is days_from_activation.
count integerYes*

Count

, required if

.

*Required if license type is network.

maintenance_type stringYesMaintenance type, choices: fixed, days_from_activation, no_maintenance.
maintenance_date stringYes*

Maintenance date

, required if

.

*Required if maintenance type is fixed.

maintenance_days_from_activationstringYes*

Maintenance days from activation

, required if

.

*Required if maintenance type is days_from_activation.

comment stringNoComment.

Example request

Code Block
PATCH /license-orders/II1HP-TX8EQ-R1QXZ-7LYXF HTTP/1.1
Content-Type: application/json
Authorization: Bearer f794846b7c26621688e1e06164975b4eae8ce2f6

{
	"customer_id": 1,
	"product_template_id": 1,
	"license_type": "network",
	"licensee_type": "customer",
	"hostid_match_rate": 100,
	"min_hostids": 1,
	"activations_allowed": 10,
	"enabled": true,
	"description": "License order description",
	"settings_description": "Settings description",
	"removal": false,
	"deactivations_allowed": 10,
	"Hostids": [
		{
			"name": "hostname",
			"min_amount": 1,
			"max_amount": 1
		}
	],
	"Features": [
		{
			"name": "Licstat",
			"version": "6.0",
			"expiration_type": "days_from_activation",
			"days_from_activation": 90,
			"issued_type": "activation_time",
			"options": "Feature options",
		`	"additional_settings": "Additional settings",
			"count": 15,
			"maintenance_type": "fixed",
			"maintenance_date": "2020-12-31",
			"enabled": true,
			"comment": "Feature comment"
		}
	]
}

...