---
title: "Runs netcat command on an Appliance."
slug: "runs-netcat-command-on-an-appliance-1"
updated: 2026-03-02T22:30:52Z
published: 2026-03-02T22:35:48Z
canonical: "support.appgate.com/runs-netcat-command-on-an-appliance-1"
---
> ## Documentation Index
> Fetch the complete documentation index at: https://support.appgate.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Runs netcat command on an Appliance.
Post/appliances/{id}/command/netcat
Run netcat command on an Appliance. This API call must be made with **Accept** header of **application/vnd.appgate.com.peer-v20+text** as it returns plain text instead of JSON.
SecurityHTTPType bearer
Path parametersidstring (uuid) Required
ID of the object.
Example12699e27-b584-464a-81ee-5b4784b6d425
Body parameters
Netcat parameters
object destinationstring Required
The destination to connect. Can be numerical IP address or a symbolic hostname.
Exampleappgate.com
portinteger Required
The port to run command.
Example443
versioninteger
Select IP version explicitly.
Valid values[
4,
6
]
protocolstring
Select protocol.
Valid values[
"UDP",
"TCP"
]Default"TCP"
processTimeoutinteger
The number of seconds to run/wait before timing out.
Default10
Responses200
Command ran successfully.
string
The netcat result.
400
JSON error. Check the JSON format.
object
Generic HTTP error.
idstring
Machine readable error code.
messagestring
Human readable error details.
401
Token error. Login again.
object
Generic HTTP error.
idstring
Machine readable error code.
messagestring
Human readable error details.
403
Insufficient permissions to access this resource.
object
Generic HTTP error.
idstring
Machine readable error code.
messagestring
Human readable error details.
406
Invalid 'Accept' header.
object
Generic HTTP error.
idstring
Machine readable error code.
messagestring
Human readable error details.
412
Appliance is not in the right state for this operation.
object
Generic HTTP error.
idstring
Machine readable error code.
messagestring
Human readable error details.
422
Request validation error. Check "errors" array for details.
Expand Allobject
Http 422 error for object validation.
idstring
Machine readable error code.
messagestring
Human readable error details.
errors Array of object
List of fields with validation errors.
object fieldstring
Name of the field that failed validation.
Examplename
messagestring
Failure reason.
Examplemay not be null
500
Unexpected server side error.
object
Generic HTTP error.
idstring
Machine readable error code.
messagestring
Human readable error details.