Page History

...

Get

URL

/api/v1/api.php?target=ipam&action=get

Description

Returns 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:

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

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

User-defined block code as defined in Admin-IPAM settings: Generic Code Per Block Name

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"

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

6c-1234

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

The ID of the resource the block is assigned to

resourceQuery

JSON

Code Block
{"custom_id":"cust-001"}

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

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

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

Name	Type	Example	Description
code	STRING	Code X	Arbitrary user-defined block code
mask	INTEGER		The size of the block to be assigned
rir	STRING	ARIN	Acceptable values: ARIN, RIPE, APNIC, AfriNIC
resourceId*	INTEGER		Integer ID of the resource to assign the block to
resourceHolderId	STRING	6c-1234	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.
resourceQuery	JSON	{"custom_id":"cust-001"}	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.
type	STRING	"IPv4"	type	STRING	"IPv4" or "IPv6"	The type of block to assign
*Either resourceHolderId or resourceId can be used, but only one must be provided

Optional Parameters

Name	Type	Example	Description
tags	STRING	customer,vpn	Comma separated string of tags
region	STRING	Ashburn	Region to assign from
assignedToResource	INTEGER	1234	Used to Smart Assign out of a block which is already assigned to another resource and allows sub assignment

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: {'success':1, 'message':'213.37.29.0/24 assigned to SJS-0031', 'id':'12345'}

SUCCESSFUL Multiple Assignments: {"success":1,"message":"Assigned 3 blocks to Worcester Telegram & Gazette","data":{"ids":[10001,10021 ,10031]}}

ERROR: {'success':0, 'message':'Unable to assign block'}

Required Parameters

Name	Type	Example	Description
block*	STRING	213.37.29.0/24	CIDR block description
id*	INTEGER	125	ID of the IP block, comma separated list of ids, or json encoded array of ids
*Either block or id can be used, but only one must be provided
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
resourceQuery	JSON	{"custom_id":"cust-001"}	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.
*Either resourceHolderId or resourceId can be used, but only one must be provided

Example URL /api/v1/api.php?target=ipam&action=directAssign&block=213.37.29.0/24&resourceHolderId=SJS-0031

...

Page tree

Versions Compared

Old Version 18

New Version 19

Key

Get

Smart Assign

Direct Assign