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 | | 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 |
|
Example URL | /api/v1/api.php?target=ipam&action=add&rir=ARIN |