Enable Logging for a Specific Device

Enable Logging for a Specific Device

PUT /logging/{acc}/devices/{deviceId}

Enables logging for a specific device.

Uses and Requirements

If a pilot campaign is not successful, you can enable and fetch logs for the device. Logging turns off automatically after seven days to avoid unnecessary device resource usage. When the device checks in after that setting is enabled, the device starts collecting logs. The device periodically uploads those logs to ThingSpace and purges them from the device. After at least 24 hours, you can call the Verbose Logging API again to fetch the logs for analysis or can view the check-in history as reported by the FOTA server. (Note that Check-in history is independent of enabled or disabled logging.) After 30 days, the logs are purged from ThingSpace.

Request Components

HTTP Request

PUT https://thingspace.verizon.com/api/fota/v2/logging/{acc}/devices/{deviceId}

Resource Path Parameters

You must include the account name and the deviceId in the path.

Parameter Name Data Type Description
acc
required
string The name of the account for which you want enable device logging. An account name is usually numeric, and must include any leading zeros.
deviceId
required
string The device IMEI identifier.

Header Parameters

The request header must contain a current ThingSpace authorization token and a current VZ-M2M-session token.

Parameter Name Data Type Description
Authorization
required
string HTTP Authorization request header containing a valid Bearer token.
VZ-M2M-Token
required
string A valid session token returned by a Connectivity Management POST /session/login request.

Request Body

None.

Example Request

Enable logging for a device:

curl -X PUT https://thingspace.verizon.com/api/fota/v2/logging/$ACC/devices/$DEVICEID  -H 'Authorization: Bearer $AUTH_TOKEN' -H 'VZ-M2M-Token: $M2M_TOKEN'

Success Responses

Status 200

A success response contains the account name and an array of deviceId objects.

Parameter Name Data Type Description
deviceId string The IMEI of the device.
expiryDate string($date) The date when device logging expires.

Example Success Response

    {
      "deviceId": "990013907835573",
      "expiryDate": "2020-10-19"
    }

Failure Responses

Status 400

All error messages are returned in this format:

{
  "errorCode": "error code string",
  "errorMessage": "error message string"
}

Error codes and messages are listed on the Error Messages page, along with explanations and suggestions for corrective actions.