This article provides information for managing Zscaler Digital Experience (ZDX) troubleshooting by using APIs. All APIs are rate limited. To learn more, see Understanding Rate Limiting.

Start a Deep Trace for a Device

To start a deep tracing session on a device, send a POST request to the endpoint /devices/{deviceid}/deeptraces. Provide the following in the request:

• deviceid: The device's ID.

For example, in Python:

payload = { 
   "deviceid":30989301
}

• View example response.

  {
    "trace_id": 0,
    "status": "not_started",
    "expected_time": 0
  }

  Close

A successful response returns code 200. To learn more, see Understanding Error Codes.

Stop a Deep Trace for a Device

To stop a deep tracing session on a device, send a DELETE request to the endpoint /devices/{deviceid}/deeptraces. Provide the following in the request:

This deletes the deep tracing session and the associated data.

• deviceid: The device's ID.
• trace_id: The deep tracing ID that requires a stop.

For example, in Python:

payload = { 
   "deviceid":30989301,
   "trace_id":0
}

• View example response.

  {
    "trace_id": 0
  }

  Close

A successful response returns code 200. To learn more, see Understanding Error Codes.

Get a List of All Deep Traces for a Device

To get a list of all deep traces on a specific device, send a GET request to the endpoint /devices/{deviceid}/deeptraces. Provide the following in the request:

• deviceid: The device's ID.

For example, in Python:

payload = {  
   "deviceid":30989301
}

• View example response.

  {
    "trace_id": 0,
    "trace_details": {
      "session_name": "string",
      "user_id": 0,
      "username": "string",
      "device_id": 30989301,
      "device_name": "string",
      "web_probe_id": 0,
      "web_probe_name": "string",
      "cloudpath_probe_id": 0,
      "cloud_path_name": "string",
      "session_length": 0,
      "probe_device": true
    },
    "status": "not_started",
    "created_at": 0,
    "started_at": 0,
    "ended_at": 0
  }

  Close

A successful response returns code 200. To learn more, see Understanding Error Codes.

Get the Deep Tracing Session Configuration

To get the configuration of a Deep Tracing session, send a GET request to the endpoint /devices/{deviceid}/deeptraces/{trace_id}. Provide the following in the request:

• deviceid: The device's ID.
• trace_id: The device's deep tracing ID.

For example, in Python:

payload = { 
   "deviceid":30989301,
   "trace_id":0
}

• View example response.

  {
    "trace_id": 0,
    "trace_details": {
      "session_name": "string",
      "user_id": 0,
      "username": "string",
      "device_id": 30989301,
      "device_name": "string",
      "web_probe_id": 0,
      "web_probe_name": "string",
      "cloudpath_probe_id": 0,
      "cloud_path_name": "string",
      "session_length": 0,
      "probe_device": true
    },
    "status": "not_started",
    "created_at": 0,
    "started_at": 0,
    "ended_at": 0
  }

  Close

A successful response returns code 200. To learn more, see Understanding Error Codes.