Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

REST API Method: POST /rest/checkport?action=checkconnectivity

This resource checks the server/service reachability from the SBC node.

URL:

https://192.168.0.111/rest/checkport?action=checkconnectivity

HTTP Method

POST

Requires Authentication:

true

Noprint
Panel
bgColortransparent
titleBGColor#DDD
title[checkport - REST API Methods|Resource - checkport]

Page Tree
root@parent



Parameters

Parameter Name Required Service Affecting Data Type Default Value Possible Values Description
CheckPortTypeYesYesSpecifies which protocol to test.
TargetNoNostringnone255 - Max LengthFQDN of the target (Only used for DNS UDP testing)
HostServerNoNostringnone255 - Max LengthFQDN/IP of the server to query.
HostIpAddrNoNostringnone15 - Max LengthIP address of the server to query
HostPortYesYesintPossible values:
  • 0 - Minimum
  • 65535 - Maximum
Specifies the UDP/TCP port number to query.