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:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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: SUCCESSFUL: {'success':1, 'id':'12345'} ERROR: {'success':0, 'message':'unable to add block'}> | ||||||||||||||||||||||||||||||||
Required Parameters |
| ||||||||||||||||||||||||||||||||
Optional Parameters |
| ||||||||||||||||||||||||||||||||
Example URL | /api/v1/api.php?target=ipam&action=add&rir=ARIN |
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 |
|
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 |
|
Delete Tag | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=ipam&action=deleteTag&id=13420&tag=Prod | ||||||||||||
Description | Removes a tag from an IP block. | ||||||||||||
Returns | Examples:
| ||||||||||||
Required Parameters |
|
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, 'id':'12345'} ERROR: {'success':0, 'message':'Unable to assign block'} | ||||||||||||||||||||||||||||||||
Required Parameters | 24
| ||||||||||||||||||||||||||||||||
Optional Parameters |
| ||||||||||||||||||||||||||||||||
Example URL | /api/v1/api.php?target=ipam&action=smartAssign&mask=24&resourceHolderId=SJS-0031&rir=ARIN&tags=customer,vpn |
Direct Assign | |||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=ipam&action=directAssign | ||||||||||||||||||||||||||||
Description | Assigns a block to an Resource Holder | ||||||||||||||||||||||||||||
Returns | Examples: SUCCESSFUL: {'success':1, 'message':'213.37.29.0/24 assigned to SJS-0031', 'id':'12345'} ERROR: {'success':0, 'message':'Unable to assign block'} | ||||||||||||||||||||||||||||
Required Parameters |
| ||||||||||||||||||||||||||||
Example URL | /api/v1/api.php?target=ipam&action=directAssign&block=213.37.29.0/24&resourceHolderId=SJS-0031 |
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':'213.37.29.0/24 unassigned', 'id':'12345'} ERROR: {'success':0, 'message':'213.37.29.0/24 was not found'} | ||||||||||||||||
Required Parameters |
| ||||||||||||||||
Example URL | /api/v1/api.php?target=ipam&action=unassign&block=213.37.29.0/24 |
getTagList | |||||
---|---|---|---|---|---|
URL | /api/v1/api.php?target=ipam&action=getTagList | ||||
Description | Returns a list of all valid IP Tags in the database. | ||||
Returns | Examples:
|
getRIRList | |||||
---|---|---|---|---|---|
URL | /api/v1/api.php?target=ipam&action=getRIRList | ||||
Description | Returns a list of all valid RIRs in the database. | ||||
Returns | Examples:
|
getRegionList | |||||
---|---|---|---|---|---|
URL | /api/v1/api.php?target=ipam&action=getRegionList | ||||
Description | Returns a list of all valid Regions in the database. | ||||
Returns | Examples:
|
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 |
|