More REST Requests

This section lists a number of endpoints not explicitly covered in the “REST Requests” section above. They are organized first by type, and then grouped by pathway.

To find what you’re looking for easily, use the search bar to navigate this page.




Project Requests

These two calls take you to the endpoint for your projects; or, with a project_id, to that specific project’s endpoint.

v3/projects/
v3/projects/<project_id>/


With a project_id, you can visit the Cloud Switch endpoint, and can then enable or disable, as well as check on the status of your cloud provider with your unique cloud_id.

v3/projects/<project_id>/cloudswitch/
v3/projects/<project_id>/cloudswitch/<cloud_id>/
v3/projects/<project_id>/cloudswitch/<cloud_id>/disable/
v3/projects/<project_id>/cloudswitch/<cloud_id>/enable/
v3/projects/<project_id>/cloudswitch/<cloud_id>/status/


These two calls, with a project_id, take you to a listing endpoint of a project’s tags, or with a tag_id, to that specific tag’s endpoint.

v3/projects/<project_id>/tags/
v3/projects/<project_id>/tags/<tag_id>/


These endpoints follow a specific project_id to work with users. Here you have endpoints to register, activate, login, and remove users, as well as endpoints for a forgotten password and to resend validation email. Further, you can visit a listing endpoint of users in your project, as well as look up a specific user’s permissions within the project

v3/projects/<project_id>/users/activate/
v3/projects/<project_id>/users/forgotpassword/
v3/projects/<project_id>/users/login/
v3/projects/<project_id>/users/register/
v3/projects/<project_id>/users/remove/
v3/projects/<project_id>/users/resendemail/
v3/projects/<project_id>/users/validate_number/
v3/projects/<project_id>/users/
v3/projects/<project_id>/users/<user_id>/


Below, these endpoints allow you to look up a project with its project_id, and view the properties or groups listings; or, with a specific property_id or group_id, view that individual property or group.

v3/projects/<project_id>/properties/
v3/projects/<project_id>/properties/<property_id>/

v3/projects/<project_id>/groups/
v3/projects/<project_id>/groups/<group_id>/


With a project_id, you can view the devices in that project’s fleet, as well as activate, clone, or operate the device token on those devices. These endpoints refer to a project-wide fleet.

v3/projects/<project_id>/devices/
v3/projects/<project_id>/devices/activate/
v3/projects/<project_id>/devices/clone/
v3/projects/<project_id>/devices/operatedevicetoken/


With your project_id and a specific device_id, you can access a number of device endpoints.

v3/projects/<project_id>/devices/<device_id>/
v3/projects/<project_id>/devices/<device_id>/assign/
v3/projects/<project_id>/devices/<device_id>/changeclass/
v3/projects/<project_id>/devices/<device_id>/config/
v3/projects/<project_id>/devices/<device_id>/configurationfile/
v3/projects/<project_id>/devices/<device_id>/duplicate/
v3/projects/<project_id>/devices/<device_id>/firmware/
v3/projects/<project_id>/devices/<device_id>/layout/
v3/projects/<project_id>/devices/<device_id>/location/
v3/projects/<project_id>/devices/<device_id>/pkg/
v3/projects/<project_id>/devices/<device_id>/resetcache/

Note

These endpoints are also accessible through the device pathway, detailed below.




Device Requests

The endpoints below allow you to view the listing endpoint of your devices, or activate, clone, or operate the token for your devices. These are fleet-wide endpoints.

v3/devices/
v3/devices/activate/
v3/devices/clone/
v3/devices/operatedevicetoken/


With a specific device_id, you can control a single device with commands like duplicate and reset cache, as well as get information at endpoints like location and firmware. These are device-specific endpoints.

v3/devices/<device_id>/
v3/devices/<device_id>/assign/
v3/devices/<device_id>/changeclass/
v3/devices/<device_id>/config/
v3/devices/<device_id>/configurationfile/
v3/devices/<device_id>/duplicate/
v3/devices/<device_id>/firmware/
v3/devices/<device_id>/layout/
v3/devices/<device_id>/location/
v3/devices/<device_id>/pkg/
v3/devices/<device_id>/resetcache/


With your device_id, you can also view commands, configurations, and analytics on your device. You can further view individual commands and configurations with a command_id or configuration_id.

v3/devices/<device_id>/commands/
v3/devices/<device_id>/commands/<command_id>/
v3/devices/<device_id>/configurations/
v3/devices/<device_id>/configurations/<configuration_id>/
v3/devices/<device_id>/analytics/


The endpoints below allow you access to a device’s packages, API keys, users, groups, properties, and tags. You can also use a specific package_id, apikey_id, deviceuser_id, group_id, property_id, or tag_id.

v3/devices/<device_id>/packages/
v3/devices/<device_id>/packages/<package_id>/

v3/devices/<device_id>/apikeys/
v3/devices/<device_id>/apikeys/<apikey_id>/

V3/^devices/<device_id>/deviceusers/
v3/^devices/<device_id>/deviceusers/<deviceuser_id>/

v3/^devices/<device_id>/groups/
v3/^devices/<device_id>/groups/<group_id>/

v3/^devices/<device_id>/properties/
v3/^devices/<device_id>/properties/<property_id>/

v3/^devices/<device_id>/tags/
v3/^devices/<device_id>/tags/<tag_id>/


With a device_id, you can view the streams on a device, and with a stream_id, you can view the history, bulk, and latest. Further, with a trigger_id, you can view, enable, and disable your device’s triggers individually.

