Enabled Logging for a List of Devices

Enable Logging for a List of Devices

PUT /logging/{acc}/devices

Enables logging for a list of specified devices.

Uses and Requirements

If pilot campaigns are not successful, you can enable and fetch logs for up to 20 devices. 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

Resource Path Parameters

You must include the account name 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.

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

Parameter Name Data Type Description
deviceLogging array of deviceIds objects The list of device ids for which you want to enable logging.
deviceIds string List of device IMEI identifiers.

Example Request

Enable logging for devices:

curl https://thingspace.verizon.com/api/fota/v2/logging/$ACC/devices  -H 'Authorization: Bearer $AUTH_TOKEN' -H 'VZ-M2M-Token: $M2M_TOKEN' -d
{
  deviceIds: [
  "990013907835573",
  "991124018926684",
  "992234129057795",
  "998891785613351",
  "990013907835573"
  ]
}

Success Responses

Status 200

A success response contains the account name and an array of device 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"
    },
    {
      "deviceId": "991124018926684",
      "expiryDate": "2020-10-19"
    },
    {
      "deviceId": "992234129057795",
      "expiryDate": "2020-10-23"
    },
    {
      "deviceId": "998891785613351",
      "expiryDate": "2020-10-23"
    },
    {
      "deviceId": "990013907835573",
      "expiryDate": "2020-10-23"
    }
]

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.