...
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 |
IP Tag List
Get Tags ListGet Resource Hierarchy | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=ipam&action=getResourceHierarchy&id= getTagList79124 | |||||||||||
Description | Returns a list of all valid IP Tags in the databasethe Parent Resource and Parent Resource id for the provided block. | |||||||||||
Returns | Examples:
| |||||||||||
Add Tag To List | ||||||||||||
| ||||||||||||
Required Parameters |
| |||||||||||
Optional Parameters | None | |||||||||||
Example URL | /api/v1/api.php?target=ipam&action= | addTagToListgetResourceHierarchy&id=79124 |
IP Subnets List
Get Subnet List | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=ipam&action=getSizes | ||||||||||
Description | Returns the IPv4 or IPv6 Subnet Lists | ||||||||||
Returns | Examples: | ||||||||||
Description | Adds a tag to the IPAM tag list | ||||||||||
Returns | Examples:
| ||||||||||
Required Parameters |
| ||||||||||
Optional Parameters | None | ||||||||||
Example URL | /api/v1/api.php?target=ipam&action=addTagToListgetSizes&newTagsize=Loopback C6 |
IP Tag List
Get TagsDelete Tag FromList | ||||||||
---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=ipam&action=deleteTagFromListgetTagList | |||||||
DescriptionDeletes | a tag from the IPAM tag listReturns a list of all valid IP Tags in the database. | |||||||
Returns | Examples:
|
Add Tag To List | |||||||||
---|---|---|---|---|---|---|---|---|---|
Required Parameters |
| ||||||||
Optional Parameters | None | ||||||||
URL | /api/v1/api.php?target=ipam&action= | deleteTagFromList&tag=tag123
IP Regions List
addTagToList | |||||||||
Description | Adds a tag to the IPAM tag list | ||||||||
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:
| ||||||||
Required Parameters |
| ||||||||
Optional Parameters | None | ||||||||
Example URL | /api/v1/api.php?target=ipam&action=addTagToList&newTag=Loopback C |
Delete Tag From List | |||||||||
---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=ipam&action=deleteTagFromList | ||||||||
Description | Deletes a tag from the IPAM tag list | ||||||||
Returns | Examples:
| ||||||||
Required Parameters |
| ||||||||
Optional Parameters | None | ||||||||
Example URL | /api/v1/api.php?target=ipam&action=deleteTagFromList&tag=tag123 |
IP Regions List
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:
|
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 |
| Required Parameters |
| ||||||||||
Optional Parameters | None | ||||||||||||
Example URL | /api/v1/api.php?target=ipam&action=addRegionToList&newRegion=SFO |
Utilization
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 Host Utilization | |||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=ipam&action=getHostUtilization | ||||||||||||||||||||||||||||||
Description | Gets the host utilization statistics with support for filters. | ||||||||||||||||||||||||||||||
Returns | Examples:
| ||||||||||||||||||||||||||||||
Required 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"] | ||||||||||||||||||||||||||||||
Example URL | /api/v1/api.php?target=ipam&action=getHostUtilization&type=ipv4&tags=["Customer","PTP"]®ion=SMF |
Holding Tank
Override Holding | |||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=ipam&action=processHoldingTank | ||||||||||||||||||||||||||||||
Description | Overrides holding for a specific block, returning the block to available status | ||||||||||||||||||||||||||||||
Returns | Examples:
| ||||||||||||||||||||||||||||||
Required Parameters |
| ||||||||||||||||||||||||||||||
Optional Parameters | None. | ||||||||||||||||||||||||||||||
Get Host Utilization | |||||||||||||||||||||||||||||||
URL | /api/v1/api.php?target=ipam&action=getHostUtilization | ||||||||||||||||||||||||||||||
Description | Gets the host utilization statistics with support for filters. | ||||||||||||||||||||||||||||||
Returns | Examples:
| ||||||||||||||||||||||||||||||
Required Parameters |
| ||||||||||||||||||||||||||||||
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"]
...
block=213.37.29.0/24&preview=true |
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 |
...