Scaling an IoT deployment? Join our webinar on May 28th where we dive into real-world scaling pain points and how to overcome them.

Blues Developers
What’s New
Resources
Blog
Technical articles for developers
Newsletter
The monthly Blues developer newsletter
Terminal
Connect to a Notecard in your browser
Developer Certification
Get certified on wireless connectivity with Blues
Webinars
Listing of Blues technical webinars
Blues.comNotehub.io
Shop
Docs
Button IconHelp
Notehub StatusVisit our Forum
Button IconSign In
Sign In
Sign In
Docs Home
What’s New
Resources
Blog
Technical articles for developers
Newsletter
The monthly Blues developer newsletter
Terminal
Connect to a Notecard in your browser
Developer Certification
Get certified on wireless connectivity with Blues
Webinars
Listing of Blues technical webinars
Blues.comNotehub.io
Shop
Docs
API Reference
Glossary
System Notefiles
Notecard API
Introduction
card Requests
dfu Requests
env Requests
file Requests
hub Requests
note Requests
ntn Requests
var Requests
web Requests
Notehub API
API Introduction
Authorization API
Billing Account API
Device API
Event API
Monitor API
Project API
Get ProjectsGet ProjectGet Project by ProductCreate ProjectDelete ProjectClone ProjectGet Project MembersCreate ProductGet ProductsGet Project Environment VariablesDelete Project Environment VariableSet Project Environment VariablesGet Fleet Environment VariablesDelete Fleet Environment VariableSet Fleet Environment VariablesGet FleetGet FleetsCreate FleetUpdate FleetDelete FleetGet Device FleetsAdd Device to FleetsRemove Device from FleetsSet Global JSONata TransformEnable Global JSONata TransformDisable Global JSONata TransformGet Devices DFU HistoryGet Devices DFU StatusGet Device DFU HistoryGet Device DFU StatusGet Available FirmwareCreate DFU Action
Route API
homechevron_rightDocschevron_rightAPI Referencechevron_rightNotehub APIchevron_rightProject API - Notehub API Reference

Project API

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

NameHTTP Request
Get ProjectsGET /v1/projects
Get ProjectGET /v1/projects/{projectUID}
Get Project by ProductGET /v1/products/{productUID}/project
Create ProjectPOST /v1/projects
Delete ProjectDELETE /v1/projects/{projectUID}
Clone ProjectPOST /v1/projects/{projectUID}/clone
Get Project MembersGET /v1/projects/{projectUID}/members
Create ProductPOST /v1/projects/{projectUID}/products
Get ProductsGET /v1/projects/{projectUID}/products
Get Project Environment VariablesGET /v1/projects/{projectUID}/environment_variables
Delete Project Environment VariableDELETE /v1/projects/{projectUID}/environment_variables/{key}
Set Project Environment VariablesPUT /v1/projects/{projectUID}/environment_variables
Get Fleet Environment VariablesGET /v1/projects/{projectUID}/fleets/{fleetUID}/environment_variables
Delete Fleet Environment VariableDELETE /v1/projects/{projectUID}/fleets/{fleetUID}/environment_variables/{key}
Set Fleet Environment VariablesPUT /v1/projects/{projectUID}/fleets/{fleetUID}/environment_variables
Get FleetGET /v1/projects/{projectUID}/fleets/{fleetUID}
Get FleetsGET /v1/projects/{projectUID}/fleets
Create FleetPOST /v1/projects/{projectUID}/fleets
Update FleetPUT /v1/projects/{projectUID}/fleets/{fleetUID}
Delete FleetDELETE /v1/projects/{projectUID}/fleets/{fleetUID}
Get Device FleetsGET /v1/projects/{projectUID}/devices/{deviceUID}/fleets
Add Device to FleetsPUT /v1/projects/{projectUID}/devices/{deviceUID}/fleets
Remove Device from FleetsDELETE /v1/projects/{projectUID}/devices/{deviceUID}/fleets
Set Global JSONata TransformPOST /v1/projects/{projectUID}/global-transformation
Enable Global JSONata TransformPOST /v1/projects/{projectUID}/global-transformation/enable
Disable Global JSONata TransformPOST /v1/projects/{projectUID}/global-transformation/disable
Get Devices DFU HistoryGET /v1/projects/{projectUID}/dfu/{firmwareType}/history
Get Devices DFU StatusGET /v1/projects/{projectUID}/dfu/{firmwareType}/status
Get Device DFU HistoryGET /v1/projects/{projectUID}/devices/{deviceUID}/dfu/{firmwareType}/history
Get Device DFU StatusGET /v1/projects/{projectUID}/devices/{deviceUID}/dfu/{firmwareType}/status
Get Available FirmwareGET /v1/projects/{projectUID}/firmware
Create DFU ActionPOST /v1/projects/{projectUID}/dfu/{firmwareType}/{action}

Get Projects Notehub

Get all Notehub projects accessible by provided authentication token.

HTTP Method:GET
URL:https://api.notefile.net/v1/projects
Minimum Notehub project-level role:viewer
Required HTTP Headers:Authorization: Bearer <access_token>, where the access token is a Notehub API bearer token.
Arguments
None
curl -X GET
    -L 'https://api.notefile.net/v1/projects'
    -H 'Authorization: Bearer <access_token>'
import * as NotehubJs from "@blues-inc/notehub-js";
let defaultClient = NotehubJs.ApiClient.instance;
// Configure API key authorization: api_key
let api_key = defaultClient.authentications["api_key"];
api_key.apiKey = "YOUR API KEY";

let apiInstance = new NotehubJs.ProjectApi();
apiInstance.getProjects().then(
  (data) => {
    console.log(
      "API called successfully. Returned data: " + JSON.stringify(data)
    );
  },
  (error) => {
    console.error(error);
  }
);
import notehub_py
from notehub_py.models.get_projects200_response import GetProjects200Response
from notehub_py.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.notefile.net
configuration = notehub_py.Configuration(
    host = "https://api.notefile.net"
)

# Configure API key authorization: api_key
configuration.api_key["api_key"] = os.environ["API_KEY"]

# Enter a context with an instance of the API client
with notehub_py.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = notehub_py.ProjectApi(api_client)

    try:
        api_response = api_instance.get_projects()
        print("The response of ProjectApi->get_projects:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectApi->get_projects: %s\n" % e)
Response Members

uid

string

The globally-unique identifier of the project.

label

string

The user-assigned label for the project.

created

string

The date and time the project was created in Notehub.

administrative_contact

object

Contact information for the administrative contact assigned in Notehub.

technical_contact

object

Contact information for the technical contact assigned in Notehub.

role

string

The role of the project member creating the API request.

Example Response
{
  "projects": [
    {
      "uid": "app:00000000-0000-0000-0000-000000000000",
      "label": "First Notehub Project",
      "created": "2021-04-26T19:11:05Z",
      "administrative_contact": {
        "name": "John Doe",
        "email": "someone@example.com",
        "role": "Admin",
        "organization": "Blues"
      },
      "technical_contact": {
        "name": "Jane Doe",
        "email": "someone@example.com",
        "role": "Tech",
        "organization": "Blues"
      },
      "role": "owner"
    },
    {
      "uid": "app:00000000-0000-0000-0000-000000000000",
      "label": "Second Notehub Project",
      "created": "2022-07-26T19:11:05Z",
      "administrative_contact": {
        "name": "Jane Doe",
        "email": "someone@example.com",
        "role": "Admin",
        "organization": "Blues"
      },
      "technical_contact": {
        "name": "John Doe",
        "email": "someone@example.com",
        "role": "Tech",
        "organization": "Blues"
      },
      "role": "owner"
    }
  ]
}

Get Project Notehub

Get information about a Notehub project by ProjectUID.

HTTP Method:GET
URL:https://api.notefile.net/v1/projects/{projectUID}
Path Parameters:
  • projectUID - The ProjectUID of a Notehub project.
Minimum Notehub project-level role:viewer
Required HTTP Headers:Authorization: Bearer <access_token>, where the access token is a Notehub API bearer token.
Arguments
None
curl -X GET
    -L 'https://api.notefile.net/v1/projects/<projectUID>'
    -H 'Authorization: Bearer <access_token>'
import * as NotehubJs from "@blues-inc/notehub-js";
let defaultClient = NotehubJs.ApiClient.instance;
// Configure API key authorization: api_key
let api_key = defaultClient.authentications["api_key"];
api_key.apiKey = "YOUR API KEY";

let apiInstance = new NotehubJs.ProjectApi();
let projectUID = "app:2606f411-dea6-44a0-9743-1130f57d77d8"; // String |
apiInstance.getProject(projectUID).then(
  (data) => {
    console.log(
      "API called successfully. Returned data: " + JSON.stringify(data)
    );
  },
  (error) => {
    console.error(error);
  }
);
import notehub_py
from notehub_py.models.project import Project
from notehub_py.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.notefile.net
configuration = notehub_py.Configuration(
    host = "https://api.notefile.net"
)

# Configure API key authorization: api_key
configuration.api_key["api_key"] = os.environ["API_KEY"]

# Enter a context with an instance of the API client
with notehub_py.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = notehub_py.ProjectApi(api_client)
    project_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | 

    try:
        api_response = api_instance.get_project(project_uid)
        print("The response of ProjectApi->get_project:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectApi->get_project: %s\n" % e)
Response Members

uid

string

The globally-unique identifier of the project.

label

string

The user-assigned label for the project.

created

string

The date and time the project was created in Notehub.

administrative_contact

object

Contact information for the administrative contact assigned in Notehub.

technical_contact

object

Contact information for the technical contact assigned in Notehub.

role

string

The role of the project member creating the API request.

Example Response
{
  "uid": "app:00000000-0000-0000-0000-000000000000",
  "label": "My Notehub Project",
  "created": "2021-04-26T19:11:05Z",
  "administrative_contact": {
    "name": "John Doe",
    "email": "someone@example.com",
    "role": "Admin",
    "organization": "Blues"
  },
  "technical_contact": {
    "name": "Jane Doe",
    "email": "someone@example.com",
    "role": "Tech",
    "organization": "Blues"
  },
  "role": "owner"
}

Get Project by Product Notehub

Get information about a Notehub project by ProductUID.

HTTP Method:GET
URL:https://api.notefile.net/v1/products/{productUID}/project
Path Parameters:
  • productUID - The ProductUID of a Notehub project.
Minimum Notehub project-level role:viewer
Required HTTP Headers:Authorization: Bearer <access_token>, where the access token is a Notehub API bearer token.
Arguments
None
curl -X GET
    -L 'https://api.notefile.net/v1/products/<productUID>/project'
    -H 'Authorization: Bearer <access_token>'
import * as NotehubJs from "@blues-inc/notehub-js";
let defaultClient = NotehubJs.ApiClient.instance;
// Configure API key authorization: api_key
let api_key = defaultClient.authentications["api_key"];
api_key.apiKey = "YOUR API KEY";

let apiInstance = new NotehubJs.ProjectApi();
let productUID = "com.blues.airnote;" // String |
apiInstance.getProjectByProduct(productUID).then(
  (data) => {
    console.log(
      "API called successfully. Returned data: " + JSON.stringify(data)
    );
  },
  (error) => {
    console.error(error);
  }
);
import notehub_py
from notehub_py.models.project import Project
from notehub_py.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.notefile.net
configuration = notehub_py.Configuration(
    host = "https://api.notefile.net"
)

# Configure API key authorization: api_key
configuration.api_key["api_key"] = os.environ["API_KEY"]

# Enter a context with an instance of the API client
with notehub_py.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = notehub_py.ProjectApi(api_client)
    product_uid = "com.blues.airnote" # str | 

    try:
        api_response = api_instance.get_project_by_product(product_uid)
        print("The response of ProjectApi->get_project_by_product:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectApi->get_project_by_product: %s\n" % e)
Response Members

uid

string

The globally-unique identifier of the project.

label

string

The user-assigned label for the project.

created

string

The date and time the project was created in Notehub.

administrative_contact

object

Contact information for the administrative contact assigned in Notehub.

technical_contact

object

Contact information for the technical contact assigned in Notehub.

role

string

The role of the project member creating the API request.

Example Response
{
  "uid": "app:00000000-0000-0000-0000-000000000000",
  "label": "My Notehub Project",
  "created": "2021-04-26T19:11:05Z",
  "administrative_contact": {
    "name": "John Doe",
    "email": "someone@example.com",
    "role": "Admin",
    "organization": "Blues"
  },
  "technical_contact": {
    "name": "Jane Doe",
    "email": "someone@example.com",
    "role": "Tech",
    "organization": "Blues"
  },
  "role": "owner"
}

Create Project Notehub

Create a new Notehub project.

