Versions Compared

Old Version 31

changes.mady.by.user Unknown User (nalin)

Saved on

compared with

New Version 32

changes.mady.by.user Unknown User (nalin)

Saved on

Key

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

...

Get Host Utilization

URL/api/v1/api.php?target=ipam&action=getHostUtilization
DescriptionGets the host utilization statistics with support for filters.
Example URLshttps://ops.6connect.com/qa-4.1/api/v1/api.php?target=ipam&action=getHostUtilizaiton&tags=["Customer","PTP"]&region=SMF

Get Host Utilization

URL/api/v1/api.php?target=ipam&action=getHostUtilization
DescriptionGets the host utilization statistics with support for filters.
Example URLs/api/v1/api.php?target=ipam&action=getHostUtilizaiton&tags=["Customer","PTP"]&region=SMF
Returns

Examples:

SUCCESSFUL
{

"success": 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"

}]

}

ERROR{'success':0, 'message':'error message'}
Required Parameters
NameTypeExampleDescription
typeSTRING"ipv4" or "ipv6"IP type
Optional Parameters
NameTypeExampleMultiple Values
codeSTRING"code-1"Yes
regionSTRING"SFO"Yes
tagsSTRING"Customer"Yes
vlanINT1000Yes

NOTE: to filter using multiple values, pass the values as a JSON-encoded string representation of an array.

For example, to get utilization data for multiple tags, you could use the following URL:

/api/v1/api.php?target=ipam&action=getHostUtilization&type=ipv4&tags=["Customer","PTP"]

...