Product API

The Notehub product API provides RESTful methods that can be used to GET and POST product data.

Get Products

Get an array of products from a Notehub project, using a ProjectUID.

Minimum Notehub project-level role required:

Arguments

access_token

string

A Notehub API bearer token.

projectUID

string

The ProjectUID of a Notehub project.

curl -X GET
    -L 'https://api.notefile.net/v1/projects/<projectUID>/products'
    -H 'Authorization: Bearer <access_token>'
Response Members

product_uid

string

The globally-unique identifier for the product.

label

string

The user-defined label of the product.

auto_provision_fleets

string

An array of globally-unique FleetUIDs to which new devices will automatically be provisioned.

disable_devices_by_default

boolean

If true, devices provisioned to this product will be automatically disabled by default.

Example Response
{
  "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 Product

Create a new Notehub product using a ProjectUID.

Minimum Notehub project-level role required:

Arguments

access_token

string

A Notehub API bearer token.

projectUID

string

The ProjectUID of a Notehub project.

product_uid

string

The requested ProductUID (without the reverse URL prefix notation).

label

string

The requested label for the product.

fleet_uids

string array (optional)

An array of FleetUIDs to which new devices should be auto-assigned.

disable_devices

boolean (optional)

If true, devices provisioned to this product will be automatically disabled by default.

curl -X POST
     -L 'https://api.notefile.net/v1/projects/<projectUID>/products'
     -H 'Authorization: Bearer <access_token>'
     -d '{"product_uid":"<product_uid>", "label":"<label>"}'
curl -X POST
     -L 'https://api.notefile.net/v1/projects/<projectUID>/products'
     -H 'Authorization: Bearer <access_token>'
     -d '{"product_uid":"<product_uid>", "label":"<label>", "auto_provision_fleets":"{fleet_uids}", "disable_devices_by_default":"{disable_devices}"}'
Response Members

uid

string

The globally-unique identifier for the product.

label

string

The user-defined label of the product.

auto_provision_fleets

string array

The globally-unique fleet identifiers to which new devices will automatically be provisioned.

disable_devices_by_default

boolean

Whether or not new devices will be disabled by default.

Example Response
{
  "uid": "com.blues.test:product",
  "label": "My Product Label",
  "auto_provision_fleets": null,
  "disable_devices_by_default": false
}