Rate this page Â
- ★★
- ★★
- ★★
- ★★
- ★★
Can we improve this page? Send us feedbackRate this page
- ★★
- ★★
- ★★
- ★★
- ★★
The Notehub fleet API provides RESTful methods that can be used to GET,
POST, PUT, and DELETE data related to fleets.
Get an array of fleets associated with a ProjectUID.
Minimum Notehub project-level role required:
curl -X GET -L 'https://api.notefile.net/v1/projects/<projectUID>/fleets' -H 'Authorization: Bearer <access_token>'
uidstring
The globally-unique identifier of the fleet.
labelstring
The user-defined label of the fleet.
createdstring
The date and time the fleet was created.
{ "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 a new device fleet within a Notehub project.
Minimum Notehub project-level role required:
access_tokenstring
A Notehub API bearer token.
projectUIDstring
The ProjectUID of a Notehub project.
labelstring
The requested label for the fleet.
curl -X POST -L 'https://api.notefile.net/v1/projects/<projectUID>/fleets' -H 'Authorization: Bearer <access_token>' -d '{"label":"<label>"}'
uidstring
The globally-unique identifier for the fleet.
labelstring
The user-defined label of the fleet.
createdtime stamp
The date/time the fleet was created.
{ "uid":"fleet:00000000-0000-0000-0000-000000000000", "label":"My Fleet Label", "created":"2021-10-12T16:21:54Z" }
Update the label of a device fleet.
Minimum Notehub project-level role required:
access_tokenstring
A Notehub API bearer token.
projectUIDstring
The ProjectUID of a Notehub project.
fleetUIDstring
The FleetUID of a Notehub device fleet.
labelstring
The updated label for the fleet.
addDevicesarray (optional)
A list of DeviceUIDs to add to the fleet.
removeDevicesarray (optional)
A list of DeviceUIDs to remove from the fleet.
curl -X PUT -L 'https://api.notefile.net/v1/projects/<projectUID>/fleets/<fleetUID>' -H 'Authorization: Bearer <access_token>' -d '{"label":"<label>"}'
uidstring
The globally-unique identifier for the fleet.
labelstring
The user-defined label of the fleet.
createdtime stamp
The date/time the fleet was created.
{ "uid":"fleet:00000000-0000-0000-0000-000000000000", "label":"My Fleet Label", "created":"2021-10-12T16:21:54Z" }
Delete a device fleet.
Minimum Notehub project-level role required:
access_tokenstring
A Notehub API bearer token.
projectUIDstring
The ProjectUID of a Notehub project.
fleetUIDstring
The FleetUID of a Notehub device fleet.
curl -X DELETE -L 'https://api.notefile.net/v1/projects/<projectUID>/fleets/<fleetUID>' -H 'Authorization: Bearer <access_token>'
Get an array of fleets associated with a device.
Minimum Notehub project-level role required:
access_tokenstring
A Notehub API bearer token.
projectUIDstring
The ProjectUID from a Notehub project.
deviceUIDstring
The globally-unique identifier of a device.
You may alternatively provide a device serial number by prefixing this argument
with sn:, for example sn:my-device.
curl -X GET -L 'https://api.notefile.net/v1/projects/<projectUID>/devices/<deviceUID>/fleets' -H 'Authorization: Bearer <access_token>'
uidstring
The globally-unique identifier of the fleet.
labelstring
The user-defined label of the fleet.
createdstring
The date and time the fleet was created.
{ "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" } ] }
Get an array of devices associated with a fleet.
Minimum Notehub project-level role required:
access_tokenstring
A Notehub API bearer token.
projectUIDstring
The ProjectUID from a Notehub project.
fleetUIDstring
The globally-unique identifier of a fleet.
curl -X GET -L 'https://api.notefile.net/v1/projects/<projectUID>/fleets/<fleetUID>/devices' -H 'Authorization: Bearer <access_token>'
uidstring
The globally-unique identifier of the device.
serial_numberstring
The user-defined serial number of the device.
provisionedstring
The date and time this device was first provisioned, or put into use.
last_activitystring
The date and time this device was last seen by Notehub.
contactobject
Contact information for this device, specified via environment variables.
product_uidstring
The ProductUID this device is associated with.
fleet_uidsarray
An array of globally-unique identifiers for the fleet(s) this device is associated with.
tower_infoobject
An object containing data about the cellular tower last accessed by this device.
tower_info.mccint
The mobile country code of the cell tower.
tower_info.mncint
The mobile network code of the cell tower, which identifies the mobile operator.
tower_info.lacint
The location area code of the cell tower, which is a unique identifier of the current location area.
tower_info.cell_idint
The Cell ID or CID of the cell tower. This is a unique number used to identify each Base Transceiver Station (BTS) or sector of a BTS within a location area code.
tower_locationobject
An object containing information about the physical location of the cell tower.
gps_locationobject
An object containing information about the physical location of the device, based on GPS coordinates.
triangulated_locationobject
An object containing information about the physical location of the device based on triangulated data calculated by multiple cell towers.
voltagedecimal
The most recent measure of the voltage from the onboard voltage monitor.
temperaturedecimal
The most recent temperature measure in celsius from the onboard temperature sensor.
has_moreboolean
Defines whether or not there are additional devices beyond this list.
{ "devices":[ { "uid":"dev:000000000000000", "serial_number":"", "provisioned":"2021-02-11T02:37:16Z", "last_activity":"2021-05-11T19:37:08Z", "contact":null, "product_uid":"product:com.your-company.your-name:project", "fleet_uids":"[fleet:00000000-0000-0000-0000-000000000000]", "tower_info":{ "mcc":310, "mnc":410, "lac":12345, "cell_id":12345678 }, "tower_location":{ "when":"2021-05-11T19:34:23Z", "name":"Cassville MO", "country":"US", "timezone":"America/Chicago", "latitude":36.665537500000006, "longitude":-93.850109375 }, "gps_location":{ "same properties as tower_location" }, "triangulated_location":{ "same properties as tower_location" }, "voltage":5.15, "temperature":23.75 } ], "has_more":false }
Add a device to one or more fleets.
Minimum Notehub project-level role required:
access_tokenstring
A Notehub API bearer token.
projectUIDstring
The ProjectUID from a Notehub project.
deviceUIDstring
The globally-unique identifier of a device.
You may alternatively provide a device serial number by prefixing this argument
with sn:, for example sn:my-device.
fleet_uidsstring
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>]}'
uidstring
The globally-unique identifier of the fleet.
labelstring
The user-defined label of the fleet.
createdstring
The date and time the fleet was created.
{ "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" } ] }
Removes a device from one or more fleets.
Minimum Notehub project-level role required:
access_tokenstring
A Notehub API bearer token.
projectUIDstring
The ProjectUID from a Notehub project.
deviceUIDstring
The globally-unique identifier of a device.
You may alternatively provide a device serial number by prefixing this argument
with sn:, for example sn:my-device.
fleet_uidsstring 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>]}'
uidstring
The globally-unique identifier of the fleet.
labelstring
The user-defined label of the fleet.
createdstring
The date and time the fleet was created.
{ "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" } ] }