Page History

...

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

Delete

Update

URL

/api/v1/api.php?target=ipam&action=update&type=IP&ipid=13420&rir=RIPE

Description

Updates detail data about an IP block.

Returns

Examples:

SUCCESSFUL	SINGLE BLOCK	{"success":1,"message":"Block 192.168.0.0/24 (12345) updated", "data":{ "id":12345, "cidr":192.168.0.0/24", ...} }
SUCCESSFUL	MULTIPLE 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

Name	Type	Example	Allow Multiple	Description
id	INTEGER	125	Yes	ID of the IP block. Multiple block IDs can be specified in a comma-separated list.
block	STRING	192.0.0.0/24	Yes	CIDR or the block. Multiple CIDRs can be specified in a comma-separated list.

Optional Parameters

Name	Type	Example	Description
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		Arbitrary user-defined block code
lirId	INTEGER		The numeric ID of an LIR resource the block should be linked to
notes	STRING	Words	Misc. Notes
region	STRING	Chicago, IL	The region this IP block is assigned to.
rir	STRING	ARIN	The RIR
vlan	NUMERIC	123
propagate	BOOL	true	Propagates all attribute values to any smaller child blocks of the block being updated. *Available in version 5.1.0*

rir	STRING	ARIN	The RIR
tags	STRING	Customer, vpn	Comma-separated list of tags
tags_action	STRING	replace	What action to take on the supplied tags. This action must be taken in conjunction with the tags parameter. Valid settings for tags_action are: replace, add, delete. When tags_action is set to 'replace', all tags on an IP block are replaced with those
vlan	NUMERIC	123	VLAN for the block

Delete

URL

/api/v1/api.php?target=ipam&action=delete&id=12345

Description

Deletes an aggregate block

Returns

Examples

SUCCESSFUL

{"success":

URL

/api/v1/api.php?target=ipam&action=delete&id=12345

Description

Deletes 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

Name	Type	Example	Description
block*	STRING	213.37.29.0/24	CIDR block description
id*	INTEGER	125	ID of the IP block
*Either block or id can be used, but only one must be provided

Optional Parameters

Name	Type	Example	Description
force	BOOL	true	Forces 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.

...

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,"message":"Assigned 192.168.0.0/24 to Resource (1234) via Smart Assign", "id":12345, "data":{ "id":12345, "cidr":192.168.0.0/24", ...}* }*
ERROR	{ "success":0, "message":"error message" }

Required Parameters

Name	Type	Example	Description
code	STRING	Code X	Arbitrary user-defined block code
mask	INTEGER	24	The size of the block to be assigned
lirId	INTEGER	101	The ID of an LIR resource
rir	STRING	ARIN	Acceptable values: ARIN, RIPE, APNIC, AfriNIC
resourceId*	INTEGER	1234	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" or "IPv6"	The type of block to assign

Optional Parameters

Name	Type	Example	Description
assignedResourceId	INTEGER	123	The ID of the resource the block is assigned to
tags	STRING	customer,vpn	Comma separated string of tags. Matches blocks which have at least the set of tag specified by this parameter
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.
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
vlan	INTEGER	1023	VLAN designated to a given block

Example URL

/api/v1/api.php?target=ipam&action=smartAssign&mask=24&resourceHolderId=SJS-0031&rir=ARIN&tags=customer,vpn

Region to assign from

Direct Assign

URL

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

Description

Assigns a block to an Resource Holder

Returns

Examples:

SUCCESSFUL	SINGLE BLOCK	{ "success":1,"message":"Assigned 192.168.0.0/24 to Resource (1234)", "id":12345, "data":{ "id":12345, "cidr":192.168.0.0/24", ...}* }*
SUCCESSFUL	MULTIPLE BLOCKS	{ "success":1,"message":"Assigned 5 blocks to Resource (1234) via Direct Assign", "data":{ "ids":[12345, 12346, 12347, ...] }* }*
ERROR		{ "success":0, "message":"error message" }

Required Parameters

*Either block or id can be used, but only one must be provided

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
code	STRING	"code-1"	User-defined block code as defined in Admin-IPAM settings: Generic Code Per Block Name
lirId	INTEGER	105	The numeric ID of an LIR resource the block should be linked to
region	STRING	"SFO"	Region to assign from
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	1234	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.

Optional Parameters

Name

Type

Example

Description

code

STRING

"code-1"

Arbitrary user-defined block code

region

STRING

"SFO"

rir	STRING	ARIN	Acceptable values: ARIN, RIPE, APNIC, AfriNIC
tags	STRING	"Customer"	Comma separated string of tags
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.
vlan	INTEGER	1023	VLAN designated to a given block

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 41

New Version 42

Key

Add

Update

Delete

Smart Assign

Direct Assign