Versions Compared

Old Version 57

changes.mady.by.user The Force

Saved on

compared with

New Version 58

changes.mady.by.user The Force

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Unassign

URL/api/v1/api.php?target=ipam&action=unassign
DescriptionReclaims the specified block to be reassigned in the future
Returns

Examples:

SUCCESSFUL{ "success":1,"message":"192.168.0.0/24 unassigned", "id":12345,  "data":{ "id":12345, "cidr":192.168.0.0/24", ...} }
ERROR { "success":0, "message":"error message" }


Required Parameters
NameTypeExampleDescription
block*STRING213.37.29.0/24CIDR block description
id*INTEGER125ID of the IP block
*Either block or id can be used, but only one must be provided
Optional Parameters
NameTypeExampleDescription
skipHoldingBOOLtrue

If set to true (skipHolding=true) then the holding tank is skipped. If set to false, or not included, normal holding tank rules apply.

Acceptable values: "true" or "false"

Example URL/api/v1/api.php?target=ipam&action=unassign&block=213.37.29.0/24
Simple Reassign

Get Tags List

URL/api/v1/api.php?target=ipam&action=simpleReassigngetTagList
DescriptionARIN SWIP - simple reassign. Creates an ARIN customer record for the assigned resource and reassigns the block to the ARIN customer recordReturns a list of all valid IP Tags in the database.
Returns

Examples:

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" }
Required Parameters
NameTypeExampleDescription
blockIdINTEGER1234ID of the block to reassing
resourceIdINTEGER1234ID of resource representing the customer to reassign to
lirIdINTEGER1234ID of the LIR to use for reassignment
entityHandleSTRINGCONNE-81The Org ID for the LIR.
Tags Retrieved.","data":[{"value":"IT","name":"IT"},{"value":"LTE","name":"LTE Mobile"},{"value":"PTP","name":"Point to Point"},{"value":"Prod","name":"Production"},{"value":"VM","name":"Virtual Machines"},{"value":"VOIP","name":"VOIP"},{"value":"ANY","name":"ANY"}]}
ERROR{'success':0, 'message':'error message'}
Example simpleReassignresourceId=121&blockId=31559&lirId=95&entityHandle=CONNE-81&&netName=NET-ACME-67-221-244-0-28

Add Tag To List

URL

/api/v1/api.php?target=ipam&action=addTagToList

Description

Adds a tag to the IPAM tag list

Returns

Examples:

SUCCESSFUL

{"success":1,"message":"Tag Added."}

ERROR{'success':0, 'message':'error message'}
Required Optional Parameters
NameTypeExampleDescription
netName

newTag

STRINGNET-ACME-67-221-244-0-28Optional 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.Loopback CThe 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

Get Regions

Get Tags

List

URL/api/v1/api.php?target=ipam&action=getTagListgetRegionList
DescriptionReturns a list of all valid IP Tags Regions in the database.
Returns

Examples:

SUCCESSFUL

Get RIRs List

URL/api/v1/api.php?target=ipam&action=getRIRList
DescriptionReturns a list of all valid RIRs in the database.
Returns

Examples:

SUCCESSFUL{"success":1,"message":"Tags Regions Retrieved.","data":[{"value":"ITANY","name":"ITAny Region"},{"value":"LTEASH1","name":"LTE MobileAshburn, VA"},{"value":"PTPBOS","name":"Point to PointBoston, MA"},{"value":"ProdCHI","name":"ProductionChicago, IL"},{"value":"VMDAL","name":"Virtual MachinesDallas, TX"},{"value":"VOIPDEN","name":"VOIPDenver, CO"},{"value":"ANYFRKT","name":"ANY"}]}
ERROR{'success':0, 'message':'error message'}

Add Tag To List

URL

/api/v1/api.php?target=ipam&action=addTagToList

Description

Adds a tag to the IPAM tag list

Returns

Examples:

SUCCESSFUL

{"success":1,"message":"Tag Added."}

ERROR{'success':0, 'message':'error message'}
Required Parameters
NameTypeExampleDescription

newTag

STRINGLoopback CThe 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
{"success":1,"message":"RIRs Retrieved.","data":[{"value":"ARINFrankfurt, DE"},{"value":"LON1","name":"London, UK"},{"value":"MIA","name":"Miami, FL"},{"value":"PAR","name":"Paris, FR"},{"value":"SFO","name":"San Francisco, CA"},{"value":"SEA","name":"Seattle, WA"},{"value":"Tokyo","name":"ARINTokyo"},{"value":"1918Singapore","name":"1918Singapore"},{"value":"AfriNICJakarta","name":"AfriNIC"},{"value":"APNIC","name":"APNIC"},{"value":"LACNIC","name":"LACNIC"},{"value":"RIPE","name":"RIPE"},{"value":"1918-SJC","name":"1918-SJC"}Jakarta"}]}
ERROR{'success':0, 'message':'error message'}
Get Regions

Add Region To List

URL

/api/v1/api.php?target=ipam&action=

getRegionList

addRegionToList

DescriptionReturns

Adds a

list of all valid Regions in the database.

region to the IPAM region list

ReturnsReturns

Examples:

SUCCESSFUL

{"success":1,"message":"

Regions Retrieved

Region Added."

,"data":[{"value":"ANY","name":"Any Region"},{"value":"ASH1","name":"Ashburn, VA"},{"value":"BOS","name":"Boston, MA"},{"value":"CHI","name":"Chicago, IL"},{"value":"DAL","name":"Dallas, TX"},{"value":"DEN","name":"Denver, CO"},{"value":"FRKT","name":"Frankfurt, DE"},{"value":"LON1","name":"London, UK"},{"value":"MIA","name":"Miami, FL"},{"value":"PAR","name":"Paris, FR"},{"value":"SFO","name":"San Francisco, CA"},{"value":"SEA","name":"Seattle, WA"},{"value":"Tokyo","name":"Tokyo"},{"value":"Singapore","name":"Singapore"},{"value":"Jakarta","name":"Jakarta"}]}

}

ERROR{'success':0, 'message':'error message'}
Required Parameters
NameTypeExampleDescription
newRegionSTRINGSFOThe 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=addRegionToList&newRegion=SFO
Required newRegionSTRINGSFO value to add to the list of name/value pairs which make up the list of available regionsNone

Get Utilization

URL/api/v1/api.php?target=ipam&action=utilization
DescriptionGets the utilization percentages for a specific ip block or ip block and mask combination.
Returns

Examples:

SUCCESSFUL
{

"success": 1,

"totalBlocks": 1,

"totalHosts": "256",

"hostsAssigned": 0,

"hostsAllocated": "256",

"hostsAvailable": "256",

"hostsInHolding": 0,

"availablePercentage": "100.00",

"assignedPercentage": "0.00",

"allocatedPercentage": "100.00",

"inHoldingPercentage": "0.00",

"resources": [{

"id": 351,

"name": "Customer 1",

"type": "entry",

"hosts": "256",

"blocks": "1",

"percentage": "100.00"

}],

 

"blocksAssigned":0,

"blocksAllocated": 1,

"blocksAvailable": "1",

"blocksInHolding": null,

"blocksAssignedPercentage": "0.00",

"blocksAllocatedPercentage": "100.00",

"blocksAvailablePercentage": "100.00",

"blocksInHoldingPercentage": "0.00"

}
ERROR{'successERROR{'success':0, 'message':'error message'}

Add Region To List

URL

/api/v1/api.php?target=ipam&action=addRegionToList

Description

Adds a region to the IPAM region list

Returns

Examples:

SUCCESSFUL

{"success":1,"message":"Region Added."}

ERROR{'success':0, 'message':'error message'}
Required Parameters
NameTypeExampleDescription
block*STRING213.37.29.0/24CIDR block description
id*INTEGER125ID of the IP block
*Either block or id can be used, but only one must be provided
Optional Parameters
NameTypeExampleDescription
mask
INTEGER
24The

Optional Parameters

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=addRegionToListutilization&newRegionid=SFO125

Get Host Utilization

URL/api/v1/api.php?target=ipam&action=utilizationgetHostUtilization
DescriptionGets the host utilization percentages for a specific ip block or ip block and mask combinationstatistics with support for filters.
Returns

Examples:

SUCCESSFUL
{

"success": 1,

"totalBlocks": 1,"totalHosts": "256",

"hostsAssigned": 0,

"hostsAllocated": "256",

"hostsAvailable": "256",

"hostsInHolding": 0,

"availablePercentage": "100.00",

"assignedPercentage": "0.00",

"allocatedPercentage": "100.00",

"inHoldingPercentage": "0.00",

"resources": [{

"id": 351,

"name": "Customer 1",

"type": "entry",

"hosts": "256",

"blocks": "1",

"percentage": "100.00"

}]
,

 

"blocksAssigned":0,
"blocksAllocated": 1,
"blocksAvailable": "1",
"blocksInHolding": null,
"blocksAssignedPercentage": "0.00",
"blocksAllocatedPercentage": "100.00",
"blocksAvailablePercentage": "100.00",
"blocksInHoldingPercentage": "0.00"
}
ERROR{'success':0, 'message':'error message'}
Required Parameters
NameTypeExampleDescription
block*typeSTRING213.37.29.0/24CIDR block description
id*INTEGER125ID of the IP block
*Either block or id can be used, but only one must be provided
"ipv4" or "ipv6"IP type
Optional Parameters
NameTypeExampleMultiple ValuesDescription
maskcodeINTEGER24The 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

Get Host Utilization

URL/api/v1/api.php?target=ipam&action=getHostUtilization
DescriptionGets the host utilization statistics with support for filters.
Returns

Examples:

SUCCESSFUL
{

"success": 1,

"totalHosts": "256",

"hostsAssigned": 0,

"hostsAllocated": "256",

"hostsAvailable": "256",

"hostsInHolding": 0,

"availablePercentage": "100.00",

"assignedPercentage": "0.00",

"allocatedPercentage": "100.00",

"inHoldingPercentage": "0.00",

"resources": [{

"id": 351,

"name": "Customer 1",

"type": "entry",

"hosts": "256",

"blocks": "1",

"percentage": "100.00"

}]

}

ERROR{'success':0, 'message':'error message'}
Required Parameters
NameTypeExampleDescription
typeSTRING"ipv4" or "ipv6"IP type
STRING"code-1"YesUser-defined block code as defined in Admin-IPAM settings: Generic Code Per Block Name
regionSTRING"SFO"YesRegion to assign from
rirSTRINGARIN

No

Acceptable values: ARIN, RIPE, APNIC, AfriNIC, LACNIC, 1918
tagsSTRING"Customer"YesComma separated string of tags
vlanINTEGER1000YesVLAN 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"]

Example URL/api/v1/api.php?target=ipam&action=getHostUtilization&type=ipv4&tags=["Customer","PTP"]&region=SMF

 

 

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:

SUCCESSFUL
 {"success":1,"message":"10.2.0.128\/25 aggregated into 10.2.0.0\/24","id":16326}
ERROR{'success':0, 'message':'error message'}
Required Parameters
NameTypeExampleDescription
id*INTEGER125ID of the IP block.
block*STRING213.37.29.0/24CIDR block.
*Either block or id can be used, but only one must be provided
Optional Parameters
NameTypeExampleDescription
autoAggregateToMaskINTEGER24

All blocks and IPs smaller than this netmask will be aggregated.

ignoreAssignments

BOOLTRUE

If the ignoreAssignment flag is not set the aggregation operation will fail if any children beneath the supplied autoAggregateToMask are assigned or otherwise unavailable.  If this option is set, it will unassign blocks prior to reaggregation.

Example URLOptional Parameters
NameTypeExampleMultiple ValuesDescription
codeSTRING"code-1"YesUser-defined block code as defined in Admin-IPAM settings: Generic Code Per Block Name
regionSTRING"SFO"YesRegion to assign from
rirSTRINGARIN

No

Acceptable values: ARIN, RIPE, APNIC, AfriNIC, LACNIC, 1918
tagsSTRING"Customer"YesComma separated string of tags
vlanINTEGER1000YesVLAN 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=getHostUtilizationaggregate&typeid=ipv4125&tags=["Customer","PTP"]Example autoAggregateToMask=24
getHostUtilization&type=ipv4&tags=["Customer","PTP"]&region=SMF

Split

URL/api/v1/api.php?target=ipam&action=

 

 

split
Description

Splits a selected

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 it split blocks to next parentchild. IE. calling aggregate on a /25 24 will aggregate split both children back parent to the parent child /2425s. All child parent blocks must be Available for aggregation , or have Allow Sub Assignments on for a split to succeed.

Returns

Examples:

SUCCESSFUL
                      {"success":1,"message":"10.
2
1.0.
128
0\/
25
24
aggregated
split into 10.
2
1.0.0\/
24","id":16326
25 and 10.1.0.128\/25","data":{"child1":23441
                      ,"child2":23451}}
ERROR{'success':0, 'message':'error message'}
Required Parameters
NameTypeExampleDescription
id*INTEGER125ID of the IP block.
block*STRING213.37.29.0/24CIDR block.
*Either block or id can be used, but only one must be provided
Optional Parameters
NameTypeExampleDescription
autoAggregateToMaskautoSplitToMaskINTEGER24

All blocks and IPs smaller than this netmask will be aggregated.

Auto aggregate the block back to this mask size. Note all blocks up this mask size must be Available or call will fail.
autoSplitLimitINTEGER4A number the power of 2 (^2).

ignoreAssignments

BOOLTRUEIf the ignoreAssignment flag is not set the aggregation operation will fail if any children beneath the supplied autoAggregateToMask are assigned or otherwise unavailable.  If this option is set, it will unassign blocks prior to reaggregation.
Example URL/api/v1/api.php?target=ipam&action=aggregatesplit&id=125&autoAggregateToMask=24block=213.37.29.0/24&autoSplitLimit=4

Scan Block

Split

URL/api/v1/api.php?target=ipam&action=splitscanBlock
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.Initiates an asynchronous ping (ICMP) scan of the target block specified. Results of the scan can be checked with get.

Returns

Examples:

SUCCESSFUL
                      {"success":1,"message":"10.1.0.0\/24 split into 10.1.0.0\/25 and 10.1.0.128\/25","data":{"child1":23441
                      ,"child2":23451}}
                    Ping scan started for 8.8.8.0\/27"}
ERRORERROR{'success':0, 'message':'error message'}
Required Parameters
NameTypeExampleDescription
id*INTEGER125ID of the IP block.
block*STRING213.37.29.0/24CIDR block.
*Either block or id can be used, but only one must be provided
Optional Parameters
NameTypeExampleDescription
autoSplitToMaskINTEGER24Auto aggregate the block back to this mask size. Note all blocks up this mask size must be Available or call will fail.
autoSplitLimitINTEGER4A number the power of 2 (^2).

None

Example/api/v1/api.php?targetExample URL/api/v1/api.php?target=ipam&action=splitscanBlock&block=213.37.29.0/24&autoSplitLimit=4

Get Scan

Block

Results

URL/api/v1/api.php?target=ipam&action=scanBlockgetScanResults
Description

Initiates an asynchronous ping (ICMP) scan of the target block specified. Results of the scan can be checked with get.

Returns

Examples:

SUCCESSFUL
{"success":1,"data":{"messageblock":"Ping scan started for 8.8.8.0\/27"},"date":"07\/14\/2014 11:07:10",
"data":[{"address":"8.8.8.8","host":"google-public-dns-a.google.com","status":"Up"}],"status":"completed","hostsScanned":4,"activeHosts":4}}
ERROR{'success':0, 'message':'ERROR{'success':0, 'message':'error message'}
Required Parameters
*Either block or id can be used, but only one must be provided
NameTypeExampleDescription
id*INTEGER125ID of the IP block.block*STRING213.37.29.0/24CIDR block.
Optional Parameters

None

Example/api/v1/api.php?target=ipam&action=scanBlockgetScanResults&block=213.37.29.0/24
blockCIDR block.

Get

Scan Results

Options

URL

/api/v1/api.php?target=ipam&action=

getScanResults

getOptions

Description

Initiates an asynchronous ping (ICMP) scan of the target block specified. Results of the scan can be checked with getReturns a list of options available for the block

Returns

Examples:

data{"block":"8.8.827date"07\/14\/2014 11:07:10","dataaddress8.8.8.8host":"google-public-dns-a.google.com","status":"Up"}],"status":"completed","hostsScanned":4,"activeHosts":4
SUCCESSFUL{"success":1,"message":"Options for 14.0.0.0\/25 (125)","options":{"actions":["aggregate"],"templates":[{"name":"Auto Split","masks":[26,27,28,29,30,31,32]}]}}
ERROR{'success':0, 'message':'error message'}
Required Parameters
NameTypeExampleDescription
id
STRING213.37.29.0/24
INTEGER125ID of the IP block

Optional Parameters

None
Example URL/api/v1/api.php?target=ipam&action=getScanResultsgetOptions&block=213.37.29.0/24id=125

Get Resource Hierarchy

Get Options

URL

/api/v1/api.php?target=ipam&action=getOptionsgetResourceHierarchy

Description

Returns a list of options available the resource hierarchy for the block

Returns

Examples:

SUCCESSFUL{"success":"1,"message":"Options for 14.0.0.0\/25 (125)","optionsdata":[{"actionsid":["aggregate402"],"templates":[{"name":"Auto Split","masks":[26,27,28,29,30,31,32]}]}6connect Labz"}]}
ERROR{'success':0, 'message':'error message'}
Required Parameters
NameTypeExampleDescription
idINTEGER125ID of the IP block

Optional Parameters

None
Example URL/api/v1/api.php?target=ipam&action=getOptionsgetResourceHierarchy&id=125
Resource HierarchygetResourceHierarchy resource hierarchy

Examples:

{"successdata[{"id402name6connect Labz"}]ID of the IP blockgetResourceHierarchyGet VLAN

Get

VLAN

URL

/api/v1/api.php?target=ipam&action=

getVlan

Description

Returns the

VLAN for the block

Returns

Examples:

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
SUCCESSFUL
":"1","
permissionIPAMDelete":
"1","permissionSWIP":"
1","
permissionAdmin":"
1"},"range":"14.0.0.0 - 14.0.0.127","tags":["Customer"]}}
ERROR{'success':0, 'message':'error message'}
125
Required Parameters
NameTypeExampleDescription
id*INTEGER
125ID of the IP block
block*STRING213.37.29.0/24CIDR block.
*Either block or id can be used, but only one must be provided


Optional Parameters

None
Example URL/api/v1/api.php?target=ipam&action=
getVlan&id=125
getVlanReturns the VLAN for the blockFound VLAN 1002 (14.0.0.0\/25)1258153214002514002523488102423488115125128402402 Labz20150122 123037815321062"Test Notes""Datacenter2""Datacenter2"ATLAtlanta GA1002201501-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"]}}{'success':0, 'message':'error message'

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:

SUCCESSFUL{"success":1,"message":"
1 IPv4 and 0 IPv6 blocks would be moved to the available pool. ","data":[{"id":
77712,"type":"ipv4","top_aggregate":
77552,"cidr":"
23.
92.0.
64\/
26","formatted_ip":"
23.
92.0.
64\/
26","address":"
391905344","end_address":"
391905407","mask":
26,"netmask":"255.255.255.
192","child1":null,"child2":null,"is_assigned":0,"is_swipped":0,"is_aggregate":1,"custid":
188,"resource_id":
188,"resource_name":"6connect
holding","last_updated_time":"
2014-
10-
29 11:
25:
41","description":null,"parent":
77682,"rir":"ARIN","lir_id":"
451","notes":
null,"generic_code":
null,"code":
null,"region":"
PHX","region_name":"
Phoenix,
AZ","vlan":
null,"arin_net_id":null,"arin_cust_id":null,"org_id":null,"arin_swip_time":null,"assigned_time":"
2014-
ERROR
10-29 11:20:34","asn":null,"allowSubAssignments":false,"permissions":{"permissionIPAMRead":"1","permissionIPAMUpdate":"1","permissionIPAMCreate":"1","permissionIPAMDelete":"1","permissionSWIP":"1","permissionAdmin":"1"},"range":"23.92.0.64 - 23.92.0.127","tags":["Customer","DSL"]}]}
ERROR{'success':0, 'message':'error message'}
Required ParametersNone
Optional Parameters
NameTypeExampleDescription

preview

BOOLtrue

Shows what is going to be removed from the holding tank.

Acceptable values: "true" or "false"

Example URL/api/v1/api.php?target=ipam&action=processHoldingTank&preview=true

IPAM SWIP Calls:

id*125 IP *2133729 block.

Deassign

URL/api/v1/api.php?target=ipam&action=deassign
DescriptionPerforms a SWIP deassignment for the indicated IPAM block. 
Returns

Examples:

SUCCESSFUL{ "success":1,"message":"success message" }
ERROR { "success":0, "message":"error message" }


Required Parameters
NameTypeExampleDescription
blockIdINTEGER
1234ID of the
block to deassign
block
STRING
67.
221.
241.0/24the CIDR
of the block being de-assigned
resourceIdINTEGER1234ID of resource representing the customer to deassign
lirIdINTEGER1234The ProVision id of the LIR which is performing the de-assignment
entityHandleSTRINGCONNE-81The Org ID for the LIR.
Optional Parameters
NameTypeExampleDescription
netNameSTRING6CONN-67-221-241-0-24Optional 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=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
DescriptionReturns a list of all valid RIRs in the database.
Returns

Examples:

SUCCESSFUL{"success":1,"message":"RIRs Retrieved.","data":[{"value":"ARIN","name":"ARIN"},{"value":"1918","name":"1918"},{"value":"AfriNIC","name":"AfriNIC"},{"value":"APNIC","name":"APNIC"},{"value":"LACNIC","name":"LACNIC"},{"value":"RIPE","name":"RIPE"},{"value":"1918-SJC","name":"1918-SJC"}]}
ERROR{'success':0, 'message':'error message'}
*Either block or id can be used, but only one must be provided
NoneprocessHoldingTank&preview=true

Simple Reassign

URL/api/v1/api.php?target=ipam&action=simpleReassign
DescriptionARIN SWIP - simple reassign. Creates an ARIN customer record for the assigned resource and reassigns the block to the ARIN customer record.
Returns

Examples:

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" }


Required Parameters
NameTypeExampleDescription
blockIdINTEGER1234ID of the block to reassign
resourceIdINTEGER1234ID of resource representing the customer to reassign to
lirIdINTEGER1234The ProVision id of the LIR to use for reassignment
entityHandleSTRINGCONNE-81The Org ID for the LIR.

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:

SUCCESSFUL{"success":1,"message":"1 IPv4 and 0 IPv6 blocks would be moved to the available pool. ","data":[{"id":77712,"type":"ipv4","top_aggregate":77552,"cidr":"23.92.0.64\/26","formatted_ip":"23.92.0.64\/26","address":"391905344","end_address":"391905407","mask":26,"netmask":"255.255.255.192","child1":null,"child2":null,"is_assigned":0,"is_swipped":0,"is_aggregate":1,"custid":188,"resource_id":188,"resource_name":"6connect holding","last_updated_time":"2014-10-29 11:25:41","description":null,"parent":77682,"rir":"ARIN","lir_id":"451","notes":null,"generic_code":null,"code":null,"region":"PHX","region_name":"Phoenix, AZ","vlan":null,"arin_net_id":null,"arin_cust_id":null,"org_id":null,"arin_swip_time":null,"assigned_time":"2014-10-29 11:20:34","asn":null,"allowSubAssignments":false,"permissions":{"permissionIPAMRead":"1","permissionIPAMUpdate":"1","permissionIPAMCreate":"1","permissionIPAMDelete":"1","permissionSWIP":"1","permissionAdmin":"1"},"range":"23.92.0.64 - 23.92.0.127","tags":["Customer","DSL"]}]}
ERROR{'success':0, 'message':'error message'}
Required Parameters
Optional Parameters
NameTypeExampleDescription
previewnetNameBOOLtrue

Shows what is going to be removed from the holding tank.

Acceptable values: "true" or "false"

STRINGNET-ACME-67-221-244-0-28Optional 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=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. 

...