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 | | 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. |
|
| Optional Parameters | | Name | Type | Example | Description |
|---|
| code | STRING | "code-1" | Arbitrary user-defined block code | | region | STRING | "SFO" | Region to assign from | | 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 | vlan | INT | 1000 | |
|
| Example URL | /api/v1/api.php?target=ipam&action=directAssign&block=213.37.29.0/24&resourceHolderId=SJS-0031 |
