---
title: "Runs ICMP ping command on an Appliance."
slug: "runs-icmp-ping-command-on-an-appliance-1"
updated: 2026-03-02T22:30:52Z
published: 2026-03-02T22:35:48Z
canonical: "support.appgate.com/runs-icmp-ping-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 ICMP ping command on an Appliance.

Post/appliances/{id}/command/ping

Runs ICMP ping command on an Appliance. This API call must be made with **Accept** header of **application/vnd.appgate.peer-v23+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

Ping parameters

<select class='api-response-data' aria-label='Media type'><option value='466e9cce-c060-4749-bac5-ffdd4e1bc92e'>application/json</option>
</select>object  destinationstring    Required

The destination to ping.

Example8.8.8.8
interfacestring    

The network interface to use for pinging.

Exampleeth0
processTimeoutinteger    

The number of replies to wait for.

Default5

Responses200

Command ran successfully.

<select class='api-response-data' aria-label='Media type'><option value='2d460e72-9976-4422-be98-d723fb1c12c4'>text/plain</option>
</select>string    

The ping result.

400

JSON error. Check the JSON format.

<select class='api-response-data' aria-label='Media type'><option value='a83b9754-9fa0-4592-97b6-a6b8bb13c2ab'>application/json</option>
</select>object  

Generic HTTP error.

idstring    

Machine readable error code.

messagestring    

Human readable error details.

401

Token error. Login again.

<select class='api-response-data' aria-label='Media type'><option value='6a257cd0-011a-4f99-8958-d01b538247a6'>application/json</option>
</select>object  

Generic HTTP error.

idstring    

Machine readable error code.

messagestring    

Human readable error details.

403

Insufficient permissions to access this resource.

<select class='api-response-data' aria-label='Media type'><option value='b8af622f-0b96-4f2d-8aa7-172eb142b2d5'>application/json</option>
</select>object  

Generic HTTP error.

idstring    

Machine readable error code.

messagestring    

Human readable error details.

406

Invalid 'Accept' header.

<select class='api-response-data' aria-label='Media type'><option value='31eee11b-434b-43fd-a9a6-f9bb0211fa19'>application/json</option>
</select>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.

<select class='api-response-data' aria-label='Media type'><option value='4f515f89-7517-43a4-8716-c28525aceb6e'>application/json</option>
</select>object  

Generic HTTP error.

idstring    

Machine readable error code.

messagestring    

Human readable error details.

422

Request validation error. Check "errors" array for details.

<select class='api-response-data' aria-label='Media type'><option value='83d3126a-9290-4acb-8336-00ffecc9eace'>application/json</option>
</select>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.

<select class='api-response-data' aria-label='Media type'><option value='47f1973b-5972-4ae6-afa5-261949900303'>application/json</option>
</select>object  

Generic HTTP error.

idstring    

Machine readable error code.

messagestring    

Human readable error details.