Table of Contents |
---|
IP Address Management (IPv4 and IPv6)
Warning |
---|
ProVision's APIv1 system has been replaced by APIv2, and is now considered deprecated. |
Table of Contents |
---|
IP Block Management
Get | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=ipam&action=get | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Description | Returns a list of IP blocks. Use optional parameters to filter the list. If multiple parameters are specified, only blocks matching all parameters will be returned. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Returns | Examples:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Required Parameters | None | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Optional Parameters |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Example URL | /api/v1/api.php?target=ipam&action=get&rir=ARIN&tags=customer,vpn |
...
Add | |||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=ipam&action=add | ||||||||||||||||||||||||||||||||||||
Description | Adds an IPv4 or IPv6 block | ||||||||||||||||||||||||||||||||||||
Returns | Examples:
| ||||||||||||||||||||||||||||||||||||
Required Parameters |
| ||||||||||||||||||||||||||||||||||||
Optional Parameters |
| ||||||||||||||||||||||||||||||||||||
Example URL | /api/v1/api.php?target=ipam&action=add&block=213.37.29.0/24&rir=ARIN |
...
Update | |||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=ipam&action=update | ||||||||||||||||||||||||||||||||||||||||||||||||
Description | Updates detail data about an IP block. | ||||||||||||||||||||||||||||||||||||||||||||||||
Returns | Examples:
| ||||||||||||||||||||||||||||||||||||||||||||||||
Required Parameters |
| ||||||||||||||||||||||||||||||||||||||||||||||||
Optional Parameters |
| ||||||||||||||||||||||||||||||||||||||||||||||||
Example URL | /api/v1/api.php?target=ipam&action=update&block=192.0.0.0/24¬es=Notes_here |
...
Add Tag | |||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=ipam&action=addaddTag | ||||||||||||||||||||
Description | Adds a tag to an IP block. | ||||||||||||||||||||
Returns | Examples:
| ||||||||||||||||||||
Required Parameters |
| ||||||||||||||||||||
Optional Parameters | None | ||||||||||||||||||||
Example URL | /api/v1/api.php?target=ipam&action=addTag&id=125&tag=Customer |
...
Smart Assign | |||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=ipam&action=smartAssign | ||||||||||||||||||||||||||||||||||||||||
Description | Selects a block based on supplied parameters (rir, tags, mask size, etc.) and assigns it to a Resource Holder. | ||||||||||||||||||||||||||||||||||||||||
Returns | Examples:
| ||||||||||||||||||||||||||||||||||||||||
Required Parameters |
| ||||||||||||||||||||||||||||||||||||||||
Optional Parameters* |
*Additional or fewer "optional" parameters *Additional or fewer "optional" parameters may be required in order to result in a successful assignment, depending on the attributes of available blocks. | ||||||||||||||||||||||||||||||||||||||||
Example URL | /api/v1/api.php?target=ipam&action=smartAssign&mask=24&type=IPv4&resourceIDresourceId=250&rir=ARIN |
Direct Assign | |||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=ipam&action=directAssign | ||||||||||||||||||||||||||||||||||
Description | Assigns a block to an Resource Holder | ||||||||||||||||||||||||||||||||||
Returns | Examples:
| ||||||||||||||||||||||||||||||||||
Required Parameters |
| ||||||||||||||||||||||||||||||||||
Optional Parameters* |
*Additional or fewer "optional" parameters may be required in order to result in a successful assignment, depending on the attributes of available blocks. | ||||||||||||||||||||||||||||||||||
Example URL | /api/v1/api.php?target=ipam&action=directAssign&block=213.37.29.0/24&resourceId=1234 |
...
Unassign | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=ipam&action=unassign | ||||||||||||||||
Description | Reclaims the specified block to be reassigned in the future | ||||||||||||||||
Returns | Examples:
| ||||||||||||||||
Required Parameters |
| ||||||||||||||||
Optional Parameters |
| ||||||||||||||||
Example URL | /api/v1/api.php?target=ipam&action=unassign&block=213.37.29.0/24 |
Get Tags ListAggregate | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=ipam&action=getTagListaggregate | |||||||||||||||||||||
Description Returns a list of all valid IP Tags in the database | 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:
| |||||||||||||||||||||
Add Tag To List | ||||||||||||||||||||||
URL | /api/v1/api.php?target=ipam&action=addTagToList | |||||||||||||||||||||
Description | Adds a tag to the IPAM tag list | |||||||||||||||||||||
Returns | Examples:
| |||||||||||||||||||||
| ||||||||||||||||||||||
Required Parameters |
| |||||||||||||||||||||
Optional | RequiredParameters |
| newTag
| STRING
| Loopback C | The value to add to the list of name/value pairs which make up the list of available regions |
| Optional Parameters | None||||||||||||||
Example URL | /api/v1/api.php?target=ipam&action=addTagToList&newTag=Loopback Caggregate&id=125&autoAggregateToMask=24 |
SplitGet Regions List | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=ipam&action=getRegionListsplit | ||||||||||||||||
DescriptionReturns a list of all valid Regions in the database | Splits a selected block to the mask specified. If no mask specified, it split blocks to next child. IE. calling aggregate on a /24 will split both parent to the child /25s. All parent blocks must be Available, or have Allow Sub Assignments on for a split to succeed. | ||||||||||||||||
Returns | Examples:
| ||||||||||||||||
Required Parameters |
| ||||||||||||||||
Optional Parameters |
| ||||||||||||||||
Example URL | /api/v1/api.php?target=ipam&action=split&block=213.37.29.0/24&autoSplitLimit=4 |
Scan Block | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=ipam&action=scanBlock | ||||||||||||||||
Description | Initiates an asynchronous ping (ICMP) scan of the target block specified. Results of the scan can be checked with get. | ||||||||||||||||
Returns | Examples:
| ||||||||||||||||
Required Parameters |
| ||||||||||||||||
Optional Parameters | None | ||||||||||||||||
Example | /api/v1/api.php?target=ipam&action=scanBlock&block=213.37.29.0/24 |
Get Scan Results | |||||||||
---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=ipam&action=getScanResults | ||||||||
Description | Initiates an asynchronous ping (ICMP) scan of the target block specified. Results of the scan can be checked with get | ||||||||
Returns | Examples:
| ||||||||
Add Region To List | |||||||||
Required Parameters |
| ||||||||
Optional Parameters | None | ||||||||
Example | URL/api/v1/api.php?target=ipam&action= | addRegionToListgetScanResults&block=213.37.29.0/24 |
Get Options | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=ipam&action=getOptions | |||||||||||
Description | Returns a list of options available for the block | 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=addRegionToListgetOptions&newRegionid=SFO125 |
GetUtilizationVLAN | |||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=ipam&action= utilizationgetVlan | ||||||||||||||||||||||||||||||
Description | Gets Returns the utilization percentages for a specific ip block or ip block and mask combination.VLAN for the block | ||||||||||||||||||||||||||||||
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 |
| type
| STRING | "ipv4" or "ipv6" | IP type | ||||||||||||||||||||||||||
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"] | ||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||
Optional Parameters | None | ||||||||||||||||||||||||||||||
Example URL | /api/v1/api.php?target=ipam&action=getVlan&id=125 |
Get Resource Hierarchy | |||||||||
---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=ipam&action=getResourceHierarchy&id=79124 | ||||||||
Description | Returns the Parent Resource and Parent Resource id for the provided block. | ||||||||
Returns | Examples:
| ||||||||
Required Parameters |
| ||||||||
Optional Parameters | None | ||||||||
Example URL | /api/v1/api.php?target=ipam&action=getHostUtilizationgetResourceHierarchy&type=ipv4&tags=["Customer","PTP"]®ion=SMF |
id=79124 |
IP Subnets List
Get Subnet ListAggregate | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=ipam&action=aggregategetSizes | ||||||||||||
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 the IPv4 or IPv6 Subnet Lists | |||||||||||
Returns | Returns | Examples:
| |||||||||||
Required Parameters |
| id*
| 125 | ID of the IP block. | |||||||||
block* | STRING | 213.37.29.0/24 | CIDR block. | ||||||||||
*Either block or id can be used, but only one must be provided | |||||||||||||
Optional Parameters |
| ||||||||||||
| |||||||||||||
Optional Parameters | None | ||||||||||||
Example URL | /api/v1/api. | Example URL | /api/v1/api.php?target=ipam&action=aggregategetSizes&id=125&autoAggregateToMask=24size=6 |
IP Tag List
Get Tags ListSplit | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=ipam&action=splitgetTagList | ||||||||||||||||
DescriptionSplits | a selected block to the mask specified. If no mask specified, it split blocks to next child. IE. calling aggregate on a /24 will split both parent to the child /25s. All parent blocks must be Available, or have Allow Sub Assignments on for a split to succeed.Returns a list of all valid IP Tags in the database. | ||||||||||||||||
Returns | Examples:
| ||||||||||||||||
Required Parameters |
| ||||||||||||||||
|
Add Tag To List | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=ipam&action=addTagToList | |||||||||||
Description | Adds a tag to the IPAM tag list | |||||||||||
Returns | Examples:
| |||||||||||
Required | OptionalParameters |
| autoSplitToMask
| INTEGER
| 24 | Auto aggregate the block back to this mask size. Note all blocks up this mask size must be Available or call will fail. | ||||||
autoSplitLimit | INTEGER | 4 | A number the power of 2 (^2). |
| ||||||||
Optional Parameters | None | |||||||||||
Example URL | /api/v1/api.php?target=ipam&action=splitaddTagToList&block=213.37.29.0/24&autoSplitLimit=4newTag=Loopback C |
Delete Tag From ListScan Block | |||||||||
---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=ipam&action= scanBlockdeleteTagFromList | ||||||||
Description | Initiates an asynchronous ping (ICMP) scan of the target block specified. Results of the scan can be checked with get. | 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:
| ||||||||
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:
| Returns | Examples:
| |||||||||||||||||||||
Required Parameters |
| id* | INTEGER | 125 | ID of the IP block.
| block.
| ||||||||||||||||||
Optional Parameters | None. | |||||||||||||||||||||||
Example URL | /api/v1/api.php?target=ipam&action=scanBlockoverrideHolding&block=213.37.29.0/24&preview=true |
Process Holding TankGet Scan Results | |||||||||
---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=ipam&action= getScanResultsprocessHoldingTank | ||||||||
Description | Initiates an asynchronous ping (ICMP) scan of the target block specified. Results of the scan can be checked with getProcesses the Holding Tank, returning held blocks to available status | ||||||||
Returns | Examples:
| ||||||||
Required Parameters |
| ||||||||
Optional Parameters | None | ||||||||
Example | /api/v1/api.php?target=ipam&action=getScanResults&block=213.37.29.0/24 |
Get Options | |||||||||
---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=ipam&action=getOptions | ||||||||
Description | Returns a list of options available for the block | ||||||||
Returns | Examples:
| ||||||||
Required Parameters |
| ||||||||
Optional Parameters | None | ||||||||
Example URL | /api/v1/api.php?target=ipam&action=getOptions&id=125 |
Get Resource Hierarchy | |||||||||
---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=ipam&action=getResourceHierarchy | ||||||||
Description | Returns the resource hierarchy for the block | ||||||||
Returns | Examples:
| ||||||||
Required Parameters |
| ||||||||
Optional Parameters | None | ||||||||
Example URL | /api/v1/api.php?target=ipam&action=getResourceHierarchy&id=125 |
| |||||||||
Required Parameters | None | ||||||||
Optional Parameters |
| ||||||||
Example URL | /api/v1/api.php?target=ipam&action=processHoldingTank&preview=true |
Reports
Mask Report | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=ipam&action=maskReport | ||||||||||||||||
Description | Returns a JSON report breakdown of by-mask use statistics | ||||||||||||||||
Returns | Examples:
| ||||||||||||||||
Required Parameters | None | ||||||||||||||||
Optional Parameters |
| ||||||||||||||||
Get VLAN | |||||||||||||||||
URL | /api/v1/api.php?target=ipam&action=getVlan | ||||||||||||||||
Description | Returns the VLAN for the block | ||||||||||||||||
Returns | Examples:
| Required Parameters | |||||||||||||||
Name | Type | Example | Description | ||||||||||||||
id* | INTEGER | 125 | ID of the IP block | ||||||||||||||
block* | STRING | 213.37.29.0/24 | CIDR block. | ||||||||||||||
Optional Parameters | None | ||||||||||||||||
Example URL | /api/v1/api.php?target=ipam&action=getVlan&id=125 | ||||||||||||||||
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= | processHoldingTankmaskReport& | previewregions= | trueDEN |
IPAM SWIP Calls:
Deassign | |||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=ipam&action=deassign | ||||||||||||||||||||||||
Description | Performs a SWIP deassignment for the indicated IPAM block. | ||||||||||||||||||||||||
Returns | Examples:
| ||||||||||||||||||||||||
Required Parameters |
| ||||||||||||||||||||||||
Optional Parameters |
| ||||||||||||||||||||||||
Example URL | /api/v1/api.php?target=ipam&action=deassign&resourceId=1234&blockId=1234&lirId=1234&entityHandle=CONNE-81&block=67.221.241.0/24&netName=6CONN-67-221-241-0-24 |
...
Simple Reassign | |||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=ipam&action=simpleReassign | ||||||||||||||||||||
Description | ARIN SWIP - simple reassign. Creates an ARIN customer record for the assigned resource and reassigns the block to the ARIN customer record. | ||||||||||||||||||||
Returns | Examples:
| ||||||||||||||||||||
Required Parameters |
| ||||||||||||||||||||
Optional Parameters |
| ||||||||||||||||||||
Example URL | /api/v1/api.php?target=ipam&action=simpleReassign&resourceId=121&blockId=31559&lirId=95&entityHandle=CONNE-81&&netName=NET-ACME-67-221-244-0-28 |
IPAM API Calls Subject to Change:
Calls below this point are subject to change, and are not recommended for use in production code.
Get Attribute List | |||||||||
---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=ipam&action=getAttributeLists | ||||||||
Description | Returns a list of attributes | ||||||||
Returns | Examples:
| ||||||||
Required Parameters |
| ||||||||
Optional Parameters | None | ||||||||
Example URL | /api/v1/api.php?target=ipam&action=getAttributeLists&id=125 |
...