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 |
Delete | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=ipam&action=delete | ||||||||||||||||
Description | Deletes an aggregate block | ||||||||||||||||
Returns | Examples
| ||||||||||||||||
Required Parameters |
| ||||||||||||||||
Optional Parameters |
| ||||||||||||||||
Example URL | /api/v1/api.php?target=ipam&action=delete&block=213.37.29.0/24 |
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 |
Delete Tag | |||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=ipam&action=deleteTag | ||||||||||||||||||||
Description | Removes a tag from an IP block. | ||||||||||||||||||||
Returns | Examples:
| ||||||||||||||||||||
Required Parameters |
| ||||||||||||||||||||
Optional Parameters | None | ||||||||||||||||||||
Example URL | /api/v1/api.php?target=ipam&action=deleteTag&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, etcmask size, etc.) and assigns it to an a 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=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 *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 |
Simple ReassignAggregate | |||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=ipam&action=simpleReassignaggregate | ||||||||||||||||||||||||||||||||
Description ARIN SWIP - simple reassign. Creates an ARIN customer record for the assigned resource and reassigns the | Aggregates a selected block to the ARIN customer record.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: | Returns | Examples:
| ||||||||||||||||||||||||||||||
Required Parameters |
| ||||||||||||||||||||||||||||||||
Optional Parameters |
| netName
| STRING | NET-ACME-67-221-244-0-28 | Optional name for the network to override the default. The default net name will be created using the Net Name Prefix and IP address for the block
| ||||||||||||||||||||||||||||
Example URL | /api/v1/api.php?target=ipam&action= | simpleReassignaggregate& | resourceIdid= | 121125& | blockId=31559&lirId=95&entityHandle=CONNE-81&&netName=NET-ACME-67-221-244-0-28autoAggregateToMask=24 |
SplitGet Tags List | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=ipam&action=getTagListsplit | ||||||||||||||||
DescriptionReturns a list of all valid IP Tags 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:
| ||||||||||||||||
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 C=split&block=213.37.29.0/24&autoSplitLimit=4 |
Scan BlockGet RIRs List | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=ipam&action=getRIRListscanBlock | ||||||||||||||||
DescriptionReturns | a list of all valid RIRs in the database 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 ResultsGet Regions List | |||||||||
---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=ipam&action=getRegionListgetScanResults | ||||||||
DescriptionReturns | a list of all valid Regions in the database. 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=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 VLANAdd Region To List | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=ipam&action=addRegionToListgetVlan | ||||||||||||||
Description | Adds a region to the IPAM region listReturns the VLAN for the block | ||||||||||||||
Returns | Examples: | ||||||||||||||
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 | None | ||||||||||||||
Example URL | /api/v1/api.php?target=ipam&action=addRegionToList&newRegion=SFO | ||||||||||||||
Get Utilization | |||||||||||||||
| |||||||||||||||
Required Parameters |
| description
| |||||||||||||
id* | INTEGER | 125 | ID of the IP block |
| |||||||||||
Optional Parameters | |||||||||||||||
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.None | ||||||||
Example URL | /api/v1/api.php?target=ipam&action=utilizationgetVlan&id=125 |
GetHost UtilizationResource Hierarchy | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=ipam&action= getHostUtilizationgetResourceHierarchy&id=79124 | ||||||||||||||
Description | Gets the host utilization statistics with support for filters 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=getResourceHierarchy&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:
| |||||||||||||||
Required Parameters |
| type
| STRING
| ipv4
| ipv6
| IP type
| ||||||||||
Optional Parameters | Name | TypeNone | ||||||||||||||
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 | ||||||||||||
Example URL | /api/v1/api.php?target=ipam&action=getHostUtilization&type=ipv4&tags=["Customer","PTP"]®ion=SMF |
URL | /api/v1/api.php?target=ipam&action=getSizes&size=6 |
IP Tag List
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:
|
Add Tag To ListAggregate | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=ipam&action= aggregateaddTagToList | ||||||||||||
Description | Aggregates Adds 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.tag to the IPAM tag list | ||||||||||||
Returns | Examples | Returns | Examples:
| ||||||||||
Required Parameters |
| id*
| INTEGER
| 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.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 Example URL | /api/v1/api.php?target=ipam&action=aggregatedeleteTagFromList&id=125&autoAggregateToMask=24tag=tag123 |
IP Regions List
Get Regions ListSplit | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=ipam&action=splitgetRegionList | ||||||||||||||||
Description | 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 |
| ||||||||||||||||
Returns a list of all valid Regions in the database. | |||||||||||||||||
Returns | Examples:
|
Add Region To List | |||||||||
---|---|---|---|---|---|---|---|---|---|
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. | ||||||||
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:
| ||||||||||||||||
Required Parameters |
| ||||||||||||||||
Optional Parameters | None. | ||||||||||||||||
Example URL | /api/v1/api.php?target=ipam&action=overrideHolding&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:
| Returns | Examples:
| ||||||
Required Parameters | None | ||||||||
Optional Parameters |
| Example | Description | ||||||
id* | INTEGER | 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 | None | ||||||||
| |||||||||
Example URLExample | /api/v1/api.php?target=ipam&action=scanBlockprocessHoldingTank&block=213.37.29.0/24preview=true |
Reports
Mask ReportGet Scan Results | |||||||||
---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=ipam&action=getScanResultsmaskReport | ||||||||
DescriptionInitiates an asynchronous ping (ICMP) scan of the target block specified. Results of the scan can be checked with get | Returns a JSON report breakdown of by-mask use statistics | ||||||||
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=maskReport®ions=DEN |
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:
| ||||||||||||||
Get VLAN | |||||||||||||||
URL | /api/v1/api.php?target=ipam&action=getVlan | ||||||||||||||
Description | Returns the VLAN for the block | Returns | |||||||||||||
SUCCESSFUL | {"success":1,"message":"Found VLAN 1002 (14.0.0.0\/25)","data":{"id":125,"type":"ipv4","top_aggregate":81532,"cidr":"14.0.0.0\/25","formatted_ip":"14.0.0.0\/25","address":"234881024","end_address":"234881151","mask":25,"netmask":"255.255.255.128","child1":null,"child2":null,"is_assigned":0,"is_swipped":0,"is_aggregate":1,"custid":402,"resource_id":402,"resource_name":"6connect Labz","last_updated_time":"2015-01-22 12:30:37","description":null,"parent":81532,"rir":"ARIN","lir_id":"1062","notes":"Test Notes","generic_code":"Datacenter2","code":"Datacenter2","region":"ATL","region_name":"Atlanta, GA","vlan":1002,"arin_net_id":null,"arin_cust_id":null,"org_id":null,"arin_swip_time":null,"assigned_time":"2015-01-14 10:30:31","asn":"143","allowSubAssignments":true,"permissions":{"permissionIPAMRead":"1","permissionIPAMUpdate":"1","permissionIPAMCreate":"1","permissionIPAMDelete":"1","permissionSWIP":"1","permissionAdmin":"1"},"range":"14.0.0.0 - 14.0.0.127","tags":["Customer"]}} | ERROR | {'success':0, 'message':'error message'|||||||||||||
| |||||||||||||||
Required Parameters |
| ||||||||||||||
| |||||||||||||||
| ID of the IP block | ||||||||||||||
block* | STRING | 213.37.29.0/24 | CIDR block. | ||||||||||||
| |||||||||||||||
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 |
Get RIR List | |||||
---|---|---|---|---|---|
URL | /api/v1/api.php?target=ipam&action=getRIRList | ||||
Description | Returns a list of all valid RIRs in the database. | ||||
Returns | Examples:
|
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 | 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 | =processHoldingTank&preview=true=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 |
...