Skip to main content

Overview of the nRF Cloud APIs

This section introduces the nRF Cloud REST and MQTT APIs.

The following diagram shows the general relationships between the APIs, services, devices, and other components:

nRF Cloud API overview

nRF Cloud API overview


The nRF Cloud REST API refers to the parts of the nRF Cloud MQTT API that the device is allowed to use based on its IoT security policy. It supports device-to-cloud use cases.

The nRF Cloud REST API also includes the REST API endpoints that are authenticated using JSON Web Tokens. These endpoints are meant for devices, which is why nRF Cloud requires a high level of security.

Proxy service API

The proxy service API is a subset of REST API endpoints serving devices not provisioned on nRF Cloud. It serves cloud-to-cloud use cases, such as some integrations of Location Services. Cloud-to-cloud use of nRF Cloud requires a Pro or Enterprise plan.

User API

The remaining endpoints of the nRF Cloud API are the User API, which supports user-to-cloud and user-to-device operations.

The User API includes the nRF Cloud MQTT API endpoints that a user or application has permission to call. This involves either an MQTT client, such as a NodeJS app that uses an nRF Cloud account device to monitor and interact with all of that user's devices, or secure MQTT communication over Websockets, such as the nRF Cloud portal or phone gateway application.

The User API supports a variety of use cases, such as: