Versions Compared

Old Version 3

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

Saved on

compared with

New Version 4

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

Saved on

Key

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

...

Acceptable values are "IP" or "IPv6"
Get
URL/api/v1/api.php?target=ipam&action=get
DescriptionReturns 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:

NameTypeExampleDescription
typeSTRINGIP
SUCCESSFUL{'success':1, 'message':'1 block found', 'data': [{"id":"14035", "oct1":"67", "oct2":"221", "oct3":"241", "oct4":"0", "mask":"24", "child1":null, "child2":null, "is_assigned":"1", "is_swipped":null, "is_aggregate":"1", "custid":"1024", "last_updated_time":"2012-04-19 16:45:01", "description":null, "parent":1034, "rir":"ARIN", "notes":null, "generic_code":"Code X", "region":"SFO", "vlan":100, "arin_net_id":null, "arin_cust_id":null, "arin_swip_time":"2012-04-13 17:49:27", "assigned_time":"2012-04-19 16:45:01"}]
                  {
  "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'}
Required Parameters
message':'error message'}
Optional Parameters
NameTypeExampleDescription
asnINTEGER1000Filters blocks based on their ASN
allowSubAssignmentsBOOLtrueFilters blocks based on wether they allow sub-assignments or not. Acceptable values: "true" or "false"
blockSTRING213.37.29.0/24CIDR block description
codeSTRING User-defined block code as defined in Admin-IPAM settings: Generic Code Per Block Name
idINTEGER1234The ID of the block
isAggregateBOOLtrueIndicates if the block has been split into children or not. A value of 'true' will return blocks with no children.
isAssignedBOOLtrueAcceptable values: "true" or "false"
isSwippedBOOLtrueAcceptable values: "true" or "false"
maskINTEGER24Integer bitmask
regionSTRINGSFOThe value from the list of name/value pairs which make up the list of available regions
resourceHolderIdSTRING6c-1234The 20 character resource holder ID. This is an internal short identifier for the customer, and should be used to link resource holder details in the 6Connect database back to your organization. Consider using internal customer numbers or department numbers for this field depending on your use case. Example: Customer-001 or 000213.
resourceIdINTEGER The ID of the resource the block is assigned to
rirSTRINGARINAcceptable values: ARIN, RIPE, APNIC, AfriNIC
searchSTRING192.168If a search term is provided, all IPAM fields including assigned Resource Holder name will be checked with a LIKE comparison to find matching blocks
selectCountINTEGER50# of blocks to get
selectOffsetINTEGER25Offset for results set; useful for paging (e.g. selectCount = 50, selectOffset = 100 would return the 3rd page of 50 results)
sortFieldSTRINGcidrAttribute to sort blocks by. Accepable values: cidr, mask, rir, vlan, code, updateTime
sortOrderINTEGERASCASC or DESC
tagsSTRINGcustomer,vpnComma-separated list of tags
topAggregateIdINTEGER1234The ID of the aggregate block to which the block belongs
vlanINTEGER123VLAN 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
DescriptionAdds an IPv4 or IPv6 block
ReturnsExamples:
SUCCESSFUL: {'success':1, 'id':'12345'}
ERROR: {'success':0, 'message':'unable to add block'}>
Required Parameters
NameTypeExampleDescription
blockSTRING213.37.29.0/24CIDR block description
rirSTRINGARINAcceptable values: ARIN, RIPE, APNIC, AfriNIC
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 User-defined block code as defined in Admin-IPAM settings: Generic Code Per Block Name
notesSTRING Notes or description for the block
regionSTRINGSFOThe value from the list of name/value pairs which make up the list of available regions
tagsSTRINGcustomer,vpnComma-separated list of tags
vlanINTEGER123VLAN for the block
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
DescriptionUpdates detail data about an IP block.
Returns

Examples:

SUCCESSFUL{"success":1,"message":"Update Successful."}
ERROR{'success':0, 'message':'error message'}
Required Parameters
NameTypeExampleDescription
idint125ID of the IP block
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
notesSTRINGWordsMisc. Notes
regionSTRINGChicago, ILThe region this IP block is assigned to.
rirSTRINGARINThe RIR
vlanNUMERIC50000 

...

Smart Assign
URL/api/v1/api.php?target=ipam&action=smartAssign
DescriptionSelects a block based on supplied parameters (rir, tags, etc.) and assigns to an Resource Holder.
ReturnsExamples:
SUCCESSFUL: {'success':1, 'id':'12345'}
ERROR: {'success':0, 'message':'Unable to assign block'}
Required Parameters

24

NameTypeExampleDescription
codeSTRINGCode XArbitrary user-defined block code
maskINTEGER The size of the block to be assigned
rirSTRINGARINAcceptable values: ARIN, RIPE, APNIC, AfriNIC
resourceHolderId*STRING The 20 character resource holder ID. This is an internal short identifier for the customer, and should be used to link resource holder details in the 6Connect database back to your organization. Consider using internal customer numbers or department numbers for this field depending on your use case. Example: Customer-001 or 000213.
resourceId*INTEGER Integer ID of the resource to assign the block to
typeSTRING"IPv4" or "IPv6"The type of block to assign
*Either resourceHolderId or resourceId can be used, but only one must be provided
Optional Parameters
NameTypeExampleDescription
tagsSTRINGcustomer,vpnComma separated string of tags
regionSTRINGAshburnRegion to assign from
Example URL/api/v1/api.php?target=ipam&action=smartAssign&mask=24&resourceHolderId=SJS-0031&rir=ARIN&tags=customer,vpn

...