HTTP Method:POST
URL:https://api.notefile.net/v1/projects
Minimum Notehub project-level role:owner
Required HTTP Headers:Authorization: Bearer <access_token>, where the access token is a Notehub API bearer token.
Arguments

label

string

The label of the Notehub project.

billing_account_uid

string

The globally-unique identifier of the billing account. The caller of the API must be able to create projects within the specified billing account, otherwise an error will be returned. This identifier is available with a call to Get Billing Accounts.

curl -X POST
    -L 'https://api.notefile.net/v1/projects'
    -H 'Authorization: Bearer <access_token>'
    -d '{"label":"<label>", "billing_account_uid":"<my_billing_account_here>"}'
import * as NotehubJs from "@blues-inc/notehub-js";
let defaultClient = NotehubJs.ApiClient.instance;
// Configure API key authorization: api_key
let api_key = defaultClient.authentications["api_key"];
api_key.apiKey = "YOUR API KEY";

let apiInstance = new NotehubJs.ProjectApi();
let createProjectProps = {
  label: "My New Project", // String |
  billingAccountUid: "billing-account-uid" // String |
}
let createProjectRequest = new NotehubJs.CreateProjectRequest(createProjectProps); // CreateProjectRequest | Project to be created
apiInstance.createProject(createProjectRequest).then(
  (data) => {
    console.log(
      "API called successfully. Returned data: " + JSON.stringify(data)
    );
  },
  (error) => {
    console.error(error);
  }
);
import notehub_py
from notehub_py.models.create_project_request import CreateProjectRequest
from notehub_py.models.project import Project
from notehub_py.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.notefile.net
configuration = notehub_py.Configuration(
    host = "https://api.notefile.net"
)

# Configure API key authorization: api_key
configuration.api_key["api_key"] = os.environ["API_KEY"]

# Enter a context with an instance of the API client
with notehub_py.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = notehub_py.ProjectApi(api_client)
    project_request_props = {
        "label": "label_example",
        "billing_account_uid": "billing_account_uid_example"
    }
    create_project_request = notehub_py.CreateProjectRequest() # CreateProjectRequest | Project to be created

    try:
        api_response = api_instance.create_project(create_project_request)
        print("The response of ProjectApi->create_project:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectApi->create_project: %s\n" % e)
Response Members

uid

string

The globally-unique identifier of the project.

label

string

The user-assigned label for the project.

created

string

The date and time the project was created in Notehub.

administrative_contact

object

Contact information for the administrative contact assigned in Notehub. Will be null on newly-created projects.

technical_contact

object

Contact information for the technical contact assigned in Notehub. Will be null on newly-created projects.

role

string

The role of the project member creating the API request.

Example Response
{
  "uid": "app:00000000-0000-0000-0000-000000000000",
  "label": "My Notehub Project",
  "created": "2021-04-26T19:11:05Z",
  "administrative_contact": null,
  "technical_contact": null,
  "role": "owner"
}

Delete Project Notehub

Delete a Notehub project by ProjectUID.

HTTP Method:DELETE
URL:https://api.notefile.net/v1/projects/{projectUID}
Path Parameters:
  • projectUID - The ProjectUID of a Notehub project.
Minimum Notehub project-level role:owner
Required HTTP Headers:Authorization: Bearer <access_token>, where the access token is a Notehub API bearer token.
Arguments
None
curl -X DELETE
    -L 'https://api.notefile.net/v1/projects/<projectUID>'
    -H 'Authorization: Bearer <access_token>'
import * as NotehubJs from "@blues-inc/notehub-js";
let defaultClient = NotehubJs.ApiClient.instance;
// Configure API key authorization: api_key
let api_key = defaultClient.authentications["api_key"];
api_key.apiKey = "YOUR API KEY";

let apiInstance = new NotehubJs.ProjectApi();
let projectUID = "app:2606f411-dea6-44a0-9743-1130f57d77d8"; // String |
apiInstance.deleteProject(projectUID).then(() => {
  console.log("API called successfully.");
}, (error) => {
  console.error(error);
});
import notehub_py
from notehub_py.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.notefile.net
configuration = notehub_py.Configuration(
    host = "https://api.notefile.net"
)

# Configure API key authorization: api_key
configuration.api_key["api_key"] = os.environ["API_KEY"]

# Enter a context with an instance of the API client
with notehub_py.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = notehub_py.ProjectApi(api_client)
    project_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | 

    try:
        api_instance.delete_project(project_uid)
    except Exception as e:
        print("Exception when calling ProjectApi->delete_project: %s\n" % e)
Response Members
None: an empty object {} means success.

Clone Project Notehub

Clone a Notehub project.

HTTP Method:POST
URL:https://api.notefile.net/v1/projects/{projectUID}/clone
Path Parameters:
  • projectUID - The ProjectUID of a Notehub project.
Minimum Notehub project-level role:owner
Required HTTP Headers:Authorization: Bearer <access_token>, where the access token is a Notehub API bearer token.
Arguments

label

string

The user-assigned label for the project.

billing_account_uid

string

The globally-unique identifier of the billing account. The caller of the API must be able to create projects within the specified billing account, otherwise an error will be returned. This identifier is available with a call to Get Billing Accounts.

disable_clone_routes

boolean

Whether to disallow the cloning of the routes from the parent project. Default is false if not specified.

disable_clone_fleets

boolean

Whether to disallow the cloning of the fleets from the parent project. Default is false if not specified.

curl -X POST
    -L 'https://api.notefile.net/v1/projects/<projectUID>/clone'
    -H 'Authorization: Bearer <access_token>'
    -d '{"label":"<label>",
         "billing_account_uid":"<billing_account_uid>",
         "disable_clone_routes":<disable_clone_routes>,
         "disable_clone_fleets":<disable_clone_fleets>}'
import * as NotehubJs from "@blues-inc/notehub-js";
let defaultClient = NotehubJs.ApiClient.instance;
// Configure API key authorization: api_key
let api_key = defaultClient.authentications["api_key"];
api_key.apiKey = "YOUR API KEY";

let apiInstance = new NotehubJs.ProjectApi();
let projectUID = "app:2606f411-dea6-44a0-9743-1130f57d77d8"; // String | The project UID to be cloned.
let cloneProjectProps = {
  label: "My Cloned Project", // String |
  billingAccountUid: "billing-account-uid", // String |
  disableCloneRoutes: false, // Boolean |
  disableCloneFleets: true // Boolean |
}
let cloneProjectRequest = new NotehubJs.CloneProjectRequest(cloneProjectProps); // CloneProjectRequest | Project to be cloned
apiInstance.cloneProject(projectUID, cloneProjectRequest).then(
  (data) => {
    console.log(
      "API called successfully. Returned data: " + JSON.stringify(data)
    );
  },
  (error) => {
    console.error(error);
  }
);
import notehub_py
from notehub_py.models.clone_project_request import CloneProjectRequest
from notehub_py.models.project import Project
from notehub_py.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.notefile.net
configuration = notehub_py.Configuration(
    host = "https://api.notefile.net"
)

# Configure API key authorization: api_key
configuration.api_key["api_key"] = os.environ["API_KEY"]

# Enter a context with an instance of the API client
with notehub_py.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = notehub_py.ProjectApi(api_client)
    project_uid = "project_uid_example" # str | The project UID to be cloned.
    clone_project_props = {
        "label": "label_example",
        "billing_account_uid": "billing_account_uid_example",
        "disable_clone_routes": True,
        "disable_clone_fleets": True
    }
    clone_project_request = notehub_py.CloneProjectRequest(clone_project_props) # CloneProjectRequest | Project to be cloned

    try:
        api_response = api_instance.clone_project(project_uid, clone_project_request)
        print("The response of ProjectApi->clone_project:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectApi->clone_project: %s\n" % e)
Response Members

uid

string

The globally-unique identifier of the project.

label

string

The user-assigned label for the project.

created

string

The date and time the project was created in Notehub.

administrative_contact

object

Contact information for the administrative contact assigned in Notehub. Will be null on newly-created projects.

technical_contact

object

Contact information for the technical contact assigned in Notehub. Will be null on newly-created projects.

role

string

The role of the project member creating the API request.

Example Response
{
  "uid": "app:00000000-0000-0000-0000-000000000000",
  "label": "My Cloned Notehub Project",
  "created": "2021-04-26T19:11:05Z",
  "administrative_contact": null,
  "technical_contact": null,
  "role": "owner"
}

Get Project Members Notehub

Get all members from a Notehub project.

HTTP Method:GET
URL:https://api.notefile.net/v1/projects/{projectUID}/members
Path Parameters:
  • projectUID - The ProjectUID of a Notehub project.
Minimum Notehub project-level role:viewer
Required HTTP Headers:Authorization: Bearer <access_token>, where the access token is a Notehub API bearer token.
Arguments
None
curl -X GET
    -L 'https://api.notefile.net/v1/projects/<projectUID>/members'
    -H 'Authorization: Bearer <access_token>'
import * as NotehubJs from "@blues-inc/notehub-js";
let defaultClient = NotehubJs.ApiClient.instance;
// Configure API key authorization: api_key
let api_key = defaultClient.authentications["api_key"];
api_key.apiKey = "YOUR API KEY";

let apiInstance = new NotehubJs.ProjectApi();
let projectUID = "app:2606f411-dea6-44a0-9743-1130f57d77d8"; // String |
apiInstance.getProjectMembers(projectUID).then(
  (data) => {
    console.log(
      "API called successfully. Returned data: " + JSON.stringify(data)
    );
  },
  (error) => {
    console.error(error);
  }
);
import notehub_py
from notehub_py.models.get_project_members200_response import GetProjectMembers200Response
from notehub_py.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.notefile.net
configuration = notehub_py.Configuration(
    host = "https://api.notefile.net"
)

# Configure API key authorization: api_key
configuration.api_key["api_key"] = os.environ["API_KEY"]

# Enter a context with an instance of the API client
with notehub_py.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = notehub_py.ProjectApi(api_client)
    project_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | 

    try:
        api_response = api_instance.get_project_members(project_uid)
        print("The response of ProjectApi->get_project_members:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectApi->get_project_members: %s\n" % e)
Response Members

name

string

The name of the project member.

email

string

The email address of the project member (only provided if the auth token provider is an owner of the project).

role

string

The role of the project member (e.g. viewer, developer, or owner).

Example Response
{
  "members": [
    {
      "name": "Jane Doe",
      "email": "someone@blues.com",
      "role": "owner"
    },
    {
      "name": "John Doe",
      "email": "someone@blues.com",
      "role": "developer"
    }
  ]
}

Create Product Notehub

Create a new Notehub product using a ProjectUID.

HTTP Method:POST
URL:https://api.notefile.net/v1/projects/{projectUID}/products
Path Parameters:
  • projectUID - The ProjectUID of a Notehub project.
Minimum Notehub project-level role:developer
Required HTTP Headers:Authorization: Bearer <access_token>, where the access token is a Notehub API bearer token.
Arguments

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>"}'
import * as NotehubJs from "@blues-inc/notehub-js";
let defaultClient = NotehubJs.ApiClient.instance;
// Configure API key authorization: api_key
let api_key = defaultClient.authentications["api_key"];
api_key.apiKey = "YOUR API KEY";

let apiInstance = new NotehubJs.ProjectApi();
let projectUID = "app:2606f411-dea6-44a0-9743-1130f57d77d8"; // String |
let createProductProps = {
  productUid: "product_uid", // String |
  label: "Product 1", // String |
  autoProvisionFleets: ["fleet_uid_1", "fleet_uid_2"], // [String] |
  disableDevicesByDefault: true // Boolean |
}
let createProductRequest = new NotehubJs.CreateProductRequest(createProductProps); // CreateProductRequest | Product to be created
apiInstance.createProduct(projectUID, createProductRequest).then(
  (data) => {
    console.log(
      "API called successfully. Returned data: " + JSON.stringify(data)
    );
  },
  (error) => {
    console.error(error);
  }
);
import notehub_py
from notehub_py.models.create_product_request import CreateProductRequest
from notehub_py.models.product import Product
from notehub_py.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.notefile.net
configuration = notehub_py.Configuration(
    host = "https://api.notefile.net"
)

# Configure API key authorization: api_key
configuration.api_key["api_key"] = os.environ["API_KEY"]

# Enter a context with an instance of the API client
with notehub_py.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = notehub_py.ProjectApi(api_client)
    project_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | 
    product_request_props = {
        "product_uid": "product_uid_example",
        "label": "label_example",
        "auto_provision_fleets": [
            "fleet_id_1",
            "fleet_id_2"
        ],
        "disable_devices_by_default": True
    }
    create_product_request = notehub_py.CreateProductRequest(product_request_props) # CreateProductRequest | Product to be created

    try:
        api_response = api_instance.create_product(project_uid, create_product_request)
        print("The response of ProjectApi->create_product:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectApi->create_product: %s\n" % e)
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
}

