Versions Compared

Old Version 25

changes.mady.by.user Unknown User (nalin)

Saved on

compared with

New Version 26

changes.mady.by.user Unknown User (nalin)

Saved on

Key

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

...

Update

URL/api/v1/api.php?target=ipam&action=update&type=IP&ipid=13420&rir=RIPE
DescriptionUpdates detail data about an IP block.
Returns

Examples:

SUCCESSFULSINGLE BLOCK{"success":1,"message":"Block 192.168.0.0/24 (12345) updated", "data":{ "id":12345, "cidr":192.168.0.0/24", ...} }
SUCCESSFULMULTIPLE 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
NameTypeExampleAllow MultipleDescription
idINTEGER125YesID of the IP block. Multiple block IDs can be specified in a comma-separated list.
blockSTRING192.0.0.0/24YesCIDR or the block. Multiple CIDRs can be specified in a comma-separated list.
Optional Parameters
NameTypeExampleDescription
allowSubAssignmentsBOOLtrueDoes 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"
asnINTEGER1000ASN for the block
codeSTRING Arbitrary user-defined block code
lirIdINTEGER The numeric ID of an LIR resource the block should be linked to
notesSTRINGWordsMisc. Notes
regionSTRINGChicago, ILThe region this IP block is assigned to.
rirSTRINGARINThe RIR
vlanNUMERIC50000 

Delete

URL/api/v1/api.php?target=ipam&action=delete&id=12345
DescriptionDeletes 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
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
forceBOOLtrueForces 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.

...

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
idint125ID of the IP block.
Optional Parameters
NameTypeExampleDescription
maskint24Auto aggregate the block back to this mask size. Note all blocks up this mask size must be Available or call will fail.
block*STRING213.37.29.0/24CIDR block. Only the block id OR the block CIDR can be specified. Not both.

...