License API
License Feature Check
9min
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 missing headers (400) some headers are missing unknown product (400) provided product was not found license not found (400) license with the provided license user not found license not enabled (400) the license is not enabled license not active (400) the license is not active device not found (400) an active device matching the hardware id not found blacklisted (400) this device is blacklisted invalid license feature code (400) license feature code ' + param + ' is invalid or not assigned to the license floating not available (400) no available slots for floating license