GET: Diagnostic Status

The GET: Diagnostic Status API endpoint gets SmartTrace status information from
NetMaster
.
This reference article includes:
  • URI (Uniform Resource Identifier) Parameters
  • Status Codes
  • Interface Properties
  • Sample Request and Response

URI Parameters

The URI for Get Diagnostic Status is:
GET /api/v1/tcpip/{region}/diagnostic/status
The
region
parameter identifies the
NetMaster
region from which you are requesting data.

Interface Properties

The following table describes the properties in the returned SmartTrace status information.
Property Name
Data Type
Description
smartTraceStatus
Boolean
Indicates whether SmartTrace is running (True or False).
smartTraceAuthorization
Enum
FULL
The current user is fully authorized to view SmartTrace data.
NONE
The current user is not authorized to view SmartTrace data.
NO_PACKET_DATA
The current user is authorized to use SmartTrace but is not authorized to view packet payload data.
For more information, see Implementing SmartTrace Security.

Status Codes

The following status codes can appear in the response to GET: Diagnostic Status:
  • 200 OK
    -The diagnostic status was returned.
  • 401 Unauthorized
    - The user is not authenticated to the application. They must provide either a valid login token or valid credentials before continuing.

Sample Request and Response

Request:
The following syntax example shows a request for diagnostic status data for the U11NTA35 region:
GET /api/v1/tcpip/U11NTA35/diagnostic/status
Response:
HTTP/1.1 200 OK Content-Type: application/json Content-Length: 170 { "apiVersion": "v1", "data": { "smartTraceStatus": false, "smartTraceAuthorization": "FULL" }, "swaggerVersion": "2.0", "time": 1564754568891 }