...
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 Multiple Assignments: 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 |
...
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=aggregateutilization&id=23131 | ||||||||||||
Returns | Examples:
| ||||||||||||
Required Parameters |
| ||||||||||||
Optional 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 |
|
...