API docs by Redocly

nRF Cloud Admin Service (0.0.1)

Download OpenAPI specification:Download

URL: https://devzone.nordicsemi.com

Private REST API specification

REST API that allows admin personnel to do adminey things.

Devices

Operations for all types of devices.

getDeviceInfo

Get data about a device.

Authorizations:
CognitoJwtAuth
path Parameters
required
NominalStringDeviceId (string) (DeviceId) [ 1 .. 128 ] characters ^[a-zA-Z0-9:_-]{1,128}$
Examples:
  • nrf-351358815342057 -
  • nrf-351358815342057 -

This is the canonical device id used in the device certificate, and as the MQTT client id.

Responses

Response samples

Content type
application/json
{
  • "details": {
    }
}

Nordic Hardware Devices

Operations for Nordic hardware products such as the Thingy91 and nRF9160 DK.

addNordicHardwareDevices

Register Nordic hardware devices to the database.

If submitting a CSV file, each row must in the format (without quotes) "{productName},{IMEI},{ownershipCode},{productionDate (yyyy-mm-dd)},{version}", e.g., "pca10090,351901936646532,522649,2024-10-28,1.1.3". The IMEI will be used to store the device id as "nrf-". Do not use a header row.

When submitting JSON, the device id must start with "nrf-". In this case, and if needed, obtain the ownership code from the customer device owner.

The CA certificate associated with the device's certificate is resolved by the product name, which should start with "pca1" or "dk" (for DKs), and "pca2" or "thingy" for Thingy devices.

To verify that a device was uploaded you can use the getDeviceInfo endpoint.

Authorizations:
CognitoJwtAuth
Request Body schema:
required
required
Array of objects
Array
required
NominalStringNordicHardwareDeviceId (string) (NordicHardwareDeviceId) [ 19 .. 21 ] characters ^nrf-[\d]{15}([\d]{2})?$

This is the Nordic hardware product id, e.g., nrf-123456789012345, which consists of nrf- followed by the device's IMEI.

Any of
[ 19 .. 21 ] characters
string (NominalStringNordicHardwareDeviceId) [ 19 .. 21 ] characters ^nrf-[\d]{15}([\d]{2})?$

This is the Nordic hardware product id, e.g., nrf-123456789012345, which consists of nrf- followed by the device's IMEI.

required
NominalStringOwnershipCode (string) (OwnershipCode) ^[a-zA-Z0-9-:]{4,}$

For Nordic products this is the PIN or HWID printed on the label. Otherwise, this is the ownership code you set when creating a device certificate. All ownership codes are sanitized. Requires a min of 4 characters consisting only of numbers, letters, - or :.

Any of
string (NominalStringOwnershipCode) ^[a-zA-Z0-9-:]{4,}$

For Nordic products this is the PIN or HWID printed on the label. Otherwise, this is the ownership code you set when creating a device certificate. All ownership codes are sanitized. Requires a min of 4 characters consisting only of numbers, letters, - or :.

product
required
string (ProductName)
productionDate
string

Responses

Request samples

Content type
{
  • "devices": [
    ]
}

Response samples

Content type
application/json
{
  • "devicesAdded": 0
}

User Account

Operations for nRF Cloud user accounts

getUserAccountInfo

Get information about an nRF Cloud user account, including the user's teams.

Authorizations:
CognitoJwtAuth
Request Body schema: application/json
required
required
NominalStringEmail (string) <email> (Email)
Any of
string <email> (NominalStringEmail)

Responses

Request samples

Content type
application/json
{
  • "email": "string"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "companyName": "string",
  • "billingEmail": "string",
  • "lastLoginDate": "2020-06-25T21:05:12.830Z",
  • "teams": [
    ]
}

nRF Cloud Proxy

Operations for routing requests to nRF Cloud Proxy on behalf of a team owner

getAccountInfo

