IPAM - IP Address Comments and History - RESTful API – Entuity

List an IP address and its history, modify the comments on an IP address, and delete an IP address. To use a network's UP range, page and the address to get the address:

http(s)://{server hostname}/api/ipam/network/{id}/address/{page}

To get the address directly:

http(s)://{server hostname}/api/ipam/address/{address}
http(s)://{server hostname}/api/ipam/address/{address}?zoneId=#

IP address management (IPAM)

Methods summary

GET Method - returns an IP address and its history.
PUT Method - modifies the comments for an IP address.
DELETE Method - deletes an IP address.

GET Method detail

Returns an IP address and its history.

Response:

Name	Description
zoneID	zone of the DHCP server, if applicable. This column is hidden if there are no zones.
comments	any comments added to the IP address.
hostname	hostname, if applicable.
active	if the device has responded to a scan recently, either 'true' or 'false'.
lastScan	last time the device was scanned.
lastActive	last time the device was successfully scanned.
timestamp	timestamp of this IP history entry.
scan	scan type, one of the following: 0 - Ping 1 - Reverse DNS 2 - ARP 3 - DHCP
result	result of the scan, one of the following: 0 - OK 1 - Offline 2 - Expiring
ipv4	if the IP address is IPv4, either 'true' or 'false'.
ipAddress	IP address.

PUT Method detail

Modifies comments for an IP address.

Request:

Same as 'GET Method - Response' above.

Response:

Updated IP address result.

Example:

INPUT
curl -u admin:admin https://localhost/api/ipam/network/1/address/0/10.44.2.195?media=json -X PUT -H "content-type:application/json" -d \
'{
   "comments" : "test",
}'

OUTPUT
{
  "zoneID" : 0,
  "comments" : "test",
  "hostname" : "ent-17-0-lin.entuity.local",
  "active" : true,
  "lastScan" : 1680520208,
  "lastActive" : 1680520208,
  "history" : [ {
    "timestamp" : 1680520208,
    "scan" : 0,
    "result" : 0
  }, {
    "timestamp" : 1680520208,
    "scan" : 1,
    "result" : 0
  } ],
  "ipv4" : true,
  "ipAddress" : "10.44.2.195"
}

DELETE Method detail

Deletes the specified IP address.

Response:

'OK' if successful.

INPUT
curl -u admin:admin https://localhost/api/ipam/network/1/address/0/10.44.2.195?media=json -X DELETE

OUTPUT
{
  "message" : "OK"
}

Articles in this section

Methods summary

GET Method detail

PUT Method detail

DELETE Method detail

Related articles