Product

Manage Products.

Download

Download device agent software.

Endpoint

POST /product/download

Authorized User Role

user

Request Body

Field	Type	Required	Notes
image	string	yes	Image name.
planId	string		Plan ID.

Response

The download URL for the requested image.

Find

Get a list of products.

Endpoint

POST /product/find

Authorized User Role

user

Request Body

Field	Type	Notes

Query String Options

Field	Type	Default	Notes
index	string		Index name: primary or gs1.
limit	number		Limit number of results.
next	object		Token for next page.
prev	object		Token for previous page.

Response

Paged response.

Field	Type	Notes
data	array	An array of Product records.
next	string	Paged cursor to use for the next page of items.
prev	string	Pages cursor to use for the previous page of items.

Product

Field	Type	Notes
accountId	string	Owning account ID.
description	string	Product description.
id	string	Product ID.
name	string	Product name.
planId	string	Owning plan ID.
suspended	boolean	Product suspended.
url	string	Product URL.

Get

Get a product definition by ID.

Endpoint

POST /product/get

Authorized User Role

user

Request Body

Field	Type	Required	Notes
id	string	yes	Product ID.

Response

Product Record.

Field	Type	Notes
accountId	string	Owning account ID.
description	string	Product description.
id	string	Product ID.
name	string	Product name.
planId	string	Owning plan ID.
suspended	boolean	Product suspended.
url	string	Product URL.

Update

Update a product definition.

Endpoint

POST /product/update

Authorized User Role

admin

Request Body

Field	Type	Notes
advance	boolean	Payment in advance.
align	boolean	Align billing with plan period.
agent	string	Licensed agent.
approved	boolean	Suscription requires user approval.
created	date	Created.
description	string	Product description.
id	string	Product ID.
end	date	End of plan period.
license	string	License type.
name	string	Unique simple name without spaces.
notify	array	Email addresses for product alerts.
period	string	Plan period.
planId	string	Plan ID.
scope	string	License scope: product, family, business.
start	date	Start of subscription plan.
type	string	License type: volume, subscription, business, agreement.
units	number	Number of devices for volume limited scriptions.
url	string	Company website URL.

Response

Product Record.

Field	Type	Notes
accountId	string	Owning account ID.
description	string	Product description.
id	string	Product ID.
name	string	Product name.
planId	string	Owning plan ID.
suspended	boolean	Product suspended.
url	string	Product URL.