Get Product Details

7min
Returns all metadata for a product
GET
Request
Query Parameters
product
required
String
Product short code
include_latest_version
optional
Boolean
include_custom_fields
optional
Boolean
 
Header Parameters
Date
required
String
In RFC7231 format (see "License API Authorization"), eg.: Thu, 17 Nov 2022 20:51:35 GMT
Authorization
required
String
See "License API Authorization" article
Curl
Node.js
JS
Python
Ruby
import requests

url = "/api/v4/product_details?product=string"

payload={}
headers = {
   'Accept': 'application/json',
   'Date': 'string',
   'Authorization': 'string'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

import requests

url = "/api/v4/product_details?product=string"

payload={}
headers = {
   'Accept': 'application/json',
   'Date': 'string',
   'Authorization': 'string'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)
Responses
200
404
{
    "product_id": 1683881296184003,
    "product_name": "p",
    "short_code": "p",
    "allow_trial": false,
    "trial_days": 0,
    "authorization_method": "license-key",
    "allow_overages": false,
    "max_overages": 0,
    "prevent_vm": false,
    "floating_timeout": 5,
    "metadata": {}
}
{
    "product_id": 1683881296184003,
    "product_name": "p",
    "short_code": "p",
    "allow_trial": false,
    "trial_days": 0,
    "authorization_method": "license-key",
    "allow_overages": false,
    "max_overages": 0,
    "prevent_vm": false,
    "floating_timeout": 5,
    "metadata": {}
}
﻿
Schema
Request Query Parameters
TypeScript
JSON
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,
}
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,
}
﻿
Response Body
TypeScript
JSON
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;
}
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;
}
﻿
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:
TypeScript
{
  status: number,
  code: string,
  message: string
}
{
  status: number,
  code: string,
  message: string
}
﻿
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 }
﻿
Updated 17 Jan 2025
Did this page help you?
List Products
Device Variables