GET: Formatted Packet Details (saved trace)
The NetMaster GET: Formatted Packet Details (saved trace) API endpoint retrieves detailed information about a specific packet in a saved SmartTrace trace.
GET: Formatted Packet Details retrieves formatted details about a specific packet in a SmartTrace trace, within a specified region. The following reference article includes:
- Uniform Resource Identifier (URI) Parameters
- Response Format and Sample
- Interface Properties
- Status Codes
URI Parameters
The URI for GET: Formatted Packet Details is:
GET /api/v1/tcpip/{region}/smart/saved/{id}/packets/{packetNumber}/details/formatted
Parameter | Description |
region | The NetMaster region |
id | The ID of the trace. Enter the trace ID for a saved trace in the format tracename-n , where "n" is the number of a saved trace for a specific trace definition. You can use the GET: Saved Trace Summary to find the trace ID. |
packetNumber | The number of the packet for which you are requesting detailed information. |
Response Format and Sample
Returned data for formatted packet detail in a SmartTrace trace appears in a standardized format:
- Thenamevariable represents a section of formatted packet detail.
- Each packet detail is represented by three variables:key,value, andtype.
- Keyis the name of the property.
- Valueis the value of the corresponding key variable.
- Typeis the type of the corresponding key variable.
The code sample below shows an excerpt from the
PKT
and IP
sections of packet number six in a saved TCP trace. The PKT section includes values for the packet number, the direction, the link name, and the first hop. The excerpted piece of the IP section shows the source address, which in addition to the key, value and type variables, includes a version variable. [ { "name": "PKT", "values": [ { "key": "Packet #", "value": 6, "type": "number" }, { "key": "Direction", "value": "Send", "type": "string" }, { "key": "Timestamp", "value": 1578620055000399254, "type": "datetime" }, { "key": "Link Name", "value": "OSD20I", "type": "string" }, { "key": "First Hop", "type": "ip", "value": "10.xxx.xx.1", "version": 4 } ] }, { "name": "IP", "values": [ { "key": "Source Addr", "type": "ip", "value": "10.xxx.xx.103", "version": 4 },
Interface Properties
The properties contained in the output for formatted packet details vary greatly according to the type of trace. SmartTraces can be initiated for TCP, multi-TCP, UDP, and ICMP protocols. For each protocol, the API output corresponds roughly to the corresponding view in the
Expanded Packet Display
panel in the 3270 interface.Status Codes
The following status codes can appear in the response to GET: All Packet Summary:
- 200 OK- Packet detail information was returned.
- 400 Bad Request- Packet detail information could not be returned due to an invalid format for the URI query parameters:
- 401 Unauthorized- The user is not authenticated to the application. They must provide either a valid login token or valid credentials before continuing.
- 403 Forbidden- Packet detail information could not be returned because the user does not have the appropriate authority to view packets.
- 404 Not Found- Packet detail information could not be returned due to one of the following reasons:
- A saved trace with a matching ID could not be found.
- A packet with the specified number does not exist in the trace.
- 500Server error