Get Products Notehub

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

HTTP Method:GET
URL:https://api.notefile.net/v1/projects/{projectUID}/products
Path Parameters:
  • projectUID - The ProjectUID of a Notehub project.
Minimum Notehub project-level role:viewer
Required HTTP Headers:Authorization: Bearer <access_token>, where the access token is a Notehub API bearer token.
Arguments
None
curl -X GET
    -L 'https://api.notefile.net/v1/projects/<projectUID>/products'
    -H 'Authorization: Bearer <access_token>'
import * as NotehubJs from "@blues-inc/notehub-js";
let defaultClient = NotehubJs.ApiClient.instance;
// Configure API key authorization: api_key
let api_key = defaultClient.authentications["api_key"];
api_key.apiKey = "YOUR API KEY";

let apiInstance = new NotehubJs.ProjectApi();
let projectUID = "app:2606f411-dea6-44a0-9743-1130f57d77d8"; // String |
apiInstance.getProjectProducts(projectUID).then(
  (data) => {
    console.log(
      "API called successfully. Returned data: " + JSON.stringify(data)
    );
  },
  (error) => {
    console.error(error);
  }
);
import notehub_py
from notehub_py.models.get_project_products200_response import GetProjectProducts200Response
from notehub_py.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.notefile.net
configuration = notehub_py.Configuration(
    host = "https://api.notefile.net"
)

# Configure API key authorization: api_key
configuration.api_key["api_key"] = os.environ["API_KEY"]

# Enter a context with an instance of the API client
with notehub_py.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = notehub_py.ProjectApi(api_client)
    project_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | 

    try:
        api_response = api_instance.get_project_products(project_uid)
        print("The response of ProjectApi->get_project_products:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectApi->get_project_products: %s\n" % e)
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
    }
  ]
}

Get Project Environment Variables Notehub

Get all project-level environment variables by ProjectUID.

HTTP Method:GET
URL:https://api.notefile.net/v1/projects/{projectUID}/environment_variables
Path Parameters:
  • projectUID - The ProjectUID of a Notehub project.
Minimum Notehub project-level role:viewer
Required HTTP Headers:Authorization: Bearer <access_token>, where the access token is a Notehub API bearer token.
Arguments
None
curl -X GET
    -L 'https://api.notefile.net/v1/projects/<projectUID>/environment_variables'
    -H 'Authorization: Bearer <access_token>'
import * as NotehubJs from "@blues-inc/notehub-js";
let defaultClient = NotehubJs.ApiClient.instance;
// Configure API key authorization: api_key
let api_key = defaultClient.authentications["api_key"];
api_key.apiKey = "YOUR API KEY";

let apiInstance = new NotehubJs.ProjectApi();
let projectUID = "app:2606f411-dea6-44a0-9743-1130f57d77d8"; // String |
apiInstance.getProjectEnvironmentVariables(projectUID).then(
  (data) => {
    console.log(
      "API called successfully. Returned data: " + JSON.stringify(data)
    );
  },
  (error) => {
    console.error(error);
  }
);
import notehub_py
from notehub_py.models.environment_variables import EnvironmentVariables
from notehub_py.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.notefile.net
configuration = notehub_py.Configuration(
    host = "https://api.notefile.net"
)

# Configure API key authorization: api_key
configuration.api_key["api_key"] = os.environ["API_KEY"]

# Enter a context with an instance of the API client
with notehub_py.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = notehub_py.ProjectApi(api_client)
    project_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | 

    try:
        api_response = api_instance.get_project_environment_variables(project_uid)
        print("The response of ProjectApi->get_project_environment_variables:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectApi->get_project_environment_variables: %s\n" % e)
Response Members

environment_variables

object

JSON object containing environment variables in "key":"value" format.

Example Response
{
  "environment_variables": {
    "project_humidity": "33.4",
    "project_temp": "24.1"
  }
}

Delete Project Environment Variable Notehub

Delete a project-level environment variable by ProjectUID and environment variable key.

HTTP Method:DELETE
URL:https://api.notefile.net/v1/projects/{projectUID}/environment_variables/{key}
Path Parameters:
  • projectUID - The ProjectUID of a Notehub project.
  • key - The key of the environment variable.
Minimum Notehub project-level role:developer
Required HTTP Headers:Authorization: Bearer <access_token>, where the access token is a Notehub API bearer token.
Arguments
None
curl -X DELETE
    -L 'https://api.notefile.net/v1/projects/<projectUID>/environment_variables/<key>'
    -H 'Authorization: Bearer <access_token>'
import * as NotehubJs from "@blues-inc/notehub-js";
let defaultClient = NotehubJs.ApiClient.instance;
// Configure API key authorization: api_key
let api_key = defaultClient.authentications["api_key"];
api_key.apiKey = "YOUR API KEY";

let apiInstance = new NotehubJs.ProjectApi();
let projectUID = "app:2606f411-dea6-44a0-9743-1130f57d77d8"; // String |
let key = "key_example"; // String | The environment variable key to delete.
apiInstance.deleteProjectEnvironmentVariable(projectUID, key).then(
  (data) => {
    console.log(
      "API called successfully. Returned data: " + JSON.stringify(data)
    );
  },
  (error) => {
    console.error(error);
  }
);
import notehub_py
from notehub_py.models.environment_variables import EnvironmentVariables
from notehub_py.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.notefile.net
configuration = notehub_py.Configuration(
    host = "https://api.notefile.net"
)

# Configure API key authorization: api_key
configuration.api_key["api_key"] = os.environ["API_KEY"]

# Enter a context with an instance of the API client
with notehub_py.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = notehub_py.ProjectApi(api_client)
    project_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | 
    key = "key_example" # str | The environment variable key to delete.

    try:
        api_response = api_instance.delete_project_environment_variable(project_uid, key)
        print("The response of ProjectApi->delete_project_environment_variable:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectApi->delete_project_environment_variable: %s\n" % e)
Response Members

environment_variables

object

JSON object containing environment variables in "key":"value" format.

Example Response
{
  "environment_variables": {
    "project_humidity": "33.4",
    "project_temp": "24.1"
  }
}

Set Project Environment Variables Notehub

Set project-level environment variables by ProjectUID.

HTTP Method:PUT
URL:https://api.notefile.net/v1/projects/{projectUID}/environment_variables
Path Parameters:
  • projectUID - The ProjectUID of a Notehub project.
Minimum Notehub project-level role:developer
Required HTTP Headers:Authorization: Bearer <access_token>, where the access token is a Notehub API bearer token.
Arguments

env_vars

object

A JSON object containing the key-value pair(s) of environment variable(s) to add. For example: {"key1":"value1","key2":"value2"}.

curl -X PUT
    -L 'https://api.notefile.net/v1/projects/<projectUID>/environment_variables'
    -H 'Authorization: Bearer <access_token>'
    -d '{"environment_variables":<env_vars>}'
import * as NotehubJs from "@blues-inc/notehub-js";
let defaultClient = NotehubJs.ApiClient.instance;
// Configure API key authorization: api_key
let api_key = defaultClient.authentications["api_key"];
api_key.apiKey = "YOUR API KEY";

let apiInstance = new NotehubJs.ProjectApi();
let projectUID = "app:2606f411-dea6-44a0-9743-1130f57d77d8"; // String |
let envVars = {key1: "value1", key2: "value2"} // {String: String}
let opts = {
  environmentVariables: new NotehubJs.EnvironmentVariables(envVars), // EnvironmentVariables |
};
apiInstance.putProjectEnvironmentVariables(projectUID, opts).then(
  (data) => {
    console.log(
      "API called successfully. Returned data: " + JSON.stringify(data)
    );
  },
  (error) => {
    console.error(error);
  }
);
import notehub_py
from notehub_py.models.environment_variables import EnvironmentVariables
from notehub_py.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.notefile.net
configuration = notehub_py.Configuration(
    host = "https://api.notefile.net"
)

# Configure API key authorization: api_key
configuration.api_key["api_key"] = os.environ["API_KEY"]

# Enter a context with an instance of the API client
with notehub_py.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = notehub_py.ProjectApi(api_client)
    project_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | 
    env_vars = {"key_1": "value_1", "key_2": "value_2"} # Dict[str, str] | 
    environment_variables = notehub_py.EnvironmentVariables(env_vars) # EnvironmentVariables |  (optional)

    try:
        api_response = api_instance.put_project_environment_variables(project_uid, environment_variables=environment_variables)
        print("The response of ProjectApi->put_project_environment_variables:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectApi->put_project_environment_variables: %s\n" % e)
Response Members

environment_variables

object

JSON object containing environment variables in "key":"value" format.

Example Response
{
  "environment_variables": {
    "project_humidity": "33.4",
    "project_temp": "24.1"
  }
}

Get Fleet Environment Variables Notehub

Get all fleet-level environment variables by ProjectUID and FleetUID.

HTTP Method:GET
URL:https://api.notefile.net/v1/projects/{projectUID}/fleets/{fleetUID}/environment_variables
Path Parameters:
  • projectUID - The ProjectUID of a Notehub project.
  • fleetUID - The FleetUID of a Notehub fleet.
Minimum Notehub project-level role:viewer
Required HTTP Headers:Authorization: Bearer <access_token>, where the access token is a Notehub API bearer token.
Arguments
None
curl -X GET
    -L 'https://api.notefile.net/v1/projects/<projectUID>/fleets/<fleetUID>/environment_variables'
    -H 'Authorization: Bearer <access_token>'
import * as NotehubJs from "@blues-inc/notehub-js";
let defaultClient = NotehubJs.ApiClient.instance;
// Configure API key authorization: api_key
let api_key = defaultClient.authentications["api_key"];
api_key.apiKey = "YOUR API KEY";

let apiInstance = new NotehubJs.ProjectApi();
let projectUID = "app:2606f411-dea6-44a0-9743-1130f57d77d8"; // String |
let fleetUID = "fleetUID_example"; // String |
apiInstance.getFleetEnvironmentVariables(projectUID, fleetUID).then(
  (data) => {
    console.log(
      "API called successfully. Returned data: " + JSON.stringify(data)
    );
  },
  (error) => {
    console.error(error);
  }
);
import notehub_py
from notehub_py.models.environment_variables import EnvironmentVariables
from notehub_py.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.notefile.net
configuration = notehub_py.Configuration(
    host = "https://api.notefile.net"
)

# Configure API key authorization: api_key
configuration.api_key["api_key"] = os.environ["API_KEY"]

# Enter a context with an instance of the API client
with notehub_py.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = notehub_py.ProjectApi(api_client)
    project_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | 
    fleet_uid = "fleet_uid_example" # str | 

    try:
        api_response = api_instance.get_fleet_environment_variables(project_uid, fleet_uid)
        print("The response of ProjectApi->get_fleet_environment_variables:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectApi->get_fleet_environment_variables: %s\n" % e)
Response Members

environment_variables

object

JSON object containing environment variables in "key":"value" format.

Example Response
{
  "environment_variables": {
    "fleet_humidity": "33.4",
    "fleet_temp": "24.1"
  }
}

Delete Fleet Environment Variable Notehub

Delete a fleet-level environment variable on a Notehub project by ProjectUID, FleetUID, and environment variable key.

HTTP Method:DELETE
URL:https://api.notefile.net/v1/projects/{projectUID}/fleets/{fleetUID}/environment_variables/{key}
Path Parameters:
  • projectUID - The ProjectUID of a Notehub project.
  • fleetUID - The FleetUID of a Notehub fleet.
  • key - The key of the environment variable.
Minimum Notehub project-level role:developer
Required HTTP Headers:Authorization: Bearer <access_token>, where the access token is a Notehub API bearer token.
Arguments
None
curl -X DELETE
    -L 'https://api.notefile.net/v1/projects/<projectUID>/fleets/<fleetUID>/environment_variables/<key>'
    -H 'Authorization: Bearer <access_token>'
import * as NotehubJs from "@blues-inc/notehub-js";
let defaultClient = NotehubJs.ApiClient.instance;
// Configure API key authorization: api_key
let api_key = defaultClient.authentications["api_key"];
api_key.apiKey = "YOUR API KEY";

let apiInstance = new NotehubJs.ProjectApi();
let projectUID = "app:2606f411-dea6-44a0-9743-1130f57d77d8"; // String |
let fleetUID = "fleetUID_example"; // String |
let key = "key_example"; // String | The environment variable key to delete.
apiInstance.deleteFleetEnvironmentVariable(projectUID, fleetUID, key).then(
  (data) => {
    console.log(
      "API called successfully. Returned data: " + JSON.stringify(data)
    );
  },
  (error) => {
    console.error(error);
  }
);
import notehub_py
from notehub_py.models.environment_variables import EnvironmentVariables
from notehub_py.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.notefile.net
configuration = notehub_py.Configuration(
    host = "https://api.notefile.net"
)

