Smart Assign |
|---|
| URL | /api/v1/api.php?target=ipam&action=smartAssign |
| Description | Selects a block based on supplied parameters (rir, tags, mask size, etc.) and assigns it to an a 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 |
|---|
| mask | INTEGER | 24 | The size of the block to be assigned | | rir | STRING | ARIN | Acceptable values: ARIN, RIPE, APNIC, AfriNIC, LACNIC, 1918 | | 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. | | *Either resourceId or resourceQuery can be used, but only one must be provided | | 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. | | 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 | | code | STRING | Code X | Arbitrary user-defined block code | | lirId | INTEGER | 101 | The ID of an LIR resource | | region | STRING | Ashburn | Region to assign from | | 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. | | vlan | INTEGER | 1023 | VLAN designated to a given block |
*Additional or fewer "optional" parameters may be required in order to result in a successful assignment, depending on the attributes of available blocks. |
| Example URL | /api/v1/api.php?target=ipam&action=smartAssign&mask=24&type=IPv4&resourceID=250&rir=ARIN |
