...
Get Tags List | |||||
---|---|---|---|---|---|
URL | /api/v1/api.php?target=ipam&action=getTagList | ||||
Description | Returns a list of all valid IP Tags in the database. | ||||
Returns | Examples:
|
Get RIRs Add Tag To List | |||||||||
---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=ipam&action= getRIRListaddTagToList | ||||||||
Description | Returns Adds a list of all valid RIRs in the database.tag to the IPAM tag list | ||||||||
Returns | Examples:
| ||||||||
Required Parameters |
| ||||||||
Optional Parameters | None | ||||||||
Example URL | /api/v1/api.php?target=ipam&action=addTagToList&newTag=Loopback C |
Get RIRsGet RegionsList | |||||
---|---|---|---|---|---|
URL | /api/v1/api.php?target=ipam&action=getRegionListgetRIRList | ||||
Description | Returns a list of all valid Regions RIRs in the database. | ||||
Returns | Examples:
|
Get Regions List | ||||||||
---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=ipam&action=getRegionList | |||||||
Description | Returns a list of all valid Regions in the database. | |||||||
Returns | Examples:
|
Add Region To List | |||||||||
---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=ipam&action=addRegionToList | ||||||||
Description | Adds a region to the IPAM region list | ||||||||
Returns | Examples:
| ||||||||
Required Parameters |
| ||||||||
Optional Parameters | None | ||||||||
Example URL | /api/v1/api.php?target=ipam&action=addRegionToList&newRegion=SFO |
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. | ||||||||||||||||
Returns | Examples:
| ||||||||||||||||
Required Parameters |
| ||||||||||||||||
Optional Parameters |
| ||||||||||||||||
Example URL | /api/v1/api.php?target=ipam&action=utilization&id=125 |
Get HostGetUtilization | |||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=ipam&action=utilizationgetHostUtilization | ||||||||||||||||||||||||||||||||||||||||||||
Description | Gets the utilization percentages for a specific ip block or ip block and mask combinationhost utilization statistics with support for filters. | ||||||||||||||||||||||||||||||||||||||||||||
Returns | Examples:
| ||||||||||||||||||||||||||||||||||||||||||||
Required Parameters |
| ||||||||||||||||||||||||||||||||||||||||||||
Optional Parameters |
| Optional Parameters |
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"] | ||||||||||||||||||||||||||||||||||||||||||
Name | Type | Example | Description | mask | INTEGER | 24 | The specific mask size to retrieve utilization for. If using this parameter, the id parameter should be the id of the aggregate.|||||||||||||||||||||||||||||||||||||||
Example URL | /api/v1/api.php?target=ipam&action=utilization&id=125=getHostUtilization&type=ipv4&tags=["Customer","PTP"]®ion=SMF |
Get Attribute ListGet Host Utilization | |||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=ipam&action= getHostUtilizationgetAttributeLists | ||||||||||||||||||||||||||||||||
DescriptionGets the host utilization statistics with support for filters. | Returns a list of attributes | ||||||||||||||||||||||||||||||||
Returns | Examples:
| ||||||||||||||||||||||||||||||||
Required Parameters |
| ||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||
Required Parameters |
| ||||||||||||||||||||||||||||||||
Optional Parameters | None | Optional Parameters |
Name | Type | Example | Multiple Values | Description |
---|---|---|---|---|
code | STRING | "code-1" | Yes | User-defined block code as defined in Admin-IPAM settings: Generic Code Per Block Name |
region | STRING | "SFO" | Yes | Region to assign from |
rir | STRING | ARIN | No | Acceptable values: ARIN, RIPE, APNIC, AfriNIC, LACNIC, 1918 |
tags | STRING | "Customer" | Yes | Comma separated string of tags |
vlan | INTEGER | 1000 | Yes | VLAN designated to a given block |
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"]Aggregate | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=ipam&action=aggregate | ||||||||||||||||
Description | Aggregates a selected block to the mask specified. If no mask specified, re-aggregates blocks to next parent. IE. calling aggregate on a /25 will aggregate both children back to the parent /24. All child blocks must be Available for aggregation to succeed. | ||||||||||||||||
Returns | Examples:
| ||||||||||||||||
Required Parameters |
| ||||||||||||||||
Optional Parameters |
| ||||||||||||||||
Example URL | /api/v1/api.php?target=ipam&action=aggregate&id=125&autoAggregateToMask=24 |
...