# Configure API key authorization: api_key
configuration.api_key["api_key"] = os.environ["API_KEY"]

# Enter a context with an instance of the API client
with notehub_py.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = notehub_py.ProjectApi(api_client)
    project_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | 
    fleet_uid = "fleet_uid_example" # str | 
    key = "key_example" # str | The environment variable key to delete.

    try:
        api_response = api_instance.delete_fleet_environment_variable(project_uid, fleet_uid, key)
        print("The response of ProjectApi->delete_fleet_environment_variable:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectApi->delete_fleet_environment_variable: %s\n" % e)
Response Members

environment_variables

object

JSON object containing environment variables in "key":"value" format.

Example Response
{
  "environment_variables": {
    "fleet_humidity": "33.4",
    "fleet_temp": "24.1"
  }
}

Set Fleet Environment Variables Notehub

Set fleet-level environment variables by ProjectUID and FleetUID.

HTTP Method:PUT
URL:https://api.notefile.net/v1/projects/{projectUID}/fleets/{fleetUID}/environment_variables
Path Parameters:
  • projectUID - The ProjectUID of a Notehub project.
  • fleetUID - The FleetUID of a Notehub fleet.
Minimum Notehub project-level role:developer
Required HTTP Headers:Authorization: Bearer <access_token>, where the access token is a Notehub API bearer token.
Arguments

env_vars

object

A JSON object containing the key-value pair(s) of environment variable(s) to be added to the fleet. For example: {"key1":"value1","key2":"value2"}.

curl -X PUT
    -L 'https://api.notefile.net/v1/projects/<projectUID>/fleets/<fleetUID>/environment_variables'
    -H 'Authorization: Bearer <access_token>'
    -d '{"environment_variables":<env_vars>}'
import * as NotehubJs from "@blues-inc/notehub-js";
let defaultClient = NotehubJs.ApiClient.instance;
// Configure API key authorization: api_key
let api_key = defaultClient.authentications["api_key"];
api_key.apiKey = "YOUR API KEY";

let apiInstance = new NotehubJs.ProjectApi();
let projectUID = "app:2606f411-dea6-44a0-9743-1130f57d77d8"; // String |
let fleetUID = "fleetUID_example"; // String |
let envVars = {key1: "value1", key2: "value2"} // {String: String}
let environmentVariables = new NotehubJs.EnvironmentVariables(envVars); // EnvironmentVariables | Environment variables to be added to the fleet
apiInstance
  .putFleetEnvironmentVariables(projectUID, fleetUID, environmentVariables)
  .then(
    (data) => {
      console.log(
        "API called successfully. Returned data: " + JSON.stringify(data)
      );
    },
    (error) => {
      console.error(error);
    }
  );
import notehub_py
from notehub_py.models.environment_variables import EnvironmentVariables
from notehub_py.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.notefile.net
configuration = notehub_py.Configuration(
    host = "https://api.notefile.net"
)

# Configure API key authorization: api_key
configuration.api_key["api_key"] = os.environ["API_KEY"]

# Enter a context with an instance of the API client
with notehub_py.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = notehub_py.ProjectApi(api_client)
    project_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | 
    fleet_uid = "fleet_uid_example" # str | 
    env_vars = {"key_1": "value_1", "key_2": "value_2"} # Dict[str, str] | 
    environment_variables = notehub_py.EnvironmentVariables(env_vars) # EnvironmentVariables | Environment variables to be added to the fleet

    try:
        api_response = api_instance.put_fleet_environment_variables(project_uid, fleet_uid, environment_variables)
        print("The response of ProjectApi->put_fleet_environment_variables:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectApi->put_fleet_environment_variables: %s\n" % e)
Response Members

environment_variables

object

JSON object containing environment variables in "key":"value" format.

Example Response
{
  "environment_variables": {
    "fleet_humidity": "33.4",
    "fleet_temp": "24.1"
  }
}

Get Fleet Notehub

Get a fleet associated with a ProjectUID.

HTTP Method:GET
URL:https://api.notefile.net/v1/projects/{projectUID}/fleets/{fleetUID}
Path Parameters:
  • projectUID - The ProjectUID of a Notehub project.
  • fleetUID - The FleetUID of a Notehub fleet.
Minimum Notehub project-level role:viewer
Required HTTP Headers:Authorization: Bearer <access_token>, where the access token is a Notehub API bearer token.
Arguments
None
curl -X GET
    -L 'https://api.notefile.net/v1/projects/<projectUID>/fleets/<fleetUID>'
    -H 'Authorization: Bearer <access_token>'
import * as NotehubJs from "@blues-inc/notehub-js";
let defaultClient = NotehubJs.ApiClient.instance;
// Configure API key authorization: api_key
let api_key = defaultClient.authentications["api_key"];
api_key.apiKey = "YOUR API KEY";

let apiInstance = new NotehubJs.ProjectApi();
let projectUID = "app:2606f411-dea6-44a0-9743-1130f57d77d8"; // String |
apiInstance.getFleet(projectUID, fleetUID).then(
  (data) => {
    console.log(
      "API called successfully. Returned data: " + JSON.stringify(data)
    );
  },
  (error) => {
    console.error(error);
  }
);
import notehub_py
from notehub_py.models.fleet import Fleet
from notehub_py.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.notefile.net
configuration = notehub_py.Configuration(
    host = "https://api.notefile.net"
)

# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]

# Enter a context with an instance of the API client
with notehub_py.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = notehub_py.ProjectApi(api_client)
    project_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | 
    fleet_uid = "fleet_uid_example" # str | 

    try:
        api_response = api_instance.get_fleet(project_uid, fleet_uid)
        print("The response of ProjectApi->get_fleet:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectApi->get_fleet: %s\n" % e)
Response Members

uid

string

The globally-unique identifier of the fleet.

label

string

The user-defined label of the fleet.

created

string

The date and time the fleet was created.

Example Response
{
  "uid": "fleet:00000000-0000-0000-0000-000000000000",
  "label": "Production",
  "created": "2021-04-10T21:18:38Z"
}

Get Fleets Notehub

Get an array of fleets associated with a ProjectUID.

HTTP Method:GET
URL:https://api.notefile.net/v1/projects/{projectUID}/fleets
Path Parameters:
  • projectUID - The ProjectUID of a Notehub project.
Minimum Notehub project-level role:viewer
Required HTTP Headers:Authorization: Bearer <access_token>, where the access token is a Notehub API bearer token.
Arguments
None
curl -X GET
    -L 'https://api.notefile.net/v1/projects/<projectUID>/fleets'
    -H 'Authorization: Bearer <access_token>'
import * as NotehubJs from "@blues-inc/notehub-js";
let defaultClient = NotehubJs.ApiClient.instance;
// Configure API key authorization: api_key
let api_key = defaultClient.authentications["api_key"];
api_key.apiKey = "YOUR API KEY";

let apiInstance = new NotehubJs.ProjectApi();
let projectUID = "app:2606f411-dea6-44a0-9743-1130f57d77d8"; // String |
apiInstance.getProjectFleets(projectUID).then(
  (data) => {
    console.log(
      "API called successfully. Returned data: " + JSON.stringify(data)
    );
  },
  (error) => {
    console.error(error);
  }
);
import notehub_py
from notehub_py.models.get_project_fleets200_response import GetProjectFleets200Response
from notehub_py.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.notefile.net
configuration = notehub_py.Configuration(
    host = "https://api.notefile.net"
)

# Configure API key authorization: api_key
configuration.api_key["api_key"] = os.environ["API_KEY"]

# Enter a context with an instance of the API client
with notehub_py.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = notehub_py.ProjectApi(api_client)
    project_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | 

    try:
        api_response = api_instance.get_project_fleets(project_uid)
        print("The response of ProjectApi->get_project_fleets:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectApi->get_project_fleets: %s\n" % e)
Response Members

uid

string

The globally-unique identifier of the fleet.

label

string

The user-defined label of the fleet.

created

string

The date and time the fleet was created.

Example Response
{
  "fleets": [
    {
      "uid": "fleet:00000000-0000-0000-0000-000000000000",
      "label": "Production",
      "created": "2021-04-10T21:18:38Z"
    },
    {
      "uid": "fleet:00000000-0000-0000-0000-000000000000",
      "label": "Staging",
      "created": "2021-02-11T01:03:46Z"
    },
    {
      "uid": "fleet:00000000-0000-0000-0000-000000000000",
      "label": "Testing",
      "created": "2021-02-11T01:03:32Z"
    }
  ]
}

Create Fleet Notehub

Create a new device fleet within a Notehub project.

HTTP Method:POST
URL:https://api.notefile.net/v1/projects/{projectUID}/fleets
Path Parameters:
  • projectUID - The ProjectUID of a Notehub project.
Minimum Notehub project-level role:developer
Required HTTP Headers:Authorization: Bearer <access_token>, where the access token is a Notehub API bearer token.
Arguments

label

string (optional)

The requested label for the fleet.

smart_rule

string (optional)

JSONata expression that will be evaluated to determine device membership into this fleet. If the expression evaluates to a 1, the device will be included, if it evaluates to -1 it will be removed, and if it evaluates to 0 or errors it will be left unchanged.

See Using Smart Fleet Rules for examples.

curl -X POST
    -L 'https://api.notefile.net/v1/projects/<projectUID>/fleets'
    -H 'Authorization: Bearer <access_token>'
    -d '{"label":"<label>"}'
import * as NotehubJs from "@blues-inc/notehub-js";
let defaultClient = NotehubJs.ApiClient.instance;
// Configure API key authorization: api_key
let api_key = defaultClient.authentications["api_key"];
api_key.apiKey = "YOUR API KEY";

let apiInstance = new NotehubJs.ProjectApi();
let projectUID = "app:2606f411-dea6-44a0-9743-1130f57d77d8"; // String |
let createFleetRequest = new NotehubJs.CreateFleetRequest(); // CreateFleetRequest | Fleet to be added
apiInstance.createFleet(projectUID, createFleetRequest).then(
  (data) => {
    console.log(
      "API called successfully. Returned data: " + JSON.stringify(data)
    );
  },
  (error) => {
    console.error(error);
  }
);
import notehub_py
from notehub_py.models.create_fleet_request import CreateFleetRequest
from notehub_py.models.fleet import Fleet
from notehub_py.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.notefile.net
configuration = notehub_py.Configuration(
    host = "https://api.notefile.net"
)

# Configure API key authorization: api_key
configuration.api_key["api_key"] = os.environ["API_KEY"]

# Enter a context with an instance of the API client
with notehub_py.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = notehub_py.ProjectApi(api_client)
    project_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | 
    create_fleet_request = notehub_py.CreateFleetRequest() # CreateFleetRequest | Fleet to be added

    try:
        api_response = api_instance.create_fleet(project_uid, create_fleet_request)
        print("The response of ProjectApi->create_fleet:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectApi->create_fleet: %s\n" % e)
Response Members

uid

string

The globally-unique identifier for the fleet.

label

string

The user-defined label of the fleet.

created

time stamp

The date/time the fleet was created.

Example Response
{
  "uid": "fleet:00000000-0000-0000-0000-000000000000",
  "label": "My Fleet Label",
  "created": "2021-10-12T16:21:54Z"
}

Update Fleet Notehub

Update a fleet's label or devices by FleetUID.

HTTP Method:PUT
URL:https://api.notefile.net/v1/projects/{projectUID}/fleets/{fleetUID}
Path Parameters:
  • projectUID - The ProjectUID of a Notehub project.
  • fleetUID - The FleetUID of a Notehub fleet.
Minimum Notehub project-level role:developer
Required HTTP Headers:Authorization: Bearer <access_token>, where the access token is a Notehub API bearer token.
Arguments

label

string

The updated label for the fleet.

addDevices

array (optional)

A list of DeviceUIDs to add to the fleet.

removeDevices

array (optional)

A list of DeviceUIDs to remove from the fleet.

smart_rule

string (optional)

JSONata expression that will be evaluated to determine device membership into this fleet. If the expression evaluates to a 1, the device will be included, if it evaluates to -1 it will be removed, and if it evaluates to 0 or errors it will be left unchanged.

See Using Smart Fleet Rules for examples.

curl -X PUT
    -L 'https://api.notefile.net/v1/projects/<projectUID>/fleets/<fleetUID>'
    -H 'Authorization: Bearer <access_token>'
    -d '{"label":"<label>"}'
import * as NotehubJs from "@blues-inc/notehub-js";
let defaultClient = NotehubJs.ApiClient.instance;
// Configure API key authorization: api_key
let api_key = defaultClient.authentications["api_key"];
api_key.apiKey = "YOUR API KEY";

