HomeGuidesAPI Reference
GuidesAPI ReferenceGitHubAirheads Developer CommunityLog In
API Reference

Ping result.

Get ping statistics for destination.

This URI is not supported by Notifications or NAE.

Query Params
string
required

ping IP address

boolean
required

true if ping_target is an IPv4 address

boolean

true if ping_target is a broadcast address

string

ping dataFill pattern in hexadecimal, and maximum pattern data less than 32

integer

set the packet size to n bytes, default value 100.

string

set the source address, it can be an IP address or an interface name.

integer

ping timeout, default value 2

integer

set ping interval, time between packets in seconds

integer

send n ping signals, default value 5

integer

ping type of service

boolean

include time stamp

boolean

include time stamp address

boolean

route recorded

boolean

VRF name/Management mutually exclusive. default value false

string

VRF name/Management mutually exclusive. default value 'swns'

Headers
string

Entity-tag value for representation comparison (see RFC 7232 - Conditional Requests - section 3.2)

Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Language
Response
Click Try It! to start a request and see the response here!