Specialized APIsSensor InsightsAPI Reference
Offboard a sensor
POST /dm/v1/devices/sensors/offboard
Use this endpoint to offboard, or decommission, a sensor.
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/offboard
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. |
| configuration | object | An object containing the removesensor object. |
| removesensor | object | Details about the sensor being offboarded. |
| deveui | string | The unique EUI64 address of the device. |
Request Body
Example Request:
{
"accountname": "0000123456-00001",
"configuration": {
"removesensor": {
"deveui": "The EUI64 address of the device"
}
}
}Success Response
Status 204 There is no response body. The only indication of success will be an HTML "204".
Success Parameters
None
Failure Responses
Example Response:
{
"error": "Error name or code",
"error_description": "A longer error description.",
"cause": "A cause for the error"
}