let apiInstance = new NotehubJs.ProjectApi();
let projectUID = "app:2606f411-dea6-44a0-9743-1130f57d77d8"; // String |
let fleetUID = "fleetUID_example"; // String |

let updateFleetRequest = {
  label: "Fleet Label",
  addDevices: ["device_id_1", "device_id_2"],
  removeDevices: ["device_id_3", "device_id_4"]
} // UpdateFleetRequest | Fleet details to update

apiInstance.updateFleet(projectUID, fleetUID, updateFleetRequest).then(
  (data) => {
    console.log(
      "API called successfully. Returned data: " + JSON.stringify(data)
    );
  },
  (error) => {
    console.error(error);
  }
);
import notehub_py
from notehub_py.models.fleet import Fleet
from notehub_py.models.update_fleet_request import UpdateFleetRequest
from notehub_py.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.notefile.net
configuration = notehub_py.Configuration(
    host = "https://api.notefile.net"
)

# Configure API key authorization: api_key
configuration.api_key["api_key"] = os.environ["API_KEY"]

# Enter a context with an instance of the API client
with notehub_py.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = notehub_py.ProjectApi(api_client)
    project_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | 
    fleet_uid = "fleet_uid_example" # str | 
    fleet_request_properties = {
        "label": "fleet_label_1",
        "add_devices": ["device_uid_1", "device_uid_2"],
        "remove_devices": ["device_uid_3", "device_uid_4"]
    }
    update_fleet_request = notehub_py.UpdateFleetRequest(fleet_request_properties) # UpdateFleetRequest | Fleet details to update

    try:
        api_response = api_instance.update_fleet(project_uid, fleet_uid, update_fleet_request)
        print("The response of ProjectApi->update_fleet:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectApi->update_fleet: %s\n" % e)
Response Members

uid

string

The globally-unique identifier for the fleet.

label

string

The user-defined label of the fleet.

created

time stamp

The date/time the fleet was created.

Example Response
{
  "uid": "fleet:00000000-0000-0000-0000-000000000000",
  "label": "My Fleet Label",
  "created": "2021-10-12T16:21:54Z"
}

Delete Fleet Notehub

Delete a device fleet.

HTTP Method:DELETE
URL:https://api.notefile.net/v1/projects/{projectUID}/fleets/{fleetUID}
Path Parameters:
  • projectUID - The ProjectUID of a Notehub project.
  • fleetUID - The FleetUID of a Notehub fleet.
Minimum Notehub project-level role:developer
Required HTTP Headers:Authorization: Bearer <access_token>, where the access token is a Notehub API bearer token.
Arguments
None
curl -X DELETE
     -L 'https://api.notefile.net/v1/projects/<projectUID>/fleets/<fleetUID>'
     -H 'Authorization: Bearer <access_token>'
import * as NotehubJs from "@blues-inc/notehub-js";
let defaultClient = NotehubJs.ApiClient.instance;
// Configure API key authorization: api_key
let api_key = defaultClient.authentications["api_key"];
api_key.apiKey = "YOUR API KEY";

let apiInstance = new NotehubJs.ProjectApi();
let projectUID = "app:2606f411-dea6-44a0-9743-1130f57d77d8"; // String |
let fleetUID = "fleetUID_example"; // String |
apiInstance.deleteFleet(projectUID, fleetUID).then(
  () => {
    console.log("API called successfully.");
  },
  (error) => {
    console.error(error);
  }
);
import notehub_py
from notehub_py.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.notefile.net
configuration = notehub_py.Configuration(
    host = "https://api.notefile.net"
)

# Configure API key authorization: api_key
configuration.api_key["api_key"] = os.environ["API_KEY"]

# Enter a context with an instance of the API client
with notehub_py.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = notehub_py.ProjectApi(api_client)
    project_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | 
    fleet_uid = "fleet_uid_example" # str | 

    try:
        api_instance.delete_fleet(project_uid, fleet_uid)
    except Exception as e:
        print("Exception when calling ProjectApi->delete_fleet: %s\n" % e)

Get Device Fleets Notehub

Get an array of fleets associated with a device.

HTTP Method:GET
URL:https://api.notefile.net/v1/projects/{projectUID}/devices/{deviceUID}/fleets
Path Parameters:
  • projectUID - The ProjectUID of a Notehub project.
  • deviceUID - The DeviceUID of a Notehub device. You may alternatively provide a device serial number by prefixing this argument with sn:, for example sn:my-device.
Minimum Notehub project-level role:viewer
Required HTTP Headers:Authorization: Bearer <access_token>, where the access token is a Notehub API bearer token.
Arguments
None
curl -X GET
    -L 'https://api.notefile.net/v1/projects/<projectUID>/devices/<deviceUID>/fleets'
    -H 'Authorization: Bearer <access_token>'
import * as NotehubJs from "@blues-inc/notehub-js";
let defaultClient = NotehubJs.ApiClient.instance;
// Configure API key authorization: api_key
let api_key = defaultClient.authentications["api_key"];
api_key.apiKey = "YOUR API KEY";

let apiInstance = new NotehubJs.ProjectApi();
let projectUID = "app:2606f411-dea6-44a0-9743-1130f57d77d8"; // String |
let deviceUID = "deviceUID_example"; // String |
apiInstance.getDeviceFleets(projectUID, deviceUID).then(
  (data) => {
    console.log(
      "API called successfully. Returned data: " + JSON.stringify(data)
    );
  },
  (error) => {
    console.error(error);
  }
);
import notehub_py
from notehub_py.models.get_project_fleets200_response import GetProjectFleets200Response
from notehub_py.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.notefile.net
configuration = notehub_py.Configuration(
    host = "https://api.notefile.net"
)

# Configure API key authorization: api_key
configuration.api_key["api_key"] = os.environ["API_KEY"]

# Enter a context with an instance of the API client
with notehub_py.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = notehub_py.ProjectApi(api_client)
    project_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | 
    device_uid = "device_uid_example" # str | 

    try:
        api_response = api_instance.get_device_fleets(project_uid, device_uid)
        print("The response of ProjectApi->get_device_fleets:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectApi->get_device_fleets: %s\n" % e)
Response Members

uid

string

The globally-unique identifier of the fleet.

label

string

The user-defined label of the fleet.

created

string

The date and time the fleet was created.

Example Response
{
  "fleets": [
    {
      "uid": "fleet:00000000-0000-0000-0000-000000000000",
      "label": "Production",
      "created": "2021-04-10T21:18:38Z"
    },
    {
      "uid": "fleet:00000000-0000-0000-0000-000000000000",
      "label": "Staging",
      "created": "2021-02-11T01:03:46Z"
    },
    {
      "uid": "fleet:00000000-0000-0000-0000-000000000000",
      "label": "Testing",
      "created": "2021-02-11T01:03:32Z"
    }
  ]
}

Add Device to Fleets Notehub

Add a device to one of more fleets.

HTTP Method:PUT
URL:https://api.notefile.net/v1/projects/{projectUID}/devices/{deviceUID}/fleets
Path Parameters:
  • projectUID - The ProjectUID of a Notehub project.
  • deviceUID - The DeviceUID of a Notehub device. You may alternatively provide a device serial number by prefixing this argument with sn:, for example sn:my-device.
Minimum Notehub project-level role:developer
Required HTTP Headers:Authorization: Bearer <access_token>, where the access token is a Notehub API bearer token.
Arguments

fleet_uids

string array

A comma-separated list of globally-unique FleetUIDs.

curl -X PUT
    -L 'https://api.notefile.net/v1/projects/<projectUID>/devices/<deviceUID>/fleets'
    -H 'Authorization: Bearer <access_token>'
    -d '{"fleet_uids":[<fleet_uids>]}'
import * as NotehubJs from "@blues-inc/notehub-js";
let defaultClient = NotehubJs.ApiClient.instance;
// Configure API key authorization: api_key
let api_key = defaultClient.authentications["api_key"];
api_key.apiKey = "YOUR API KEY";

let apiInstance = new NotehubJs.ProjectApi();
let projectUID = "app:2606f411-dea6-44a0-9743-1130f57d77d8"; // String |
let deviceUID = "deviceUID_example"; // String |
let putDeviceFleetUids = ["fleetUID1", "fleetUID2"] // [String]
let putDeviceFleetsRequest = new NotehubJs.PutDeviceFleetsRequest(putDeviceFleetUids); // PutDeviceFleetsRequest | The fleets to add to the device. Note that the endpoint takes an array of fleetUIDs, to facilitate multi-fleet devices. Multi-fleet is not yet enabled on all SaaS plans - unless it is supported by the SaaS plan of the project, passing more than a single fleetUID in the array is an error.
apiInstance.putDeviceFleets(projectUID, deviceUID, putDeviceFleetsRequest).then(
  (data) => {
    console.log(
      "API called successfully. Returned data: " + JSON.stringify(data)
    );
  },
  (error) => {
    console.error(error);
  }
);
import notehub_py
from notehub_py.models.get_project_fleets200_response import GetProjectFleets200Response
from notehub_py.models.put_device_fleets_request import PutDeviceFleetsRequest
from notehub_py.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.notefile.net
configuration = notehub_py.Configuration(
    host = "https://api.notefile.net"
)

# Configure API key authorization: api_key
configuration.api_key["api_key"] = os.environ["API_KEY"]

# Enter a context with an instance of the API client
with notehub_py.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = notehub_py.ProjectApi(api_client)
    project_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | 
    device_uid = "device_uid_example" # str | 
    fleet_uids = ["fleet_uid_1", "fleet_uid_2"] # List[str] | An array of Fleet UIDs.
    put_device_fleets_request = notehub_py.PutDeviceFleetsRequest(fleet_uids) # PutDeviceFleetsRequest | The fleets to add to the device. Note that the endpoint takes an array of fleetUIDs, to facilitate multi-fleet devices. Multi-fleet is not yet enabled on all SaaS plans - unless it is supported by the SaaS plan of the project, passing more than a single fleetUID in the array is an error. 

    try:
        api_response = api_instance.put_device_fleets(project_uid, device_uid, put_device_fleets_request)
        print("The response of ProjectApi->put_device_fleets:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectApi->put_device_fleets: %s\n" % e)
Response Members

uid

string

The globally-unique identifier of the fleet.

label

string

The user-defined label of the fleet.

created

string

The date and time the fleet was created.

Example Response
{
  "fleets": [
    {
      "uid": "fleet:00000000-0000-0000-0000-000000000000",
      "label": "Production",
      "created": "2021-04-10T21:18:38Z"
    },
    {
      "uid": "fleet:00000000-0000-0000-0000-000000000000",
      "label": "Staging",
      "created": "2021-02-11T01:03:46Z"
    },
    {
      "uid": "fleet:00000000-0000-0000-0000-000000000000",
      "label": "Testing",
      "created": "2021-02-11T01:03:32Z"
    }
  ]
}

Remove Device from Fleets Notehub

Removes a device from one or more fleets.

HTTP Method:DELETE
URL:https://api.notefile.net/v1/projects/{projectUID}/devices/{deviceUID}/fleets
Path Parameters:
  • projectUID - The ProjectUID of a Notehub project.
  • deviceUID - The DeviceUID of a Notehub device. You may alternatively provide a device serial number by prefixing this argument with sn:, for example sn:my-device.
Minimum Notehub project-level role:developer
Required HTTP Headers:Authorization: Bearer <access_token>, where the access token is a Notehub API bearer token.
Arguments

fleet_uids

string array

An array of globally-unique FleetUIDs.

curl -X DELETE
    -L 'https://api.notefile.net/v1/projects/<projectUID>/devices/<deviceUID>/fleets'
    -H 'Authorization: Bearer <access_token>'
    -d '{"fleet_uids":[<fleet_uids>]}'
import * as NotehubJs from "@blues-inc/notehub-js";
let defaultClient = NotehubJs.ApiClient.instance;
// Configure API key authorization: api_key
let api_key = defaultClient.authentications["api_key"];
api_key.apiKey = "YOUR API KEY";

let apiInstance = new NotehubJs.ProjectApi();
let projectUID = "app:2606f411-dea6-44a0-9743-1130f57d77d8"; // String |
let deviceUID = "deviceUID_example"; // String |
let deleteDeviceFleetUids = ["fleetUID1", "fleetUID2"] // [String]
let deleteDeviceFleetsRequest = new NotehubJs.DeleteDeviceFleetsRequest(deleteDeviceFleetUids); // DeleteDeviceFleetsRequest | The fleets to remove from the device. Note that the endpoint takes an array of fleetUIDs, to facilitate multi-fleet devices. Multi-fleet is not yet enabled on all SaaS plans - unless it is supported by the SaaS plan of the project, passing more than a single fleetUID in the array is an error.
apiInstance
  .deleteDeviceFleets(projectUID, deviceUID, deleteDeviceFleetsRequest)
  .then(
    (data) => {
      console.log(
        "API called successfully. Returned data: " + JSON.stringify(data)
      );
    },
    (error) => {
      console.error(error);
    }
  );