v3/^devices/<device_id>/streams/batch/
v3/^devices/<device_id>/streams/<stream_id>/history/
v3/^devices/<device_id>/streams/<stream_id>/bulk/
v3/^devices/<device_id>/streams/<stream_id>/latest/

v3/^devices/<device_id>/streams/<stream_id>/triggers/
v3/^devices/<device_id>/streams/<stream_id>/triggers/<trigger_id>/
v3/^devices/<device_id>/streams/<stream_id>/triggers/<trigger_id>/disable/
v3/^devices/<device_id>/streams/<stream_id>/triggers/<trigger_id>/enable/




User, Group, and Property Requests

The endpoints below offer you the ability to manage your team’s users. Besides viewing the listing of your team members, you can also register, validate phone number, and activate new users, login, and even remove users here.

v3/^users/
v3/^users/activate/
v3/^users/forgotpassword/
v3/^users/login/
v3/^users/register/
v3/^users/remove/
v3/^users/resendemail/
v3/^users/validate_number/
v3/^users/<user_id>/

Note

These endpoints refer to your team at large, as opposed to the users endpoints above that offer similar functionality within the scope of a single project.


You can use these endpoints to view your properties, or visit a specific property with a unique property_id.

v3/^properties/
v3/^properties/<property_id>/


You can access a listing endpoint for your groups, or with a group_id, visit a specific group.

v3/^groups/
v3/^groups/<group_id>/




Class Requests

The endpoints below allow you to view the listing of your classes, or use a specific class_id to visit that device class’s endpoint. From there, you can activate, clone, or operate the device token of your devices. Further, with a tag_id, you can view individual tags in your class. These endpoints are class-specific, and will affect all devices of this class.

v3/^classes/
v3/^classes/<class_id>/

v3/^classes/<class_id>/devices/activate/
v3/^classes/<class_id>/devices/clone/
v3/^classes/<class_id>/devices/operatedevicetoken/

v3/^classes/<class_id>/tags/
v3/^classes/<class_id>/tags/<tag_id>/


Following a unique device_class_id and a subsequent device_id, there are a variety of endpoints available, including options to duplicate the device, change its class, or reset the cache of a device. Further, one can look up the firmware, location, or pkg of a device, and can change its class or work in its configuration file.

v3/^classes/<class_id>/devices/
v3/^classes/<class_id>/devices/<device_id>/
v3/^classes/<class_id>/devices/<device_id>/assign/
v3/^classes/<class_id>/devices/<device_id>/changeclass/
v3/^classes/<class_id>/devices/<device_id>/config/
v3/^classes/<class_id>/devices/<device_id>/configurationfile/
v3/^classes/<class_id>/devices/<device_id>/duplicate/
v3/^classes/<class_id>/devices/<device_id>/firmware/
v3/^classes/<class_id>/devices/<device_id>/layout/
v3/^classes/<class_id>/devices/<device_id>/location/
v3/^classes/<class_id>/devices/<device_id>/pkg/
v3/^classes/<class_id>/devices/<device_id>/resetcache/

Note

These endpoints are available also through a project pathway and directly through a device pathway with your device_id. See above for these other options.


You can also find the listing endpoint for streams in a device class, or a specific stream with its stream_id, with the endpoints below.

v3/^classes/<class_id>/streams/
v3/^classes/<class_id>/streams/<stream_id>/


These endpoints allow you to access properties, or an individual with a specific property_id, through the classes pathway.

v3/^classes/<class_id>/properties/
v3/^classes/<class_id>/properties/<property_id>/


These endpoints give access to a list of firmwares under a class_id, allowing you to view an individual firmware, or to link with another firmware type.

v3/^classes/<class_id>/firmware/
v3/^classes/<class_id>/firmware/<firmware_id>/
v3/^classes/<class_id>/firmware/<firmware_id>/link/


The rollout endpoints allow you to view all, or with a rollout_id an individual rollout, and deploy. You can also view commands under a specific rollout_id, or view an individual with a command_id.

v3/^classes/<class_id>/rollouts/
v3/^classes/<class_id>/rollouts/<rollout_id>/
v3/^classes/<class_id>/rollouts/<rollout_id>/deploy/
v3/^classes/<class_id>/rollouts/<rollout_id>/commands/
v3/^classes/<class_id>/rollouts/<rollout_id>/commands/<command_id>/




Company Requests

With a company_id, you can view, as well as add and remove users from your company. The query report and report columns endpoints allow you to access data under your company_id.

v3/^companies/
v3/^companies/<company_id>/
v3/^companies/<company_id>/add_company_user/
v3/^companies/<company_id>/remove_company_user/
v3/^companies/<company_id>/query_report/
v3/^companies/<company_id>/report_columns/


These endpoints allow you to manage users directly through the company pathway. Any changes to users made with these endpoints is at the company level.

v3/^companies/<company_id>/users/
v3/^companies/<company_id>/users/<user_id>/
v3/^companies/<company_id>/users/activate/
v3/^companies/<company_id>/users/forgotpassword/
v3/^companies/<company_id>/users/login/
v3/^companies/<company_id>/users/register/
v3/^companies/<company_id>/users/remove/
v3/^companies/<company_id>/users/resendemail/
v3/^companies/<company_id>/users/validate_number/

Note

See above to access these functionalities directly through the user pathway.


With your company_id and a group_id or property_id, you can access groups and properties through your company pathway.

v3/^companies/<company_id>/groups/
v3/^companies/<company_id>/groups/<group_id>/

v3/^companies/<company_id>/properties/
v3/^companies/<company_id>/properties/<property_id>/