License API
Products
Get Product Details
7min
schema request query parameters type productdetailsrequestparameters = { // required parameters product string, // required for key based products license key string // required for user based products username string // optional parameters license id? string | undefined, include latest version? boolean | undefined, include custom fields? boolean | undefined, } json schema response body type productdetailsresponsebody = { product id number; product name string; short code string; authorization method "license key" | "user"; floating timeout number; max overages number; trial days number; allow overages boolean; allow trial boolean; prevent vm boolean; metadata json; // this property is only present if "include custom fields" query param is true custom fields? { id number; name string; default value string; }\[] | undefined; // this property is only present if "include latest version" query param is true latest version? { version string | null; environment string | null; hash md5 string | null; eula link string | null; release notes link string | null; size string | null; requires version string | null; channel string | null; release date string | null; id number; product id number; enabled boolean; full link string | null; filename string | null; created at string; // date string in full iso 8601 format, e g "2024 09 27t23 30 48 016z" updated at string; // date string in full iso 8601 format, e g "2024 09 27t23 30 48 016z" } | undefined; } json schema if product does not have a version defined, it will return null if product does not have any custom fields defined, it will return an empty array 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 unknown product (400) provided product was not found missing headers (400) some headers are missing missing parameters (400) some parameters are missing in the request { params }