Page History

...

Get Utilization

URL

/api/v1/api.php?target=ipam&action=utilization

Description

Gets the utilization percentages for a specific ip block or ip block and mask combination.

Example URLs

https://ops.6connect.com/qa-4.1/api/v1/api.php?target=ipam&action=utilization&id=23131

Returns

Examples:

SUCCESSFUL

"success": 1,

"totalBlocks": 1,

"totalHosts": "256",

"hostsAssigned": 0,

"hostsAllocated": "256",

"hostsAvailable": "256",

"hostsInHolding": 0,

"availablePercentage": "100.00",

"assignedPercentage": "0.00",

"allocatedPercentage": "100.00",

"inHoldingPercentage": "0.00",

"resources": [{

"id": 351,

"name": "Customer 1",

"type": "entry",

"hosts": "256",

"blocks": "1",

"percentage": "100.00"

}],

"blocksAssigned":0,

"blocksAllocated": 1,

"blocksAvailable": "1",

"blocksInHolding": null,

"blocksAssignedPercentage": "0.00",

"blocksAllocatedPercentage": "100.00",

"blocksAvailablePercentage": "100.00",

"blocksInHoldingPercentage": "0.00"

ERROR

{'success':0, 'message':'error message'}

Required Parameters

Name	Type	Example	Description
block*	STRING	213.37.29.0/24	CIDR block description
id*	INTEGER	125	ID of the IP block
*Either block or id can be used, but only one must be provided

Optional Parameters

Name	Type	Example	Description
mask	int	24	The specific mask size to retrieve utilization for. If using this parameter, the id parameter should be the id of the aggregate.

Get Host Utilization

URL

/api/v1/api.php?target=ipam&action=getHostUtilization