License API
Product Details

6min
This endpoint provides all the generic flags for product. Only product is required as query parameter.
﻿
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
eq. Thu, 17 Nov 2022 20:51:35 GMT
Authorization
required
String
See signing of the License API calls 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": {}
}
﻿
Optional Query Parametars
include_latest_version
Adding bolean include_latest_version query parametar will return additional fields in response:
JSON
"latest_version": {
        "id": 2,
        "created_at": "2023-11-10T12:20:04.934Z",
        "updated_at": "2023-11-10T12:20:04.934Z",
        "version": "v1.0.1",
        "full_link": "",
        "filename": null,
        "release_date": "2023-11-10",
        "enabled": true,
        "hash_md5": "",
        "product_id": 1,
        "environment": "linux",
        "eula_link": "",
        "release_notes_link": "",
        "size": null,
        "requires_version": "v1.0.0.",
        "channel": null
}
"latest_version": {
        "id": 2,
        "created_at": "2023-11-10T12:20:04.934Z",
        "updated_at": "2023-11-10T12:20:04.934Z",
        "version": "v1.0.1",
        "full_link": "",
        "filename": null,
        "release_date": "2023-11-10",
        "enabled": true,
        "hash_md5": "",
        "product_id": 1,
        "environment": "linux",
        "eula_link": "",
        "release_notes_link": "",
        "size": null,
        "requires_version": "v1.0.0.",
        "channel": null
}
﻿
If product does not have a version defined, it will return null
include_custom_fields
Adding bolean include_custom_fields query parametar will return additional fields in response:
JSON
"custom_fields": [
        {
            "name": "Test",
            "id": 3,
            "default_value": "Lite"
        }
]
"custom_fields": [
        {
            "name": "Test",
            "id": 3,
            "default_value": "Lite"
        }
]
﻿
If product does not have any custom fields defined, it will return an empty array
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 22 Nov 2023
Did this page help you?
User Licenses
Device Variables