| Returns | Examples: | SUCCESSFUL | { "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'} |
|
| Optional Parameters | | Name | Type | Example | Description |
|---|
| address | INTEGER | 1125449728 | IP address of the block in decimal format | | asn | INTEGER | 1000 | Filters blocks based on their ASN | | allowSubAssignments | BOOL | true | Filters blocks based on wether they allow sub-assignments or not. Acceptable values: "true" or "false" | | block | STRING | 213.37.29.0/24 | CIDR block description | | code | STRING | Code X | User-defined block code as defined in Admin-IPAM settings: Generic Code Per Block Name | | endAddress | INTEGER | 1125453823 | End IP address of the block in decimal format | | id | INTEGER | 1234 | The ID of the block | | isAggregate | BOOL | true | Indicates if the block has been split into children or not. A value of 'true' will return blocks with no children. | | isAssigned | BOOL | true | Acceptable values: "true" or "false" | | isSwipped | BOOL | true | Acceptable values: "true" or "false" | | lastUpdateTime | DATETIME | =2015-8-19 21:08:54 | SQL Datetime format, prefaced by an "=" for exact time updated, "=﹥" for blocks updated after the given time, or "=﹤" for blocks updated before the given time. | | lirId | INTEGER | 101 | The numeric ID of an LIR resource the block should be linked to | | mask | INTEGER | 24 | Integer bitmask | | region | STRING | SFO | The value from the list of name/value pairs which make up the list of available regions | | resourceHolderId | STRING | cust-001 | (Deprecated: Use resourceQuery instead) A custom ID which can be used to link resources in the 6Connect database back to your organization. | | resourceId | INTEGER | 1234 | The ID of the resource the block is assigned to | | resourceQuery | JSON | {"parent_id":15} | A JSON object representing a valid resource query. Any parameters that can be used for a Resource GET API call can be used. Use of the resourceQuery parameter will return blocks assigned to any of the resources returned by that query. | | rir | STRING | ARIN | Acceptable values: ARIN, RIPE, APNIC, AfriNIC, LACNIC, 1918 | | search | STRING | 192.168 | If a search term is provided, all IPAM fields including assigned Resource Holder name will be checked with a LIKE comparison to find matching blocks | | selectCount | INTEGER | 50 | # of blocks to get | | selectOffset | INTEGER | 25 | Offset for results set; useful for paging (e.g. selectCount = 50, selectOffset = 100 would return the 3rd page of 50 results) | | sortField | STRING | cidr | Attribute to sort blocks by. Accepable values: cidr, mask, rir, vlan, code, updateTime | | sortOrder | INTEGER | ASC | ASC or DESC | | tags | STRING | customer,vpn | Comma-separated list of tags to filter by. If used in conjunction with 'search', performs the search operation and then filters results by the provided tag. | | tagsMode | STRING | "Strict" or "Exclude" | "strict" - matches ONLY blocks that have the EXACT set of tags of specified. "exclude" - matches ONLY blocks which are NOT tagged with any of the blocks specified. | | topAggregateId | INTEGER | 1234 | The ID of the aggregate block to which the block belongs | | type | STRING | "ipv4" or "ipv6" | IP type | | vlan | INTEGER | 123 | VLAN for the block |
|
