...
Get Scan Results | |||||||||
---|---|---|---|---|---|---|---|---|---|
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:
| ||||||||
Required Parameters |
| ||||||||
Optional Parameters | None | ||||||||
Example | /api/v1/api.php?target=ipam&action=getScanResults&block=213.37.29.0/24 |
Get Options | |||||||||
---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=ipam&action=getOptions | ||||||||
Description | Returns a list of options available for the block | ||||||||
Returns | Examples:
| ||||||||
Required Parameters |
| ||||||||
Optional Parameters | None | ||||||||
Example URL | /api/v1/api.php?target=ipam&action=getOptions&id=125 |
Get Resource Hierarchy | |||||||||
---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=ipam&action=getResourceHierarchy | ||||||||
Description | Returns the resource hierarchy for the block | ||||||||
Returns | Examples:
| ||||||||
Required Parameters |
| ||||||||
Optional Parameters | None | ||||||||
Example URL | /api/v1/api.php?target=ipam&action=getResourceHierarchy&id=125 |
Get VLAN | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=ipam&action=getVlan | ||||||||||||||||
Description | Returns the VLAN for the block | ||||||||||||||||
Returns | Examples:
| ||||||||||||||||
Required Parameters |
| ||||||||||||||||
Optional Parameters | None | ||||||||||||||||
Example URL | /api/v1/api.php?target=ipam&action=getVlan&id=125 |
Process Holding Tank | |||||||||
---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=ipam&action=processHoldingTank | ||||||||
Description | Processes the Holding Tank, returning held blocks to available status | ||||||||
Returns | Examples:
| ||||||||
Required Parameters | None | ||||||||
Optional Parameters |
| ||||||||
Example URL | /api/v1/api.php?target=ipam&action=processHoldingTank&preview=true |
IPAM API Calls Subject to Change:
...