You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 46
Next »
IP Address Management (IPv4 and IPv6)
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: | SUCCESSFUL | { "success": 1, "message": "1 blocks found. ", "data": [ { "id": 5890, "type": "ipv4", "top_aggregate": null, "cidr": "192.168.0.0\/24", "formatted_ip": "192.168.0.0\/24", "address": "3232235520", "end_address": "3232235775", "mask": 24, "child1": null, "child2": null, "is_assigned": 0, "is_swipped": 0, "is_aggregate": 1, "custid": 81, "resource_id": 81, "resource_name": "Available", "last_updated_time": null, "description": null, "parent": null, "rir": "1918", "lir_id": null, "notes": null, "generic_code": null, "code": null, "region": "SFO", "vlan": 100, "arin_net_id": null, "arin_cust_id": null, "org_id": null, "arin_swip_time": null, "assigned_time": null, "asn": null, "allowSubAssignments": false, "permissions": { "permissionIPAMRead": "1", "permissionIPAMUpdate": "1", "permissionIPAMCreate": "1", "permissionSWIP": "1", "permissionAdmin": "1" }, "range": "192.168.0.0 - 192.168.0.255", "tags": [ "Customer", "PTP" ] } ] } | | ERROR | {'success':0, 'message':'error message'} |
|
| Optional Parameters | | Name | Type | Example | Description |
|---|
| address | INTEGER | 1125449728 | IP address of the block in decimal format | | asn | INTEGER | 1000 | Filters blocks based on their ASN | | allowSubAssignments | BOOL | true | Filters blocks based on wether they allow sub-assignments or not. Acceptable values: "true" or "false" | | block | STRING | 213.37.29.0/24 | CIDR block description | | code | STRING | Code X | User-defined block code as defined in Admin-IPAM settings: Generic Code Per Block Name | | endAddress | INTEGER | 1125453823 | End IP address of the block in decimal format | | id | INTEGER | 1234 | The ID of the block | | isAggregate | BOOL | true | Indicates if the block has been split into children or not. A value of 'true' will return blocks with no children. | | isAssigned | BOOL | true | Acceptable values: "true" or "false" | | isSwipped | BOOL | true | Acceptable values: "true" or "false" | | lirId | INTEGER | 101 | The numeric ID of an LIR resource the block should be linked to | | mask | INTEGER | 24 | Integer bitmask | | region | STRING | SFO | The value from the list of name/value pairs which make up the list of available regions | | 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 | The ID of the resource the block is assigned 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. | | rir | STRING | ARIN | Acceptable values: ARIN, RIPE, APNIC, AfriNIC | | search | STRING | 192.168 | If a search term is provided, all IPAM fields including assigned Resource Holder name will be checked with a LIKE comparison to find matching blocks | | selectCount | INTEGER | 50 | # of blocks to get | | selectOffset | INTEGER | 25 | Offset for results set; useful for paging (e.g. selectCount = 50, selectOffset = 100 would return the 3rd page of 50 results) | | sortField | STRING | cidr | Attribute to sort blocks by. Accepable values: cidr, mask, rir, vlan, code, updateTime | | sortOrder | INTEGER | ASC | ASC or DESC | | tags | STRING | customer,vpn | Comma-separated list of tags | | tagsMode | STRING | "Strict" or "Exclude" | "strict" - matches ONLY blocks that have the EXACT set of tags of specified. "exclude" - matches ONLY blocks which are NOT tagged with any of the blocks specified. | | topAggregateId | INTEGER | 1234 | The ID of the aggregate block to which the block belongs | | type | STRING | "ipv4" or "ipv6" | IP type | | vlan | INTEGER | 123 | VLAN for the block |
|
| 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: | 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" } |
|
| Required Parameters | | Name | Type | Example | Description |
|---|
| block | STRING | 213.37.29.0/24 | CIDR block description | | rir | STRING | ARIN | Acceptable values: ARIN, RIPE, APNIC, AfriNIC |
|
| Optional Parameters | | 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 | Code X | User-defined block code as defined in Admin-IPAM settings: Generic Code Per Block Name | | 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 |
|
| 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: | SUCCESSFUL | SINGLE BLOCK | {"success":1,"message":"Block 192.168.0.0/24 (12345) updated", "data":{ "id":12345, "cidr":192.168.0.0/24", ...} } | | SUCCESSFUL | MULTIPLE BLOCKS | {"success":1,"message":"3 blocks updated", "data":[ { "id":12345, "cidr":192.168.0.0/24", ...}, {"id":12346, "cidr", "192.168.0.1/32", ...} ] } | | ERROR | | { "success":0, "message":"error message" } |
|
| | |
| Required Parameters | | Name | Type | Example | Allow Multiple | Description |
|---|
| id* | INTEGER | 125 | Yes | ID of the IP block. Multiple block IDs can be specified in a comma-separated list. | | block* | STRING | 192.0.0.0/24 | Yes | CIDR or the block. Multiple CIDRs can be specified in a comma-separated list. | | *Either block or id can be used, but only one must be provided |
|
| Optional Parameters | | Name | Type | Example | Description |
|---|
| 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 | Code X | Arbitrary user-defined block code | | lirId | INTEGER | 101 | The numeric ID of an LIR resource the block should be linked to | | notes | STRING | Words | Misc. Notes | | region | STRING | Chicago, IL | The region this IP block is assigned to. | | propagate | BOOL | true | Propagates all attribute values to any smaller child blocks of the block being updated. Available in version 5.1.0 | | rir | STRING | ARIN | The RIR | | tags | STRING | Customer, vpn | Comma-separated list of tags | | tags_action | STRING | replace | What action to take on the supplied tags. This action must be taken in conjunction with the tags parameter. Valid settings for tags_action are: replace, add, delete. When tags_action is set to 'replace', all tags on an IP block are replaced with those | | vlan | NUMERIC | 123 | VLAN for the block |
|
| 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 | SUCCESSFUL | {"success":1,"message":"Aggregate deleted: 192.168.0.0/24", "data":{ "id":12345, "cidr":192.168.0.0/24", ...} } | | ERROR | { "success":0, "message":"error message" } |
|
| Required Parameters | | Name | Type | Example | Description |
|---|
| block* | STRING | 213.37.29.0/24 | CIDR block description | | id* | INTEGER | 125 | ID of the IP block | | *Either block or id can be used, but only one must be provided |
|
| Optional Parameters | | Name | Type | Example | Description |
|---|
| force | BOOL | true | Forces the aggregate block to be deleted even if the block is split or contains sub blocks which are assigned. The default behavior is to reject attempts to delete blocks which have been split or are assigned. |
|
| 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=add |
| Description | Adds a tag to an IP block. |
| Returns | Examples: | SUCCESSFUL | { "success":1,"message":"Tag Added.", "data":{ "id":12345, "cidr":192.168.0.0/24", ...} } | | ERROR | { "success":0, "message":"error message" } |
|
| Required Parameters | | Name | Type | Example | Description |
|---|
| id* | INTEGER | 125 | ID of the block | | block* | STRING | 192.0.0.0/24 | CIDR of the block | | *Either block or id can be used, but only one must be provided | | tag | STRING | Customer | The tag to add |
|
| 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: | SUCCESSFUL | { "success":1,"message":"Tag Removed.", "data":{ "id":12345, "cidr":192.168.0.0/24", ...} } | | ERROR | { "success":0, "message":"error message" } |
|
| Required Parameters | | Name | Type | Example | Description |
|---|
| id* | INTEGER | 125 | ID of the block | | block* | STRING | 192.0.0.0/24 | CIDR of the block | | *Either block or id can be used, but only one must be provided | | tag | STRING | Customer | The tag to delete |
|
| 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, etc.) and assigns to an Resource Holder. |
| Returns | Examples: | SUCCESSFUL | { "success":1,"message":"Assigned 192.168.0.0/24 to Resource (1234) via Smart Assign", "id":12345, "data":{ "id":12345, "cidr":192.168.0.0/24", ...} } | | ERROR | { "success":0, "message":"error message" } |
|
| Required Parameters | | Name | Type | Example | Description |
|---|
| mask | INTEGER | 24 | The size of the block to be assigned | | rir | STRING | ARIN | Acceptable values: ARIN, RIPE, APNIC, AfriNIC | | 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 or resourceQuery can be used, but only one must be provided | | 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. | | type | STRING | "IPv4" or "IPv6" | The type of block to assign |
|
| Optional Parameters* | | Name | Type | Example | Description |
|---|
| assignedResourceId | INTEGER | 123 | The ID of the resource the block is assigned to | | 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 | | 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" or "exclude" | "strict" - matches ONLY blocks that have the EXACT set of tags of specified. "exclude" - matches ONLY blocks which are NOT tagged with any of the blocks specified. | | 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. |
| Example URL | /api/v1/api.php?target=ipam&action=smartAssign&mask=24&type=IPv4&resourceID=250&rir=ARIN |
Direct Assign |
|---|
| URL | /api/v1/api.php?target=ipam&action=directAssign |
| Description | Assigns a block to an Resource Holder |
| Returns | Examples: | SUCCESSFUL | SINGLE BLOCK | { "success":1,"message":"Assigned 192.168.0.0/24 to Resource (1234)", "id":12345, "data":{ "id":12345, "cidr":192.168.0.0/24", ...} } | | SUCCESSFUL | MULTIPLE BLOCKS | { "success":1,"message":"Assigned 5 blocks to Resource (1234) via Direct Assign", "data":{ "ids":[12345, 12346, 12347, ...] } } | | ERROR | | { "success":0, "message":"error message" } |
|
| Required Parameters | | Name | Type | Example | Description |
|---|
| block* | STRING | 213.37.29.0/24 | CIDR block description | | id* | INTEGER | 125 | ID of the IP block, comma separated list of ids, or json encoded array of ids | | *Either block or id can be used, but only one must be provided | | 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 |
|
| Optional Parameters* | | Name | Type | Example | Description |
|---|
| assignedResourceId | INTEGER | 123 | The ID of the resource the block is assigned to | | 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 | | 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" or "exclude" | "strict" - matches ONLY blocks that have the EXACT set of tags of specified. "exclude" - matches ONLY blocks which are NOT tagged with any of the blocks specified. | | 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. |
| 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: | 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 | | Name | Type | Example | Description |
|---|
| block* | STRING | 213.37.29.0/24 | CIDR block description | | id* | INTEGER | 125 | ID of the IP block | | *Either block or id can be used, but only one must be provided |
|
| 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 | 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 | | Name | Type | Example | Description |
|---|
| blockId | INTEGER | 1234 | ID of the block to reassing | | resourceId | INTEGER | 1234 | ID of resource representing the customer to reassign to | | lirId | INTEGER | 1234 | ID of the LIR to use for reassignment | | entityHandle | STRING | CONNE-81 | The Org ID for the LIR. |
|
| Optional Parameters | | Name | Type | Example | Description |
|---|
| 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=simpleReassign&resourceId=121&blockId=31559&lirId=95&entityHandle=CONNE-81&&netName=NET-ACME-67-221-244-0-28 |
|
|---|
| URL | /api/v1/api.php?target=ipam&action=getTagList |
| Description | Returns a list of all valid IP Tags in the database. |
| Returns | Examples: | SUCCESSFUL | {"success":1,"message":"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'} |
|
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: | 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'} |
|
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: | SUCCESSFUL | {"success":1,"message":"Regions Retrieved.","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'} |
|
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 | /api/v1/api.php?target=ipam&action=utilization&id=23131 |
| 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 | | Name | Type | Example | Description |
|---|
| block* | STRING | 213.37.29.0/24 | CIDR block description | | id* | INTEGER | 125 | ID of the IP block | | *Either block or id can be used, but only one must be provided |
|
| 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. |
|
| 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=getHostUtilization&tags=["Customer","PTP"]®ion=SMF |
| 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 | | Name | Type | Example | Description |
|---|
| type | STRING | "ipv4" or "ipv6" | IP type |
|
| Optional Parameters | | Name | Type | Example | Multiple Values | Description |
|---|
| code | STRING | "code-1" | Yes | User-defined block code as defined in Admin-IPAM settings: Generic Code Per Block Name | | region | STRING | "SFO" | Yes | Region to assign from | | rir | STRING | ARIN | No | Acceptable values: ARIN, RIPE, APNIC, AfriNIC | | tags | STRING | "Customer" | Yes | Comma separated string of tags | | vlan | INTEGER | 1000 | Yes | VLAN designated to a given block |
NOTE: to filter using multiple values, pass the values as a JSON-encoded string representation of an array. For example, to get utilization data for multiple tags, you could use the following URL: /api/v1/api.php?target=ipam&action=getHostUtilization&type=ipv4&tags=["Customer","PTP"] |
| Example URL | /api/v1/api.php?target=ipam&action=getHostUtilization&type=ipv4&tags=["Customer","PTP"] |
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 | | Name | Type | Example | Description |
|---|
| id | INTEGER | 125 | ID of the IP block. |
|
| Optional Parameters | | Name | Type | Example | Description |
|---|
| autoAggregateToMask | INTEGER | 24 | All blocks and IPs smaller than this netmask will be aggregated. | | block* | STRING | 213.37.29.0/24 | CIDR block. Only the block id OR the block CIDR can be specified. Not both. | ignoreAssignments | BOOL | TRUE | 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 URL | |
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: | 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}}
| | ERROR | {'success':0, 'message':'error message'} |
|
| Required Parameters | | Name | Type | Example | Description |
|---|
| id | INTEGER | 125 | ID of the IP block. |
|
| Optional Parameters | | Name | Type | Example | Description |
|---|
| block* | STRING | 213.37.29.0/24 | CIDR block. Only the block id OR the block CIDR can be specified. Not both. | | 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). |
|
| Example URL | |
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: | SUCCESSFUL | {"success":1,"message":"Ping scan started for 8.8.8.0\/27"} | | ERROR | {'success':0, 'message':'error message'} |
|
| Required Parameters | | Name | Type | Example | Description |
|---|
| id | INTEGER | 125 | ID of the IP block. |
|
| Optional Parameters | | Name | Type | Example | Description |
|---|
| block* | STRING | 213.37.29.0/24 | CIDR block. Only the block id OR the block CIDR can be specified. Not both. |
|
| Example | /api/v1/api.php?target=ipam&action=scanBlock&block=8.8.8.0/27 |
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: | SUCCESSFUL | {"success":1,"data":{"block":"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 message'} |
|
| Required Parameters | | Name | Type | Example | Description |
|---|
| 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 | /api/v1/api.php?target=ipam&action=getScanResults&block=8.8.8.0/27 |
