DELETE: Delete a Trace
Use the NetMaster API Service to delete a SmartTrace trace.
The DELETE: Delete a Trace endpoint deletes an ended SmartTrace trace, allowing you to clear un-needed information following SmartTrace diagnostics. The following reference article includes:
- URI (Uniform Resource Identifier) Parameters
- Status Codes
- Sample Request and Response
URI Parameters
The URI for DELETE: Delete a Trace is:
DELETE /api/v1/tcpip/{region}/smart/trace/{id}
Parameter | Description |
region | The NetMaster region |
id | The ID of the trace. The trace ID consists of a hyphenated string of key properties in the following format:
key.definitionName-key.generation-key.sequence-key.stackName-key.tcpCreatorSequence-key.snapshotSequence |
Status Codes
The following status codes can appear in the response to a DELETE: Delete a Trace request:
- 204 No Content- The trace was deleted. No content is returned.
- 400 Bad Request- The trace could not be deleted for one of the following reasons:
- An invalid format for the URI name parameter.
- The trace is currently running. A running trace cannot be deleted.
- 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- The trace could not be deleted because the user does not have the appropriate authority to delete a SmartTrace.
- 404- A trace matching the URI name parameter was not found.
- 500 Server error
Sample Request and Response
Request:
The following syntax is a request to delete the SmartTrace with ID
ATRACE1-1-4-TCPIP-0-0
, on NetMaster
region U11NTA35DELETE /api/v1/tcpip/U11NTA35/smart/trace/ATRACE-1-4-TCPIP-0-0
Response:
The following response indicates that the SmartTrace definition was deleted:
HTTP/1.1 204 NO CONTENT