Search IPAM Subnets (SearchIPAMSubnets)
(Nectus Version: 1.69.0)
Search IPAM Subnets
URL
https://{ServerName}/ipam/restAPI/searchIPAMSubnets
ServerName is the FQDN of the server where Nectus is deployed.
Method
GET
Request Parameters
Header
Header should contain an authorization token.
| Parameter | Description | Type | Required | Default Value |
|---|---|---|---|---|
| token | Authorization token | 1 | 1 |
Payload/Data Parameters
| Parameter | Description | Type | Required | Default Value |
|---|---|---|---|---|
| Subnet | subnet | String | Optional | |
| mask_bits | Mask | Integer | Optional | |
| type | Type. Possible values: static or dhcp | String | Optional | |
| name | Name | String | Optional | |
| container_path | Container | String | Optional | |
| status | Status. Possible values: '', 'available', ''in-use", "reserved" | String | Optional | |
| profile | Subnet Profile | String | Optional | |
| vrf | IPAM VRF | String | Optional | |
| customer | Customer | String | Optional | |
| device_a | Hosting Network Device A | String | Optional | |
| device_b | Hosting Network Device B | String | Optional | |
| vlan | VLAN | Integer | Optional | |
| pci | PCI. Possible values: 'yes', 'no' | String | Optional | |
| gateway | Default Gateway | String | Optional | |
| change_request_id | Change Request ID | String | Optional | |
| description | Description | String | Optional |
Response Parameters
For list of common errors, kindly refer to section Response and Error Codes.
Usage Example