import notehub_py
from notehub_py.models.delete_device_fleets_request import DeleteDeviceFleetsRequest
from notehub_py.models.get_project_fleets200_response import GetProjectFleets200Response
from notehub_py.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.notefile.net
configuration = notehub_py.Configuration(
    host = "https://api.notefile.net"
)

# Configure API key authorization: api_key
configuration.api_key["api_key"] = os.environ["API_KEY"]

# Enter a context with an instance of the API client
with notehub_py.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = notehub_py.ProjectApi(api_client)
    project_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | 
    device_uid = "device_uid_example" # str | 
    fleet_uids = [
        "fleet_uid_1",
        "fleet_uid_2"
    ]
    delete_device_fleets_request = notehub_py.DeleteDeviceFleetsRequest(fleet_uids) # DeleteDeviceFleetsRequest | The fleets to remove from the device. Note that the endpoint takes an array of fleetUIDs, to facilitate multi-fleet devices. Multi-fleet is not yet enabled on all SaaS plans - unless it is supported by the SaaS plan of the project, passing more than a single fleetUID in the array is an error. 

    try:
        api_response = api_instance.delete_device_fleets(project_uid, device_uid, delete_device_fleets_request)
        print("The response of ProjectApi->delete_device_fleets:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectApi->delete_device_fleets: %s\n" % e)
Response Members

uid

string

The globally-unique identifier of the fleet.

label

string

The user-defined label of the fleet.

created

string

The date and time the fleet was created.

Example Response
{
  "fleets": [
    {
      "uid": "fleet:00000000-0000-0000-0000-000000000000",
      "label": "Production",
      "created": "2021-04-10T21:18:38Z"
    },
    {
      "uid": "fleet:00000000-0000-0000-0000-000000000000",
      "label": "Staging",
      "created": "2021-02-11T01:03:46Z"
    },
    {
      "uid": "fleet:00000000-0000-0000-0000-000000000000",
      "label": "Testing",
      "created": "2021-02-11T01:03:32Z"
    }
  ]
}

Set Global JSONata Transform Notehub

Set the global JSONata transform for a Notehub project.

HTTP Method:POST
URL:https://api.notefile.net/v1/projects/{projectUID}/global-transformation
Path Parameters:
  • projectUID - The ProjectUID of a Notehub project.
Minimum Notehub project-level role:developer
Required HTTP Headers:Authorization: Bearer <access_token>, where the access token is a Notehub API bearer token.
Arguments

jsonata

string

The JSONata expression to be applied to all events of the Notehub project.

curl -X POST
    -L 'https://api.notefile.net/v1/projects/<projectUID>/global-transformation'
    -H 'Authorization: Bearer <access_token>'
    -d '<jsonata>'
import * as NotehubJs from "@blues-inc/notehub-js";
let defaultClient = NotehubJs.ApiClient.instance;
// Configure API key authorization: api_key
let api_key = defaultClient.authentications["api_key"];
api_key.apiKey = "YOUR API KEY";

let apiInstance = new NotehubJs.ProjectApi();
let projectUID = "app:2606f411-dea6-44a0-9743-1130f57d77d8"; // String |
let body = {key: null}; // Object | JSONata expression which will be applied to each event before it is persisted and routed
apiInstance.setGlobalTransformation(projectUID, body).then(() => {
  console.log("API called successfully.");
}, (error) => {
  console.error(error);
});
import notehub_py
from notehub_py.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.notefile.net
configuration = notehub_py.Configuration(
    host = "https://api.notefile.net"
)

# Configure API key authorization: api_key
configuration.api_key["api_key"] = os.environ["API_KEY"]

# Enter a context with an instance of the API client
with notehub_py.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = notehub_py.ProjectApi(api_client)
    project_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | 
    body = None # object | JSONata expression which will be applied to each event before it is persisted and routed

    try:
        api_instance.set_global_transformation(project_uid, body)
    except Exception as e:
        print("Exception when calling ProjectApi->set_global_transformation: %s\n" % e)
Response Members
None: an empty object {} means success.

Enable Global JSONata Transform Notehub

Enables the global JSONata transform for a Notehub project.

HTTP Method:POST
URL:https://api.notefile.net/v1/projects/{projectUID}/global-transformation/enable
Path Parameters:
  • projectUID - The ProjectUID of a Notehub project.
Minimum Notehub project-level role:developer
Required HTTP Headers:Authorization: Bearer <access_token>, where the access token is a Notehub API bearer token.
Arguments
None
curl -X POST
    -L 'https://api.notefile.net/v1/projects/<projectUID>/global-transformation/enable'
    -H 'Authorization: Bearer <access_token>'
import * as NotehubJs from "@blues-inc/notehub-js";
let defaultClient = NotehubJs.ApiClient.instance;
// Configure API key authorization: api_key
let api_key = defaultClient.authentications["api_key"];
api_key.apiKey = "YOUR API KEY";

let apiInstance = new NotehubJs.ProjectApi();
let projectUID = "app:2606f411-dea6-44a0-9743-1130f57d77d8"; // String |
apiInstance.enableGlobalTransformation(projectUID).then(() => {
  console.log("API called successfully.");
}, (error) => {
  console.error(error);
});
import notehub_py
from notehub_py.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.notefile.net
configuration = notehub_py.Configuration(
    host = "https://api.notefile.net"
)

# Configure API key authorization: api_key
configuration.api_key["api_key"] = os.environ["API_KEY"]

# Enter a context with an instance of the API client
with notehub_py.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = notehub_py.ProjectApi(api_client)
    project_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | 

    try:
        api_instance.enable_global_transformation(project_uid)
    except Exception as e:
        print("Exception when calling ProjectApi->enable_global_transformation: %s\n" % e)
Response Members
None: an empty object {} means success.

Disable Global JSONata Transform Notehub

Disables the global JSONata transform for a Notehub project.

HTTP Method:POST
URL:https://api.notefile.net/v1/projects/{projectUID}/global-transformation/disable
Path Parameters:
  • projectUID - The ProjectUID of a Notehub project.
Minimum Notehub project-level role:developer
Required HTTP Headers:Authorization: Bearer <access_token>, where the access token is a Notehub API bearer token.
Arguments
None
curl -X POST
    -L 'https://api.notefile.net/v1/projects/<projectUID>/global-transformation/disable'
    -H 'Authorization: Bearer <access_token>'
import * as NotehubJs from "@blues-inc/notehub-js";
let defaultClient = NotehubJs.ApiClient.instance;
// Configure API key authorization: api_key
let api_key = defaultClient.authentications["api_key"];
api_key.apiKey = "YOUR API KEY";

let apiInstance = new NotehubJs.ProjectApi();
let projectUID = "app:2606f411-dea6-44a0-9743-1130f57d77d8"; // String |
apiInstance.disableGlobalTransformation(projectUID).then(() => {
  console.log("API called successfully.");
}, (error) => {
  console.error(error);
});
import notehub_py
from notehub_py.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.notefile.net
configuration = notehub_py.Configuration(
    host = "https://api.notefile.net"
)

# Configure API key authorization: api_key
configuration.api_key["api_key"] = os.environ["API_KEY"]

# Enter a context with an instance of the API client
with notehub_py.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = notehub_py.ProjectApi(api_client)
    project_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | 

    try:
        api_instance.disable_global_transformation(project_uid)
    except Exception as e:
        print("Exception when calling ProjectApi->disable_global_transformation: %s\n" % e)
Response Members
None: an empty object {} means success.

Get Devices DFU History Notehub

Get host MCU or Notecard DFU history for all devices that match the filter criteria.

HTTP Method:GET
URL:https://api.notefile.net/v1/projects/{projectUID}/dfu/{firmwareType}/history
Path Parameters:
  • projectUID - The ProjectUID of a Notehub project.
  • firmwareType - The type of firmware update to perform. Available values are notecard for updating Notecard firmware, and host for updating host firmware.
Minimum Notehub project-level role:viewer
Required HTTP Headers:Authorization: Bearer <access_token>, where the access token is a Notehub API bearer token.
Arguments

pageSize

integer (optional)

Specifies the number of devices to be returned by a request (default 50).

pageNum

integer (optional)

Specifies the page number of the results returned (useful when the pageSize is less than the total number of devices that could be returned). When provided, the pageNum must be >= 1.

sortBy

string (optional)

Specifies a field in the result set to sort by, and must be one of the following: best_id, device_serial, device_uid, captured, modified, device_location, tower_location, triangulated_location, best_location.

sortOrder

string (optional)

Specifies the ascending (asc) or descending (desc) order of the result set when paired with sortBy. The default is asc.

deviceUID

Array (optional)

An array of DeviceUIDs of Notehub devices.

tag

Array (optional)

An array of one or more tags to filter the devices by.

serialNumber

Array (optional)

An array of device serial numbers to filter by.

fleetUID

Array (optional)

An array of FleetUIDs to filter by.

notecardFirmware

Array (optional)

An array of one or more Notecard firmware versions to filter the devices by. Any numeric portion of the firmware name like "7.4.2.16888" or "7.4" is acceptable.

location

Array (optional)

An array of one or more locations to filter the devices by. Provide city, state, or country code like "Boston, MA", "Boston", "MA", or "Guildford, ENG, GB" (this field supports partial/case insensitive matches).

hostFirmware

Array (optional)

An array of one or more host firmware versions to filter the devices by. Any string of host firmware like "foo-3.4" or "8.7.6" or "baz-bar-01" is acceptable.

productUID

Array (optional)

An array of one or more ProductUIDs to filter the devices by.

sku

Array (optional)

An array of one or more Notecard SKUs to filter the devices by.

curl -X GET
     -L '/v1/projects/<projectUID>/dfu/<firmwareType>/history'
     -H 'Authorization: Bearer <access_token>'
import * as NotehubJs from "@blues-inc/notehub-js";
let defaultClient = "NotehubJs.ApiClient.instance";
// Configure API key authorization: api_key
let api_key = defaultClient.authentications["api_key"];
api_key.apiKey = "YOUR API KEY";
let apiInstance = new NotehubJs.ProjectApi();
let projectUID = "app:2606f411-dea6-44a0-9743-1130f57d77d8"; // String |
let firmwareType = "firmwareType_example"; // String |
let opts = {
  pageSize: 50, // Number |
  pageNum: 1, // Number |
  sortBy: "captured", // String |
  sortOrder: "asc", // String |
  deviceUID: ["null"], // [String] | A Device UID.
  tag: ["null"], // [String] | Tag filter
  serialNumber: ["null"], // [String] | Serial number filter
  fleetUID: "fleetUID_example", // String |
  notecardFirmware: ["null"], // [String] | Firmware version filter
  location: ["null"], // [String] | Location filter
  hostFirmware: ["null"], // [String] | Host firmware filter
  productUID: ["null"], // [String] |
  sku: ["null"] // [String] | SKU filter
};
apiInstance.getDevicesDfuHistory(projectUID, firmwareType, opts).then((data) => {
  console.log("API called successfully. Returned data: " + JSON.stringify(data));
}, (error) => {
  console.error(error);
});
import notehub_py
from notehub_py.models.device_dfu_history_page import DeviceDfuHistoryPage
from notehub_py.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.notefile.net
configuration = notehub_py.Configuration(
    host = "https://api.notefile.net"
)

# Configure API key authorization: api_key
configuration.api_key["api_key"] = os.environ["API_KEY"]

# Enter a context with an instance of the API client
with notehub_py.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = notehub_py.ProjectApi(api_client)
    project_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | 
    firmware_type = "firmware_type_example" # str | 
    page_size = 50 # int |  (optional) (default to 50)
    page_num = 1 # int |  (optional) (default to 1)
    sort_by = "captured" # str |  (optional) (default to "captured")
    sort_order = "asc" # str |  (optional) (default to "asc")
    device_uid = ["device_uid_example"] # List[str] | A Device UID. (optional)
    tag = ["tag_example"] # List[str] | Tag filter (optional)
    serial_number = ["serial_number_example"] # List[str] | Serial number filter (optional)
    fleet_uid = "fleet_uid_example" # str |  (optional)
    notecard_firmware = ["notecard_firmware_example"] # List[str] | Firmware version filter (optional)
    location = ["location_example"] # List[str] | Location filter (optional)
    host_firmware = ["host_firmware_example"] # List[str] | Host firmware filter (optional)
    product_uid = ["product_uid_example"] # List[str] |  (optional)
    sku = ["sku_example"] # List[str] | SKU filter (optional)

    try:
        api_response = api_instance.get_devices_dfu_history(project_uid, firmware_type, page_size=page_size, page_num=page_num, sort_by=sort_by, sort_order=sort_order, device_uid=device_uid, tag=tag, serial_number=serial_number, fleet_uid=fleet_uid, notecard_firmware=notecard_firmware, location=location, host_firmware=host_firmware, product_uid=product_uid, sku=sku)
        print("The response of ProjectApi->get_devices_dfu_history:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectApi->get_devices_dfu_history: %s\n" % e)
