GET: Raw Packet Details (saved trace)
The NetMaster GET: Raw Packet Details (saved trace) API endpoint retrieves packet details, broken out by layer, in hex dump format.
GET: Raw Packet Details (saved trace) retrieves packet details, broken out by layer, in hex dump format for a specific packet in a saved SmartTrace trace, within a specified region. The following reference article includes:
- Uniform Resource Identifier (URI) Parameters
- Response Format
- Interface Properties
- Status Codes
- Sample Request and Response
URI Parameters
The URI for GET: Raw Packet Details (saved trace) is:
GET /api/v1/tcpip/{region}/smart/saved/{id}/packets/{packetNumber}/details/raw
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. |
packetNumber | The number of the packet for which you are requesting detailed information. |
Response Format
Returned data for raw packet details is prefaced by the
Sections
heading and the length
, in bytes. Each section has a Name
, its Length
, and a Hex
representation of its data. Refer to the
Sample Request and Response
section for an example of the returned raw packet detail. Interface Properties
The following table describes the properties of the summarized SmartTrace packets:
Property Name | Data Type | Sortable | Description |
length | integer | no | The total number of bytes in the packet |
sections | |||
name | string | no | The name of the packet section |
length | integer | no | The number of bytes in the section |
hex | string | no | Packet data in hexadecimal format
Note that the data does not have any spacing in the returned string. |
Status Codes
The following status codes can appear in the response to GET: Raw Packet Details (saved trace):
- 200 OK- Raw packet detail information was returned.
- 400 Bad Request- Raw 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- Raw packet detail information could not be returned because the user does not have the appropriate authority to view packets.
- 404 Not Found- Raw 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
Sample Request and Response
Sample Packet Summary Request:
The following request queries saved trace
ATRACE-1
on NetMaster region U22NDE55
, for the raw data in packet number 8
:
GET /api/v1/tcpip/U22NDE/smart/saved/ATRACE-1/packets/8/details/raw
Sample Packet Summary Response:
{ "apiVersion": "v1", "data": { "length": 833, "sections": [ { "length": 20, "name": "IP Header", "hex": "454800003A5B0000400600000AAF54670A250769", }, { "length": 20, "name": "TCP Header", "hex": "97E1C0249095153D8D89F61D50180FEF00000000", }, { "length": 5, "name": "Record 1 Header", "hex": "1603030314", }, { "length": 81, "name": "Message #1 Content", "hex": "0200004D03035E17D4971F7CD15286C928006FB9A6D3D76DE164024F8F0BE8F198CC29EDF9F720000000A400000000000000000000FFFF0A250769C02400005E17D497000000F50035000005FF01000100", }, { "length": 703, "name": "Message #2 Content", "hex": "0B0002BB0002B80002B5308202B13082...", }, { "length": 4, "name": "Message #3 Content", "hex": "0E000000", } ] }, "swaggerVersion": "2", "time": 1564754568891