Versions Compared

Key

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

...

getScanResults

URL/api/v1/api.php?target=ipam&action=getScanResults
Description

Initiates an asynchronous ping (ICMP) scan of the target block specified. Results of the scan can be checked with get

Returns

Examples:

SUCCESSFUL
{"success":1,"data":{"block":"8.8.8.0\/27","date":"07\/14\/2014 11:07:10",
"data":[{"address":"8.8.8.8","host":"google-public-dns-a.google.com","status":"Up"}],"status":"completed","hostsScanned":4,"activeHosts":4}}
ERROR{'success':0, 'message':'error message'}
Required Parameters
NameTypeExampleDescriptionid
int125ID of the IP block.
Optional Parameters
NameTypeExampleDescription
block*STRING213.37.29.0/24CIDR block. Only the block id OR the block CIDR can be specified. Not both.
Optional Parameters

None

Example/api/v1/api.php?target=ipam&action=getScanResults&block=8.8.8.0/27