curl -X GET
     -L '/v1/projects/<projectUID>/dfu/<firmwareType>/history?pageSize=<pageSize>&pageNum=<pageNum>&sortBy=<sortBy>&sortOrder=<sortOrder>&deviceUID=<deviceUID>&tag=<tag>&serialNumber=<serialNumber>&fleetUID=<fleetUID>&notecardFirmware=<notecardFirmware>&location=<location>&hostFirmware=<hostFirmware>&productUID=<productUID>&sku=<sku>'
     -H 'Authorization: Bearer <access_token>'
Response Members

device_uid

string

The unique DeviceUID of the Notehub device

current.version

string

The current version number of the firmware file.

current.organization

string

The organization distributing the firmware.

current.product

string

The ProductUID of the Notecard device.

current.built

string

The date and time the firmware was built.

Example Response
{
"devices": [
    {
      "device_uid": "dev:000000000000000",
      "current": {
          "version": "1.5.3.12345",
          "organization": "Blues Wireless",
          "product": "Notecard",
          "built": "Feb 19 2021 13:45:28"
      }
    },
    {
      "device_uid": "dev:000000000000001",
      "current": {
          "version": "1.5.3.67890",
          "organization": "Blues Wireless",
          "product": "Notecard",
          "built": "Feb 19 2021 13:45:28"
      }
    },
    {
      "device_uid": "dev:000000000000002",
      "current": {
          "version": "1.5.3.12606",
          "organization": "Blues Wireless",
          "product": "Notecard",
          "built": "Mar 23 2021 08:31:26"
      }
    }
  ],
}

Get Devices DFU Status Notehub

Get host MCU or Notecard DFU status information for all devices that match the filter criteria.

HTTP Method:GET
URL:https://api.notefile.net/v1/projects/{projectUID}/dfu/{firmwareType}/status
Path Parameters:
  • projectUID - The ProjectUID of a Notehub project.
  • firmwareType - The type of firmware update to perform. Available values are notecard for updating Notecard firmware, and host for updating host firmware.
Minimum Notehub project-level role:viewer
Required HTTP Headers:Authorization: Bearer <access_token>, where the access token is a Notehub API bearer token.
Arguments

pageSize

integer (optional)

Specifies the number of devices to be returned by a request (default 50).

pageNum

integer (optional)

Specifies the page number of the results returned (useful when the pageSize is less than the total number of devices that could be returned). When provided, the pageNum must be >= 1.

sortBy

string (optional)

Specifies a field in the result set to sort by, and must be one of the following: best_id, device_serial, device_uid, captured, modified, device_location, tower_location, triangulated_location, best_location.

sortOrder

string (optional)

Specifies the ascending (asc) or descending (desc) order of the result set when paired with sortBy. The default is asc.

deviceUID

Array (optional)

An array of DeviceUIDs of Notehub devices.

tag

Array (optional)

An array of one or more tags to filter the devices by.

serialNumber

Array (optional)

An array of device serial numbers to filter by.

fleetUID

Array (optional)

An array of FleetUIDs to filter by.

notecardFirmware

Array (optional)

An array of one or more Notecard firmware versions to filter the devices by. Any numeric portion of the firmware name like "7.4.2.16888" or "7.4" is acceptable.

location

Array (optional)

An array of one or more locations to filter the devices by. Provide city, state, or country code like "Boston, MA", "Boston", "MA", or "Guildford, ENG, GB" (this field supports partial/case insensitive matches).

hostFirmware

Array (optional)

An array of one or more host firmware versions to filter the devices by. Any string of host firmware like "foo-3.4" or "8.7.6" or "baz-bar-01" is acceptable.

productUID

Array (optional)

An array of one or more ProductUIDs to filter the devices by.

sku

Array (optional)

An array of one or more Notecard SKUs to filter the devices by.

curl -X GET
     -L '/v1/projects/<projectUID>/dfu/<firmwareType>/status'
     -H 'Authorization: Bearer <access_token>'
import * as NotehubJs from "@blues-inc/notehub-js";
let defaultClient = NotehubJs.ApiClient.instance;
// Configure API key authorization: api_key
let api_key = defaultClient.authentications["api_key"];
api_key.apiKey = "YOUR API KEY";
let apiInstance = new NotehubJs.ProjectApi();
let projectUID = "app:2606f411-dea6-44a0-9743-1130f57d77d8"; // String |
let firmwareType = "firmwareType_example"; // String |
let opts = {
  pageSize: 50, // Number |
  pageNum: 1, // Number |
  sortBy: "captured", // String |
  sortOrder: "asc", // String |
  deviceUID: ["null"], // [String] | A Device UID.
  tag: ["null"], // [String] | Tag filter
  serialNumber: ["null"], // [String] | Serial number filter
  fleetUID: "fleetUID_example", // String |
  notecardFirmware: ["null"], // [String] | Firmware version filter
  location: ["null"], // [String] | Location filter
  hostFirmware: ["null"], // [String] | Host firmware filter
  productUID: ["null"], // [String] |
  sku: ["null"] // [String] | SKU filter
};
apiInstance.getDevicesDfuStatus(projectUID, firmwareType, opts).then((data) => {
  console.log("API called successfully. Returned data: " + JSON.stringify(data));
}, (error) => {
  console.error(error);
});
import notehub_py
from notehub_py.models.device_dfu_status_page import DeviceDfuStatusPage
from notehub_py.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.notefile.net
configuration = notehub_py.Configuration(
    host = "https://api.notefile.net"
)

# Configure API key authorization: api_key
configuration.api_key["api_key"] = os.environ["API_KEY"]

# Enter a context with an instance of the API client
with notehub_py.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = notehub_py.ProjectApi(api_client)
    project_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | 
    firmware_type = "firmware_type_example" # str | 
    page_size = 50 # int |  (optional) (default to 50)
    page_num = 1 # int |  (optional) (default to 1)
    sort_by = "captured" # str |  (optional) (default to "captured")
    sort_order = "asc" # str |  (optional) (default to "asc")
    device_uid = ["device_uid_example"] # List[str] | A Device UID. (optional)
    tag = ["tag_example"] # List[str] | Tag filter (optional)
    serial_number = ["serial_number_example"] # List[str] | Serial number filter (optional)
    fleet_uid = "fleet_uid_example" # str |  (optional)
    notecard_firmware = ["notecard_firmware_example"] # List[str] | Firmware version filter (optional)
    location = ["location_example"] # List[str] | Location filter (optional)
    host_firmware = ["host_firmware_example"] # List[str] | Host firmware filter (optional)
    product_uid = ["product_uid_example"] # List[str] |  (optional)
    sku = ["sku_example"] # List[str] | SKU filter (optional)

    try:
        api_response = api_instance.get_devices_dfu_status(project_uid, firmware_type, page_size=page_size, page_num=page_num, sort_by=sort_by, sort_order=sort_order, device_uid=device_uid, tag=tag, serial_number=serial_number, fleet_uid=fleet_uid, notecard_firmware=notecard_firmware, location=location, host_firmware=host_firmware, product_uid=product_uid, sku=sku)
        print("The response of ProjectApi->get_devices_dfu_status:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectApi->get_devices_dfu_status: %s\n" % e)
curl -X GET
     -L '/v1/projects/<projectUID>/dfu/<firmwareType>/status?pageSize=<pageSize>&pageNum=<pageNum>&sortBy=<sortBy>&sortOrder=<sortOrder>&deviceUID=<deviceUID>&tag=<tag>&serialNumber=<serialNumber>&fleetUID=<fleetUID>&notecardFirmware=<notecardFirmware>&location=<location>&hostFirmware=<hostFirmware>&productUID=<productUID>&sku=<sku>'
     -H 'Authorization: Bearer <access_token>'
Response Members

device_uid

string

The unique DeviceUID of the Notehub device.

dfu_in_progress

boolean

Indicates if a DFU is in progress.

current.version

string

The current version number of the firmware file.

current.organization

string

The organization distributing the firmware.

current.product

string

The ProductUID of the Notecard device.

current.built

string

The date and time the firmware was built.

status

object

The status of the DFU.

Example Response
{
    "devices": [
        {
            "device_uid": "dev:000000000000000",
            "current": {
                "version": "1.5.3.12345",
                "organization": "Blues Wireless",
                "product": "Notecard",
                "built": "Feb 19 2021 13:45:28"
            },
            "status": {}
        },
        {
            "device_uid": "dev:000000000000001",
            "current": {
                    "version": "1.5.3.67890",
                    "organization": "Blues Wireless",
                    "product": "Notecard",
                    "built": "Feb 19 2021 13:45:28"
            },
            "status": {}
        },
        {
            "device_uid": "dev:000000000000002",
            "dfu_in_progress": true,
            "current": {
                "version": "1.5.3.12606",
                "organization": "Blues Wireless",
                "product": "Notecard",
                "built": "Mar 23 2021 08:31:26"
            },
            "status": {}
        },
    ]
}

Get Device DFU History Notehub

Get device DFU history for host MCU or Notecard firmware updates.

HTTP Method:GET
URL:https://api.notefile.net/v1/projects/<projectUID>/devices/<deviceUID>/dfu/<firmwareType>/history
Path Parameters:
  • projectUID - The ProjectUID of a Notehub project.
  • deviceUID - The DeviceUID of a Notehub device. You may alternatively provide a device serial number by prefixing this argument with sn:, for example sn:my-device.
  • firmwareType - The type of firmware update to perform. Available values are notecard for updating Notecard firmware, and host for updating host firmware.
Minimum Notehub project-level role:viewer
Required HTTP Headers:Authorization: Bearer <access_token>, where the access token is a Notehub API bearer token.
Arguments
None
curl -X GET
     -L '/v1/projects/<projectUID>/devices/<deviceUID>/dfu/<firmwareType>/history'
     -H 'Authorization: Bearer <access_token>'
import * as NotehubJs from "@blues-inc/notehub-js";
let defaultClient = NotehubJs.ApiClient.instance;
// Configure API key authorization: api_key
let api_key = defaultClient.authentications["api_key"];
api_key.apiKey = "YOUR API KEY";
let apiInstance = new NotehubJs.ProjectApi();
let projectUID = "app:2606f411-dea6-44a0-9743-1130f57d77d8"; // String |
let deviceUID = "dev:000000000000000"; // String |
let firmwareType = "firmwareType_example"; // String |
apiInstance.getDeviceDfuHistory(projectUID, deviceUID, firmwareType).then((data) => {
  console.log("API called successfully. Returned data: " + JSON.stringify(data));
}, (error) => {
  console.error(error);
});
import notehub_py
from notehub_py.models.device_dfu_history import DeviceDfuHistory
from notehub_py.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.notefile.net
configuration = notehub_py.Configuration(
    host = "https://api.notefile.net"
)

# Configure API key authorization: api_key
configuration.api_key["api_key"] = os.environ["API_KEY"]

# Enter a context with an instance of the API client
with notehub_py.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = notehub_py.ProjectApi(api_client)
    project_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | 
    device_uid = "dev:000000000000000" # str | 
    firmware_type = "firmware_type_example" # str | 

    try:
        api_response = api_instance.get_device_dfu_history(project_uid, device_uid, firmware_type)
        print("The response of ProjectApi->get_device_dfu_history:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectApi->get_device_dfu_history: %s\n" % e)
Response Members

device_uid

string

The unique DeviceUID of the Notehub device

current.version

string

The current version number of the firmware file.

current.organization

string

The organization distributing the firmware.

current.product

string

The ProductUID of the Notecard device.

current.built

string

The date and time the firmware was built.

Example Response
{
  "device_uid": "dev:000000000000000",
  "current": {
    "version": "1.5.3.12345",
    "organization": "Blues Wireless",
    "product": "Notecard",
    "built": "Feb 19 2021 13:45:28"
  },
}

Get Device DFU Status Notehub

Get device DFU status information for host MCU or Notecard firmware.

HTTP Method:GET
URL:https://api.notefile.net/v1/projects/{projectUID}/devices/{deviceUID}/dfu/{firmwareType}/status
Path Parameters:
  • projectUID - The ProjectUID of a Notehub project.
  • deviceUID - The DeviceUID of a Notehub device. You may alternatively provide a device serial number by prefixing this argument with sn:, for example sn:my-device.
  • firmwareType - The type of firmware update to perform. Available values are notecard for updating Notecard firmware, and host for updating host firmware.
