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 |
SUCCESSFUL | {"success":1,"message":"Block 192.168.0.0/24 (12345) added", "id":12345, "data":{ "id":12345, "cidr":192.168.0.0/24", ...} } |
ERROR | { "success":0, "message":"error message" } |
Name | Type | Example | Description |
---|---|---|---|
block | STRING | 213.37.29.0/24 | CIDR block description |
rir | STRING | ARIN | Acceptable values: ARIN, RIPE, APNIC, AfriNIC |
Name | Type | Example | Description |
---|---|---|---|
allowDuplicate | BOOL | true | Allow the creation of duplicate blocks. The default behavior is to reject duplicates. |
allowSubAssignments | BOOL | true | Does the block allow sub-assignments? If the block is assigned and allowSubAssignments is "true", children split from this block will be able to be assigned to different resources. Acceptable values: "true" or "false" |
asn | INTEGER | 1000 | ASN for the block |
code | STRING | User-defined block code as defined in Admin-IPAM settings: Generic Code Per Block Name | |
notes | STRING | Notes or description for the block | |
region | STRING | SFO | The value from the list of name/value pairs which make up the list of available regions |
tags | STRING | customer,vpn | Comma-separated list of tags |
vlan | INTEGER | 123 | VLAN for the block |
Update | |||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=ipam&action=update&type=IP&ipid=13420&rir=RIPE | ||||||||||||||||||||||||||||||||||||||||
Description | Updates detail data about an IP block. | ||||||||||||||||||||||||||||||||||||||||
Returns | Examples:
| ||||||||||||||||||||||||||||||||||||||||
Required Parameters |
| ||||||||||||||||||||||||||||||||||||||||
Optional Parameters |
|
Delete | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=ipam&action=delete&id=12345 | ||||||||||||||||
Description | Deletes an aggregate block | ||||||||||||||||
Returns | Examples
| ||||||||||||||||
Required Parameters |
| ||||||||||||||||
Optional Parameters |
|
Add Tag | |||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=ipam&action=addTag&id=13420&tag=Infra | ||||||||||||||||||||
Description | Adds a tag to an IP block. | ||||||||||||||||||||
Returns | Examples:
| ||||||||||||||||||||
Required 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 |
DeleteDelete Tag | |||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=ipam&action=deleteTag&id=13420&tag=Proddelete | ||||||||||||||||||||||||
Description | Removes a tag from an IP block.Deletes an aggregate block | ||||||||||||||||||||||||
Returns | Examples:
| ||||||||||||||||||||||||
Required Parameters |
| ||||||||||||||||||||||||
Smart Assign | |||||||||||||||||||||||||
Optional Parameters |
| ||||||||||||||||||||||||
Example URL | /api/v1/api.php?target=ipam&action= | smartAssigndelete&block=213.37.29.0/24 |
Add Tag | |||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=ipam&action=addTag | ||||||||||||||||||||||||||||||||||||||||||||||||||
Description | Adds a tag to an IP block | Description | Selects a block based on supplied parameters (rir, tags, etc.) and assigns to an Resource Holder. | ||||||||||||||||||||||||||||||||||||||||||||||||
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 |
| |||||||||||||||||||||||||||||||||||||||
Optional Parameters | None | ||||||||||||||||||||||||||||||||||||||||
Example URL | /api/v1/api.php?target=ipam&action= | smartAssigndeleteTag& | maskid= | 24125& | resourceHolderId=SJS-0031&rir=ARIN&tags=customer,vpntag=Customer |
SmartDirectAssign | |||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=ipam&action=directAssignsmartAssign | ||||||||||||||||||||||||||||||||||||||||||||||||||||
Description | Assigns a block to an Resource Holder | Selects a block based on supplied parameters (rir, tags, mask size, etc.) and assigns it to a Resource Holder. | |||||||||||||||||||||||||||||||||||||||||||||||||||
ReturnsReturns | Examples:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||
Required Parameters |
| Optional Parameters | |||||||||||||||||||||||||||||||||||||||||||||||||||
Name | Type | Example | Description |
| |||||||||||||||||||||||||||||||||||||||||||||||||
Optional Parameters* |
| code | STRING | "code-1"
| "SFO"
| "Customer"
|
| tagsMode | STRING | "strict" or "exclude"
| ONLY
| EXACT
| ONLY
| NOT
*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 | Example URL | /api/v1/api.php?target=ipam&action=directAssignsmartAssign&block=213.37.29.0/24&resourceHolderId=SJS-0031mask=24&type=IPv4&resourceId=250&rir=ARIN |
Direct AssignUnassign | |||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=ipam&action=unassigndirectAssign | ||||||||||||||||||||||||||||||||
Description | Reclaims the specified Assigns a block to be reassigned in the futurean Resource Holder | ||||||||||||||||||||||||||||||||
Returns | Examples:
| ||||||||||||||||||||||||||||||||
Required Parameters |
| ||||||||||||||||||||||||||||||||
Example URL | /api/v1/api.php?target=ipam&action=unassign&block=213.37.29.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 |
SUCCESSFUL | { "success":1,"message":"Sent ARIN SWIP with action simpleReassign for 67.221.244.0/28 for Acme, Message: Success" } |
ERROR | { "success":0, "message":"error message" } |
resourceHolderId** | STRING | cust-001 | (Deprecated: Use resourceQuery instead) A custom ID which can be used to link resources in the 6Connect database back to your organization. |
resourceId** | INTEGER | 1234 | Integer ID of the resource to assign the block to |
resourceQuery** | JSON | {"custom_id":"cust-001"} | A JSON object representing a valid resource query. Any parameters that can be used for a Resource GET API call can be used. Use of the resourceQuery parameter will return blocks assigned to any of the resources returned by that query. |
**Either resourceId, resourceQuery, or resourceHolderId can be used, but only one must be provided |
Name | Type | Example | Description |
---|---|---|---|
code | STRING | Code X | Arbitrary user-defined block code |
lirId | INTEGER | 101 | The ID of an LIR resource |
region | STRING | Ashburn | Region to assign from |
rir | STRING | ARIN | Acceptable values: ARIN, RIPE, APNIC, AfriNIC, LACNIC, 1918 |
tags | STRING | customer,vpn | Comma separated string of tags. Matches blocks which have at least the set of tag specified by this parameter |
tagsMode | STRING | "strict","exclude", "intersection", or "union". | Denotes how the "tags" parameter is handled: "strict" - matches only blocks that have the exact set of tags of specified. "exclude" - matches only blocks which are note tagged with any of the blocks specified. "intersection" - matches any blocks which has all of the tags. "union" - matches all blocks which has any one of the tags. If not otherwise specified, tagsMode defaults to "intersection". |
vlan | INTEGER | 1023 | VLAN designated to a given block |
*Additional or fewer "optional" parameters may be required in order to result in a successful assignment, depending on the attributes of available blocks.
Unassign | |||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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 | ||||||||||||||||||||
Get Tags List | |||||||||||||||||||||
URL | /api/v1/api.php?target=ipam&action=getTagListunassign | ||||||||||||||||||||
DescriptionReturns | a list of all valid IP Tags in the database.Reclaims the specified block to be reassigned in the future | ||||||||||||||||||||
Returns | Examples:
|
Get RIRs List | |||||
---|---|---|---|---|---|
URL | /api/v1/api.php?target=ipam&action=getRIRList | ||||
Description | Returns a list of all valid 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:
|
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. | ||||||||||||||||
Example URLs | https://ops.6connect.com/qa-4.1/api/v1/api.php?target=ipam&action=utilization&id=23131 | ||||||||||||||||
Returns | Examples:
| ||||||||||||||||
Required Parameters |
| ||||||||||||||||
Optional Parameters |
|
| |||||||||||||||||
Required Parameters |
| ||||||||||||||||
Optional Parameters |
| ||||||||||||||||
Example URL | /api/v1/api.php?target=ipam&action=unassign&block=213.37.29.0/24 |
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 |
Split | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=ipam&action=split | ||||||||||||||||
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 |
| ||||||||||||||||
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:
| ||||||||
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 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 |
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=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 |
| ||||||||
Optional Parameters | None | ||||||||
Example 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 List | |||||||||
---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=ipam&action=addTagToList | ||||||||
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=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:
| ||||||||
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:
| ||||||||
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 |
| |||||||||||||||||||||
Example URL | ||||||||||||||||||||||
Get Host Utilization | ||||||||||||||||||||||
URL | /api/v1/api.php?target=ipam&action=getHostUtilization | |||||||||||||||||||||
Description | Gets the host utilization statistics with support for filters. | |||||||||||||||||||||
Example URLs | /api/v1/api.php?target=ipam&action=getHostUtilizaiton&tags=["Customer","PTP"]®ion=SMF | |||||||||||||||||||||
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=getHostUtilizationmaskReport&type=ipv4&tags=["Customer","PTP"]regions=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:
| ||||||||||||||||||||||||
Required Parameters |
| ||||||||||||||||||||||||
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 |
| mask
| int | 24 | Auto aggregate the block back to this mask size. Note all blocks up this mask size must be Available or call will fail. | ||||||||||||||||||||
block* | STRING | 213.37.29.0/24 | CIDR block. Only the block id OR the block CIDR can be specified. Not both. |
| |||||||||||||||||||||
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 ListSplit | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=ipam&action=splitgetRIRList | ||||||||||||||||
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 RIRs in the database. | ||||||||||||||||
Returns | Examples:
| ||||||||||||||||
Required Parameters |
| ||||||||||||||||
Optional Parameters |
| ||||||||||||||||
|
Simple Reassign | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Scan Block | ||||||||||||||||||||||||||||
URL | /api/v1/api.php?target=ipam&action=scanBlocksimpleReassign | |||||||||||||||||||||||||||
DescriptionInitiates | an asynchronous ping (ICMP) scan of the target block specified. Results of the scan can be checked with getARIN 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 |
| block*
| 213.37.29.0/24 | CIDR block. Only the block id OR the block CIDR can be specified. Not both. |
| |||||||||||||||||||||||
Example URL | Example/api/v1/ | api.php?target=ipam&action=scanBlock&block=8.8.8.0/27api.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 ListGet Scan Results | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=ipam&action= getScanResultsgetAttributeLists | ||||||||||||
Description | Initiates an asynchronous ping (ICMP) scan of the target block specified. Results of the scan can be checked with getReturns a list of attributes | ||||||||||||
Returns | Examples:
| ||||||||||||
Required Parameters |
| block*
| STRING | 213.37.29.0/24 | CIDR block. Only the block id OR the block CIDR can be specified. Not both.
| ||||||||
Optional Parameters | None | ||||||||||||
Example URL | /api/v1/api.php?target=ipam&action=getScanResultsgetAttributeLists&block=8.8.8.0/27id=125 |