License Feature Check

tab examples url api v4 check license feature name api v4 check license feature method get request pathparameters queryparameters kind required name hardware id type string children description unique hardware id generated for the client device kind required name product type string children description product short code name feature kind required type string description feature code children kind optional name license key type string children description required if product is key based see section below kind optional name username type string children description required if product is user based see section below name license id kind optional type number description ensures that the action affects only the license with the specified id this is useful if e g you have multiple licenses for the same product assigned to the same user for obtaining a list of licenses assigned to a user see user licenses children headerparameters kind required name date type string children description in rfc7231 format see license api authorization eg thu 17 nov 2022 20 51 35 gmt kind required name authorization type string children description see license api authorization article bodydataparameters formdataparameters results languages id qlx3ifr3fpkeqnnhkuaxk code n id 1698664358119314 n code f0 n name f0 n feature type activation n expiry date null n metadata n is floating false n is floating cloud true n floating timeout 120 n floating users 8 n floating in use devices 1 n license id 1698662161371339 n language 200 customlabel selectedlanguageid qlx3ifr3fpkeqnnhkuaxk examples languages id lhd uaiv7ofbyvv2llluw language curl code curl location request get api v4 check license feature?hardware id string product string feature string n header accept application json n header content type application json customlabel id wzw1bjdviqlggtv4tmczd language nodejs code var request require request ; nvar options n method get n url api v4 check license feature?hardware id string product string feature string n headers n accept application json n content type application json n n ; nrequest options function error response n if error throw new error error ; n console log response body ; n ; n customlabel id ptibgbayc3qu8zefyftps language javascript code var myheaders new headers ; nmyheaders append accept application json ; nmyheaders append content type application json ; n nvar requestoptions n method get n headers myheaders n redirect follow n ; n nfetch api v4 check license feature?hardware id string product string feature string requestoptions n then response response text n then result console log result n catch error console log error error ; customlabel id kobjoqpaifqa2b0gcaqrg language python code import requests nimport json n nurl api v4 check license feature?hardware id string product string feature string n npayload nheaders n accept application json n content type application json n n nresponse requests request get url headers headers data payload n nprint response text n customlabel id teywqeggmgjqtmeopjpyl language ruby code require uri nrequire json nrequire net http n nurl uri api v4 check license feature?hardware id string product string feature string n nhttp net http new url host url port ; nrequest net http get new url nrequest accept application json nrequest content type application json n nresponse http request request nputs response read body n customlabel selectedlanguageid lhd uaiv7ofbyvv2llluw description checks a license device against a license feature once checked this device will be connected to the feature if a feature is a floating feature device will also take one floating slot if available n currentnewparameter label query parameter value queryparameters schema request query parameters type licensefeaturecheckrequestparams = ({ // for key based licenses license key string } | { // for user based licenses username string }) & { // required properties hardware id string product string feature string // optional properties license id? number | undefined } json schema { "$schema" "https //json schema org/draft/2020 12/schema", "type" "object", "allof" \[ { "oneof" \[ { "type" "object", "properties" { "license key" { "type" "string" } }, "required" \["license key"], "additionalproperties" false }, { "type" "object", "properties" { "username" { "type" "string" } }, "required" \["username"], "additionalproperties" false } ] }, { "type" "object", "properties" { "hardware id" { "type" "string" }, "product" { "type" "string" }, "feature" { "type" "string" }, "license id" { "type" \["number", "null"] } }, "required" \["hardware id", "product", "feature"], "additionalproperties" false } ] } response body type licensefeaturecheckresponsebody = { allow negative consumptions boolean, allow overages boolean, allow unlimited consumptions boolean, code string, consumption period string, expiry date null | string, feature type string, id number, is floating cloud boolean, is floating boolean, license id number, max consumption number, max overages number, metadata json, name string, reset consumption boolean, total consumptions number, // the following property is only present on floating and floating cloud features floating in use devices? number, } json schema { "$schema" "https //json schema org/draft/2020 12/schema", "type" "object", "properties" { "allow negative consumptions" { "type" "boolean" }, "allow overages" { "type" "boolean" }, "allow unlimited consumptions" { "type" "boolean" }, "code" { "type" "string" }, "consumption period" { "type" "string" }, "expiry date" { "type" \["string", "null"] }, "feature type" { "type" "string" }, "id" { "type" "number" }, "is floating cloud" { "type" "boolean" }, "is floating" { "type" "boolean" }, "license id" { "type" "number" }, "max consumption" { "type" "number" }, "max overages" { "type" "number" }, "metadata" { "type" "object" }, "name" { "type" "string" }, "reset consumption" { "type" "boolean" }, "total consumptions" { "type" "number" }, "floating in use devices" { "type" "number" } }, "required" \[ "allow negative consumptions", "allow overages", "allow unlimited consumptions", "code", "consumption period", "expiry date", "feature type", "id", "is floating cloud", "is floating", "license id", "max consumption", "max overages", "metadata", "name", "reset consumption", "total consumptions" ], "additionalproperties" false } response contains a license feature fields floating in use devices number of devices currenly in use on this license feature license id id of the license errors if an error occurs, the response will have an http status code of 400 or higher, and the response body will contain an error description in the following format { status number, code string, message string } json schema { "$schema" "https //json schema org/draft/2020 12/schema", "type" "object", "properties" { "status" { "type" "number" }, "code" { "type" "string" }, "message" { "type" "string" } }, "required" \[ "status", "code", "message" ], "additionalproperties" false } list of exceptions