Minimum Notehub project-level role:viewer
Required HTTP Headers:Authorization: Bearer <access_token>, where the access token is a Notehub API bearer token.
Arguments
None
curl -X GET
     -L '/v1/projects/<projectUID>/devices/<deviceUID>/dfu/<firmwareType>/status'
     -H 'Authorization: Bearer <access_token>'
import * as NotehubJs from "@blues-inc/notehub-js";
let defaultClient = NotehubJs.ApiClient.instance;
// Configure API key authorization: api_key
let api_key = defaultClient.authentications["api_key"];
api_key.apiKey = "YOUR API KEY";
let apiInstance = new NotehubJs.ProjectApi();
let projectUID = "app:2606f411-dea6-44a0-9743-1130f57d77d8"; // String |
let deviceUID = "dev:000000000000000"; // String |
let firmwareType = "firmwareType_example"; // String |
apiInstance.getDeviceDfuStatus(projectUID, deviceUID, firmwareType).then((data) => {
  console.log("API called successfully. Returned data: " + JSON.stringify(data));
}, (error) => {
  console.error(error);
});
import notehub_py
from notehub_py.models.device_dfu_status import DeviceDfuStatus
from notehub_py.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.notefile.net
configuration = notehub_py.Configuration(
    host = "https://api.notefile.net"
)

# Configure API key authorization: api_key
configuration.api_key["api_key"] = os.environ["API_KEY"]

# Enter a context with an instance of the API client
with notehub_py.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = notehub_py.ProjectApi(api_client)
    project_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | 
    device_uid = "dev:000000000000000" # str | 
    firmware_type = "firmware_type_example" # str | 

    try:
        api_response = api_instance.get_device_dfu_status(project_uid, device_uid, firmware_type)
        print("The response of ProjectApi->get_device_dfu_status:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectApi->get_device_dfu_status: %s\n" % e)
Response Members

device_uid

string

The unique DeviceUID of the Notehub device.

dfu_in_progress

boolean

Indicates if a DFU is in progress.

current.version

string

The current version number of the firmware file.

current.organization

string

The organization distributing the firmware.

current.product

string

The ProductUID of the Notecard device.

current.built

string

The date and time the firmware was built.

status

object

The status of the DFU.

Example Response
{
    "device_uid": "dev:000000000000000",
    "dfu_in_progress": true,
    "current": {
        "version": "1.5.3.12345",
        "organization": "Blues Wireless",
        "product": "Notecard",
        "built": "Mar 23 2021 08:31:26"
    },
    "status": {}
}

Get Available Firmware Notehub

Get an array of available host MCU or Notecard firmware files by ProjectUID.

HTTP Method:GET
URL:https://api.notefile.net/v1/projects/{projectUID}/firmware
Path Parameters:
  • projectUID - The ProjectUID of a Notehub project.
Minimum Notehub project-level role:viewer
Required HTTP Headers:Authorization: Bearer <access_token>, where the access token is a Notehub API bearer token.
Arguments

firmwareType

string (optional)

Limit the query to return only certain types of firmware. Available options are notecard for Notecard firmware or host for host firmware.

target

string (optional)

The target architecture of Notecard firmware to return. Available values: "r5", "s3", "u5", "wl".

See Notecard Firmware Updates for details.

curl -X GET
    -L 'https://api.notefile.net/v1/projects/<projectUID>/firmware'
    -H 'Authorization: Bearer <access_token>'
import * as NotehubJs from "@blues-inc/notehub-js";
let defaultClient = NotehubJs.ApiClient.instance;
// Configure API key authorization: api_key
let api_key = defaultClient.authentications["api_key"];
api_key.apiKey = "YOUR API KEY";

let apiInstance = new NotehubJs.ProjectApi();
let projectUID = "app:2606f411-dea6-44a0-9743-1130f57d77d8"; // String |
let opts = {
  product: "product_example", // String |
  firmwareType: "firmwareType_example", // String |
  version: "version_example", // String |
  target: "target_example", // String |
  filename: "notecard-7.2.2.16518$20240410043100.bin", // String |
  md5: "md5_example", // String |
  unpublished: true // Boolean |
};
apiInstance.getFirmwareInfo(projectUID, opts).then((data) => {
  console.log("API called successfully. Returned data: " + JSON.stringify(data));
}, (error) => {
  console.error(error);
});
import notehub_py
from notehub_py.models.firmware_info import FirmwareInfo
from notehub_py.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.notefile.net
configuration = notehub_py.Configuration(
    host = "https://api.notefile.net"
)

# Configure API key authorization: api_key
configuration.api_key["api_key"] = os.environ["API_KEY"]

# Enter a context with an instance of the API client
with notehub_py.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = notehub_py.ProjectApi(api_client)
    project_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | 
    product = "product_example" # str |  (optional)
    firmware_type = "firmware_type_example" # str |  (optional)
    version = "version_example" # str |  (optional)
    target = "target_example" # str |  (optional)
    filename = "notecard-7.2.2.16518$20240410043100.bin" # str |  (optional)
    md5 = "md5_example" # str |  (optional)
    unpublished = True # bool |  (optional)

    try:
        api_response = api_instance.get_firmware_info(project_uid, product=product, firmware_type=firmware_type, version=version, target=target, filename=filename, md5=md5, unpublished=unpublished)
        print("The response of ProjectApi->get_firmware_info:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectApi->get_firmware_info: %s\n" % e)
curl -X GET
    -L 'https://api.notefile.net/v1/projects/<projectUID>/fleets/firmware?firmwareType=<type>&target=<target>'
    -H 'Authorization: Bearer <access_token>'
Response Members

filename

string

The filename of the firmware file.

version

string

The version number of the firmware file.

MD5

string

The MD5 hash of the firmware file.

organization

string

The organization distributing the firmware.

type

string

The type of firmware file, either "notecard" or "host".

created

UNIX Epoch time

A timestamp for when the firmware file was created.

target

string

The target architecture for Notecard firmware file.

Example Response
[
  {
    "filename": "notecard-wl-7.2.2.16518$20240410043100.bin",
    "version": "notecard-wl-7.2.2",
    "MD5": "8c1f7737a134f108dab02ec6d6b4bf25",
    "organization": "Blues Wireless",
    "type": "notecard",
    "created": "1712780230",
    "target": "wl"
  },
  ...
]

Create DFU Action Notehub

Update or cancel host MCU firmware updates or Notecard firmware updates.

HTTP Method:POST
URL:https://api.notefile.net/v1/projects/{projectUID}/dfu/{firmwareType}/{action}
Path Parameters:
  • projectUID - The ProjectUID of a Notehub project.
  • firmwareType - The type of firmware update to perform. Available values are notecard for updating Notecard firmware, and host for updating host firmware.
  • action - The action to perform. Available values are update for updating firmware, and cancel for canceling an update.
Minimum Notehub project-level role:developer
Required HTTP Headers:Authorization: Bearer <access_token>, where the access token is a Notehub API bearer token.
Arguments

deviceUID

Array (optional)

An array of DeviceUIDs of Notehub devices.

This argument must be provided in the query string, e.g. ?deviceUID=dev:123456789.

tag

Array (optional)

An array of tags to filter devices.

This argument must be provided in the query string, e.g. ?tag=mytag.

serialNumber

Array (optional)

An array of serial numbers to filter devices.

This argument must be provided in the query string, e.g. ?serialNumber=mySerialNumber.

fleetUID

string (optional)

A FleetUID of a Notehub fleet.

This argument must be provided in the query string, e.g. ?fleetUID=fleet:abc-123.

notecardFirmware

Array (optional)

An array of Notecard firmware versions to filter devices.

This argument must be provided in the query string, e.g. ?notecardFirmware=7.5.2.17004.

location

Array (optional)

An array of locations to filter devices.

This argument must be provided in the query string, e.g. ?location=Michigan.

hostFirmware

Array (optional)

An array of host firmware versions to filter devices.

This argument must be provided in the query string, e.g. ?hostFirmware=1.0.0.

productUID

Array (optional)

An array of one or more ProductUIDs to filter the devices by.

This argument must be provided in the query string, e.g. ?productUID=com.company.name:projectName.

sku

Array (optional)

An array of SKUs to filter devices.

This argument must be provided in the query string, e.g. ?sku=NOTE-WBNAW.

filename

string

The name of the firmware file to upload.

This argument must be provided in the POST body, e.g. {"filename":"notecard-u5-8.1.3.17044$20241220135610.bin"}.

curl -X POST
     -L 'https://api.notefile.net/v1/projects/<projectUID>/dfu/<firmwareType>/<action>'
     -H 'Authorization: Bearer <access_token>'
     -d '{"filename":<filename>}'
import * as NotehubJs from "@blues-inc/notehub-js";
let defaultClient = NotehubJs.ApiClient.instance;
// Configure API key authorization: api_key
let api_key = defaultClient.authentications["api_key"];
api_key.apiKey = "YOUR API KEY";

let apiInstance = new NotehubJs.ProjectApi();
let projectUID = "app:2606f411-dea6-44a0-9743-1130f57d77d8"; // String |
let firmwareType = "firmwareType_example"; // String |
let action = "action_example"; // String |
let opts = {
  deviceUID: ["null"], // [String] | A Device UID.
  tag: ["null"], // [String] | Tag filter
  serialNumber: ["null"], // [String] | Serial number filter
  fleetUID: "fleetUID_example", // String |
  notecardFirmware: ["null"], // [String] | Firmware version filter
  location: ["null"], // [String] | Location filter
  hostFirmware: ["null"], // [String] | Host firmware filter
  productUID: ["null"], // [String] |
  sku: ["null"], // [String] | SKU filter
  dfuActionRequest: new NotehubJs.DfuActionRequest() // DfuActionRequest | Which firmware in the case of an update action
};
apiInstance.dfuAction(projectUID, firmwareType, action, opts).then(() => {
  console.log("API called successfully.");
}, (error) => {
  console.error(error);
});
import notehub_py
from notehub_py.models.dfu_action_request import DfuActionRequest
from notehub_py.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.notefile.net
configuration = notehub_py.Configuration(
    host = "https://api.notefile.net"
)

# Configure API key authorization: api_key
configuration.api_key["api_key"] = os.environ["API_KEY"]

# Enter a context with an instance of the API client
with notehub_py.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = notehub_py.ProjectApi(api_client)
    project_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | 
    firmware_type = "firmware_type_example" # str | 
    action = "action_example" # str | 
    device_uid = ["device_uid_example"] # List[str] | A Device UID. (optional)
    tag = ["tag_example"] # List[str] | Tag filter (optional)
    serial_number = ["serial_number_example"] # List[str] | Serial number filter (optional)
    fleet_uid = "fleet_uid_example" # str |  (optional)
    notecard_firmware = ["notecard_firmware_example"] # List[str] | Firmware version filter (optional)
    location = ["location_example"] # List[str] | Location filter (optional)
    host_firmware = ["host_firmware_example"] # List[str] | Host firmware filter (optional)
    product_uid = ["product_uid_example"] # List[str] |  (optional)
    sku = ["sku_example"] # List[str] | SKU filter (optional)
    dfu_action_request = notehub_py.DfuActionRequest() # DfuActionRequest | Which firmware in the case of an update action (optional)

    try:
        api_instance.dfu_action(project_uid, firmware_type, action, device_uid=device_uid, tag=tag, serial_number=serial_number, fleet_uid=fleet_uid, notecard_firmware=notecard_firmware, location=location, host_firmware=host_firmware, product_uid=product_uid, sku=sku, dfu_action_request=dfu_action_request)
    except Exception as e:
        print("Exception when calling ProjectApi->dfu_action: %s\n" % e)
curl -X POST
     -L 'https://api.notefile.net/v1/projects/<projectUID>/products?deviceUID=<deviceUID>&tag=<tag>&serialNumber=<serialNumber>&fleetUID=<fleetUID>&notecardFirmware=<notecardFirmware>&location=<location>&hostFirmware=<hostFirmware>&productUID=<productUID>&sku=<sku>'
     -H 'Authorization: Bearer <access_token>'
     -d '{"filename":<filename>}'
     -H 'Authorization: Bearer <access_token>'
Response Members
None: an empty object {} means success.
Monitor API Route API
Can we improve this page? Send us feedback
© 2025 Blues Inc.
© 2025 Blues Inc.
TermsPrivacy
Notecard Disconnected
Having trouble connecting?

Try changing your USB cable as some cables do not support transferring data. If that does not solve your problem, contact us at support@blues.com and we will get you set up with another tool to communicate with the Notecard.

Advanced Usage

The help command gives more info.

Connect a Notecard
Use USB to connect and start issuing requests from the browser.
Try Notecard Simulator
Experiment with Notecard's latest firmware on a Simulator assigned to your free Notehub account.

Don't have an account? Sign up