Specialized APIsSensor InsightsAPI Reference
Onboard a sensor
POST /dm/v1/devices/sensors/onboard
Use this endpoint to onboard sensors and create a record of the sensor's details.
Header Parameters
The request header must set the content-type to JSON, contain a current ThingSpace authorization token and a current VZ-M2M session token. For more details on how to get these tokens, visit Getting Started.
| Parameter Name | Data Type | Description |
|---|---|---|
| Authorization (required) | string | HTTP Authorization request header containing a valid Bearer token: Authorization: Bearer {token} |
| VZ-M2M-Token (required) | string | A valid session token returned by a Connectivity Management POST /session/login request. |
| Content-Type (required) | string | Must be application/json. |
HTTP Request
POST https://thingspace.verizon.com/api/dm/v1/devices/sensors/onboard
Request Parameters
Note: All parameters are required unless marked (optional)
| Parameter | Data Type | Description |
|---|---|---|
| accountname | string | The numeric name of the account and must include leading zeros. |
| payload | object | An object containing the addsensor object. |
| addsensor | object | An obect containing the details of the sensor being added. |
| deveui | string | The unique EUI64 address of the device. |
| appeui | string | The global application ID in IEEE EUI64 address space that uniquely identifies the entity able to process the JoinReq frame. |
| appkey | string | An encryption key used for messages during every over the air activation. |
| class | string | Class of the sensor device. Valid values are Class A (A), Class B (B) and Class C (C). Note: All LoRaWAN devices must implement Class A. |
| kind | string | The kind of sensor device. |
| customdata | object | This is free form JSON, any thing in the form of JSON can be stored. |
| description* | string | A description of the record. |
| name | string | The user defined name of the record. |
Request Body
Example Request:
{
"accountname": "0000123456-00001",
"payload": {
"addsensor": {
"deveui": "The EUI64 address",
"appeui": "application ID",
"appkey": "encryption key",
"class": "A",
"kind": "ts.device.sensor.lorawan.radiobridge.RBS301-DWS-US",
"description": "description of the sensor",
"name": "name of the sensor"
"customdata": {
"additionalProp1": [
100
],
"additionalProp2": [
100
],
"additionalProp3": [
100
]
}
}
}Success Response
Status 200 There is no response body. Only an HTML 200 will be returned.
Failure Responses
Example Response:
{
"error": "Error name or code",
"error_description": "A longer error description.",
"cause": "A cause for the error"
}