Create Product

Creates a product if requesting manager has access permissions to it.

• Method: POST

• URL: /api/v1/products/

• Try it out: false

Example request

Request body (application/json)

{
    "active": true,
    "product_name": "tmc4",
    "short_code": "tmc4",
    "default_license_type": "perpetual",
    "subscription_duration": "",
    "valid_duration": "",
    "enable_maintenance_period": false,
    "maintenance_duration": "",
    "max_consumptions": 1,
    "allow_overages": false,
    "max_overages": 0,
    "reset_consumption": false,
    "consumption_period": null,
    "is_floating": false,
    "is_floating_cloud": false,
    "floating_users": 0,
    "floating_timeout": 120,
    "max_activations": 1,
    "allow_trial": false,
    "trial_days": 0,
    "authorization_method": "license-key",
    "prevent_vm": false,
    "hardware_id_required": false,
    "is_upgrade": false,
    "upgrade_from": [],
    "is_node_locked": true,
    "is_user_locked": false
}

Example responses

200

{
    "id": 1717144102531927,
    "upgrade_from": [],
    "product_features": [],
    "custom_fields": [],
    "license_templates": [
        {
            "id": 974,
            "license_product_feature_templates": [],
            "license_custom_field_templates": [],
            "created_at": "2024-05-31T08:28:22.755821Z",
            "updated_at": "2024-05-31T08:28:22.755854Z",
            "name": "Default license policy",
            "code": "dftlp",
            "is_default": true,
            "default_license_type": "perpetual",
            "allow_trial": false,
            "trial_days": 0,
            "max_activations": 1,
            "allow_unlimited_activations": false,
            "max_license_users": 1,
            "is_floating": false,
            "is_floating_cloud": false,
            "floating_users": 0,
            "floating_timeout": 120,
            "enable_maintenance_period": false,
            "maintenance_duration": "",
            "prevent_vm": false,
            "valid_duration": "",
            "allow_grace_period": false,
            "grace_period": 0,
            "max_consumptions": 1,
            "allow_unlimited_consumptions": false,
            "allow_overages": false,
            "max_overages": 0,
            "reset_consumption": false,
            "consumption_period": null,
            "max_transfers": 0,
            "is_air_gapped": false,
            "can_borrow": false,
            "max_borrow_time": 0,
            "is_archived": false,
            "is_hardware_key_auth": false,
            "metadata": {},
            "product": 1717144102531927
        }
    ],
    "installation_files": [],
    "created_at": "2024-05-31T08:28:23Z",
    "updated_at": "2024-05-31T08:28:23Z",
    "product_name": "tmc4",
    "short_code": "tmc4",
    "active": true,
    "valid_duration": "",
    "allow_trial": false,
    "trial_days": 0,
    "max_activations": 1,
    "hardware_id_required": false,
    "is_upgrade": false,
    "subscription_duration": "",
    "enable_maintenance_period": false,
    "maintenance_duration": "",
    "is_floating": false,
    "is_floating_cloud": false,
    "floating_users": 0,
    "floating_timeout": 120,
    "default_license_type": "perpetual",
    "is_user_locked": false,
    "is_node_locked": true,
    "max_consumptions": 1,
    "authorization_method": "license-key",
    "prevent_vm": false,
    "allow_overages": false,
    "max_overages": 0,
    "reset_consumption": false,
    "consumption_period": null,
    "is_archived": false,
    "is_bundle": false,
    "metadata": {},
    "company": 277
}

Request body parameters

Name	Required	Type	Description
product_name	required	string
short_code	required	string	only accepts alphanumeric characters, digits and dashes.
active	optional	boolean	boolean
default_license_type	optional	string	values can be perpetual, subscription, time-limited, and consumption.
subscription_duration	optional	string
valid_duration	optional	string
enable_maintenance_period	optional	boolean	boolean
maintenance_duration	optional	string
max_consumptions	optional	integer	integer
allow_overages	optional	boolean	boolean
max_overages	optional	integer	integer
reset_consumption	optional	boolean	boolean
consumption_period	optional	string
is_floating	optional	boolean	boolean
is_floating_cloud	optional	boolean	boolean
floating_users	optional	integer	integer
floating_timeout	optional	integer	integer
max_activations	optional	integer	integer
allow_trial	optional	boolean	boolean
trial_days	optional	integer	integer
authorization_method	optional	string	values can be license-key, user.
prevent_vm	optional	boolean	boolean
hardware_id_required	optional	boolean	boolean
is_upgrade	optional	boolean	boolean
upgrade_from	optional	string	list of product IDs
is_node_locked	optional	boolean	boolean
is_user_locked	optional	boolean	boolean

Notes

• The endpoint creates a product only if the requesting manager has access permissions to it.

• Created at / Updated at timestamps are present in recorded responses.