Rate this page
- ★★
- ★★
- ★★
- ★★
- ★★
Can we improve this page? Send us feedbackRate this page
- ★★
- ★★
- ★★
- ★★
- ★★
The Notehub product API provides RESTful methods that can be used to GET and
POST product data.
Get an array of products from a Notehub project, using a ProjectUID.
Minimum Notehub project-level role required:
curl -X GET -L 'https://api.notefile.net/v1/projects/<projectUID>/products' -H 'Authorization: Bearer <access_token>'
product_uidstring
The globally-unique identifier for the product.
labelstring
The user-defined label of the product.
auto_provision_fleetsstring
An array of globally-unique FleetUIDs to which new devices will automatically be provisioned.
disable_devices_by_defaultboolean
If true, devices provisioned to this product will be automatically disabled by
default.
{ "products": [ { "uid": "product:com.your-company.your-name:project", "label": "My Notehub Product", "auto_provision_fleets": ["fleet:00000000-0000-0000-0000-000000000000"], "disable_devices_by_default": false } ] }
Create a new Notehub product using a ProjectUID.
Minimum Notehub project-level role required:
access_tokenstring
A Notehub API bearer token.
projectUIDstring
The ProjectUID of a Notehub project.
product_uidstring
The requested ProductUID (without the reverse URL prefix notation).
labelstring
The requested label for the product.
fleet_uidsstring array (optional)
An array of FleetUIDs to which new devices should be auto-assigned.
disable_devicesboolean (optional)
If true, devices provisioned to this product will be automatically disabled by
default.
uidstring
The globally-unique identifier for the product.
labelstring
The user-defined label of the product.
auto_provision_fleetsstring array
The globally-unique fleet identifiers to which new devices will automatically be provisioned.
disable_devices_by_defaultboolean
Whether or not new devices will be disabled by default.
{ "uid":"com.blues.test:product", "label":"My Product Label", "auto_provision_fleets":null, "disable_devices_by_default":false }