See equivalant API documentation for more information (https://api.nrfcloud.com/v1#tag/Account/operation/FetchAccountInfo)

Authorizations:
CognitoJwtAuth
path Parameters
required
NominalStringUuid (string) <uuid> (Uuid) = 36 characters ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3...
Examples: a5592ec1-18ae-4d9d-bc44-1d9bd927bbe9

Universally unique identifier

Responses

getInvoices

See equivalant API documentation for more information (https://api.nrfcloud.com/v1#tag/Account/operation/ListInvoices)

Authorizations:
CognitoJwtAuth
path Parameters
required
NominalStringUuid (string) <uuid> (Uuid) = 36 characters ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3...
Examples: a5592ec1-18ae-4d9d-bc44-1d9bd927bbe9

Universally unique identifier

Responses

getServiceToken

See equivalant API documentation for more information (https://api.nrfcloud.com/v1#tag/Account/operation/GetServiceToken)

Authorizations:
CognitoJwtAuth
path Parameters
required
NominalStringUuid (string) <uuid> (Uuid) = 36 characters ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3...
Examples: a5592ec1-18ae-4d9d-bc44-1d9bd927bbe9

Universally unique identifier

Responses

getApiUsageSummary

See equivalant API documentation for more information (https://api.nrfcloud.com/v1#tag/Account/operation/FetchApiUsageSummary)

Authorizations:
CognitoJwtAuth
path Parameters
required
NominalStringUuid (string) <uuid> (Uuid) = 36 characters ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3...
Examples: a5592ec1-18ae-4d9d-bc44-1d9bd927bbe9

Universally unique identifier

Responses

getBinaryLogsUrl

See equivalant API documentation for more information (https://api.nrfcloud.com/v1#tag/Binary-Logs/operation/FetchBinaryLogsUrl)

Authorizations:
CognitoJwtAuth
path Parameters
required
NominalStringUuid (string) <uuid> (Uuid) = 36 characters ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3...
Examples: a5592ec1-18ae-4d9d-bc44-1d9bd927bbe9

Universally unique identifier

Responses

getDeviceAlerts

See equivalant API documentation for more information (https://api.nrfcloud.com/v1#tag/Alerts/operation/ListDeviceAlerts)

Authorizations:
CognitoJwtAuth
path Parameters
required
NominalStringUuid (string) <uuid> (Uuid) = 36 characters ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3...
Examples: a5592ec1-18ae-4d9d-bc44-1d9bd927bbe9

Universally unique identifier

Responses

getDeviceMessages

See equivalant API documentation for more information (https://api.nrfcloud.com/v1#tag/Messages/operation/ListMessages)

Authorizations:
CognitoJwtAuth
path Parameters
required
NominalStringUuid (string) <uuid> (Uuid) = 36 characters ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3...
Examples: a5592ec1-18ae-4d9d-bc44-1d9bd927bbe9

Universally unique identifier

Responses

getBulkOpsRequests

See equivalant API documentation for more information (https://api.nrfcloud.com/v1#tag/Bulk-Ops-Requests/operation/ListBulkOpsRequests)

Authorizations:
CognitoJwtAuth
path Parameters
required
NominalStringUuid (string) <uuid> (Uuid) = 36 characters ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3...
Examples: a5592ec1-18ae-4d9d-bc44-1d9bd927bbe9

Universally unique identifier

Responses

getLocationHistory

See equivalant API documentation for more information (https://api.nrfcloud.com/v1#tag/Location-History/operation/GetLocationHistory)

Authorizations:
CognitoJwtAuth
path Parameters
required
NominalStringUuid (string) <uuid> (Uuid) = 36 characters ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3...
Examples: a5592ec1-18ae-4d9d-bc44-1d9bd927bbe9

Universally unique identifier

Responses

getDevices

See equivalant API documentation for more information (https://api.nrfcloud.com/v1#tag/All-Devices/operation/ListDevices)

Authorizations:
CognitoJwtAuth
path Parameters
required
NominalStringUuid (string) <uuid> (Uuid) = 36 characters ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3...
Examples: a5592ec1-18ae-4d9d-bc44-1d9bd927bbe9

Universally unique identifier

Responses

getDevice

See equivalant API documentation for more information (https://api.nrfcloud.com/v1#tag/All-Devices/operation/FetchDevice)

Authorizations:
CognitoJwtAuth
path Parameters
required
NominalStringUuid (string) <uuid> (Uuid) = 36 characters ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3...
Examples: a5592ec1-18ae-4d9d-bc44-1d9bd927bbe9

Universally unique identifier

required
NominalStringDeviceId (string) (DeviceId) [ 1 .. 128 ] characters ^[a-zA-Z0-9:_-]{1,128}$
Examples: nrf-1234567890123456789000

This is the canonical device id used in the device certificate, and as the MQTT client id.

Responses

onboardDevice

See equivalant API documentation for more information (https://api.nrfcloud.com/v1#tag/IP-Devices/operation/OnboardDevices)

Authorizations:
CognitoJwtAuth
path Parameters
required
NominalStringUuid (string) <uuid> (Uuid) = 36 characters ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3...
Examples: a5592ec1-18ae-4d9d-bc44-1d9bd927bbe9

Universally unique identifier

required
NominalStringDeviceId (string) (DeviceId) [ 1 .. 128 ] characters ^[a-zA-Z0-9:_-]{1,128}$
Examples: nrf-1234567890123456789000

This is the canonical device id used in the device certificate, and as the MQTT client id.

Responses

deleteDevice

See equivalant API documentation for more information (https://api.nrfcloud.com/v1#tag/All-Devices/operation/DeleteDevice)

Authorizations:
CognitoJwtAuth
path Parameters
required
NominalStringUuid (string) <uuid> (Uuid) = 36 characters ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3...
Examples: a5592ec1-18ae-4d9d-bc44-1d9bd927bbe9

Universally unique identifier

required
NominalStringDeviceId (string) (DeviceId) [ 1 .. 128 ] characters ^[a-zA-Z0-9:_-]{1,128}$
Examples: nrf-1234567890123456789000

This is the canonical device id used in the device certificate, and as the MQTT client id.

Responses

updateDeviceTags

See equivalant API documentation for more information (https://api.nrfcloud.com/v1#tag/All-Devices/operation/UpdateDeviceTags)

Authorizations:
CognitoJwtAuth
path Parameters
required
NominalStringUuid (string) <uuid> (Uuid) = 36 characters ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3...
Examples: a5592ec1-18ae-4d9d-bc44-1d9bd927bbe9

Universally unique identifier

required
NominalStringDeviceId (string) (DeviceId) [ 1 .. 128 ] characters ^[a-zA-Z0-9:_-]{1,128}$
Examples: nrf-1234567890123456789000

This is the canonical device id used in the device certificate, and as the MQTT client id.

Responses

getAllDeviceTags

See equivalant API documentation for more information (https://api.nrfcloud.com/v1#tag/All-Devices/operation/ListDeviceTags)

Authorizations:
CognitoJwtAuth
path Parameters
required
NominalStringUuid (string) <uuid> (Uuid) = 36 characters ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3...
Examples: a5592ec1-18ae-4d9d-bc44-1d9bd927bbe9

Universally unique identifier

Responses

getMqttTeamDeviceCertificate

See equivalant API documentation for more information (https://api.nrfcloud.com/v1#tag/Mqtt-Team-Devices/operation/GetMqttTeamDeviceCertificate)

Authorizations:
CognitoJwtAuth
path Parameters
required
NominalStringUuid (string) <uuid> (Uuid) = 36 characters ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3...
Examples: a5592ec1-18ae-4d9d-bc44-1d9bd927bbe9

Universally unique identifier

required
NominalStringDeviceId (string) (DeviceId) [ 1 .. 128 ] characters ^[a-zA-Z0-9:_-]{1,128}$
Examples: nrf-1234567890123456789000

This is the canonical device id used in the device certificate, and as the MQTT client id.

Responses