GET /api/subnets
List of subnets

Params

Param Name Description
search
Optional

Filter results


Value: Must be String
order
Optional

Sort results


Value: Must be String
page
Optional

paginate results


Value: Must be String
per_page
Optional

number of entries per request


Value: Must be String

GET /api/subnets/:id
Show a subnet.

Params

Param Name Description
id
Required

Value: Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

POST /api/subnets
Create a subnet

Params

Param Name Description
subnet
Required

Value: Must be a Hash
subnet[name]
Required

子网名


Value: Must be String
subnet[network]
Required

Subnet network


Value: Must be String
subnet[mask]
Required

子网掩码


Value: Must be String
subnet[gateway]
Optional

Primary DNS for this subnet


Value: Must be String
subnet[dns_primary]
Optional

Primary DNS for this subnet


Value: Must be String
subnet[dns_secondary]
Optional

Secondary DNS for this subnet


Value: Must be String
subnet[ipam]
Optional

Enable IP Address auto suggestion for this subnet


Value: Must be 'true' or 'false'
subnet[from]
Optional

Starting IP Address for IP auto suggestion


Value: Must be String
subnet[to]
Optional

Ending IP Address for IP auto suggestion


Value: Must be String
subnet[vlanid]
Optional

VLAN ID for this subnet


Value: Must be String
subnet[domain_ids]
Optional

该部分子网的域名


Value: Must be an array of any type
subnet[dhcp_id]
Optional

本子网使用的DHCP代理


Value: Must be a number.
subnet[tftp_id]
Optional

TFTP Proxy to use within this subnet


Value: Must be a number.
subnet[dns_id]
Optional

本子网使用的域名代理


Value: Must be a number.

PUT /api/subnets/:id
Update a subnet

Params

Param Name Description
id
Required

Subnet numeric identifier


Value: Must be a number.
subnet
Required

Value: Must be a Hash
subnet[name]
Optional

子网名


Value: Must be String
subnet[network]
Optional

Subnet network


Value: Must be String
subnet[mask]
Optional

子网掩码


Value: Must be String
subnet[gateway]
Optional , <span class="translation_missing" title="translation missing: zh-CN.apipie.nil_allowed">Nil Allowed</span>

Primary DNS for this subnet


Value: Must be String
subnet[dns_primary]
Optional , <span class="translation_missing" title="translation missing: zh-CN.apipie.nil_allowed">Nil Allowed</span>

Primary DNS for this subnet


Value: Must be String
subnet[dns_secondary]
Optional , <span class="translation_missing" title="translation missing: zh-CN.apipie.nil_allowed">Nil Allowed</span>

Secondary DNS for this subnet


Value: Must be String
subnet[from]
Optional , <span class="translation_missing" title="translation missing: zh-CN.apipie.nil_allowed">Nil Allowed</span>

Starting IP Address for IP auto suggestion


Value: Must be String
subnet[to]
Optional , <span class="translation_missing" title="translation missing: zh-CN.apipie.nil_allowed">Nil Allowed</span>

Ending IP Address for IP auto suggestion


Value: Must be String
subnet[vlanid]
Optional , <span class="translation_missing" title="translation missing: zh-CN.apipie.nil_allowed">Nil Allowed</span>

VLAN ID for this subnet


Value: Must be String
subnet[domain_ids]
Optional , <span class="translation_missing" title="translation missing: zh-CN.apipie.nil_allowed">Nil Allowed</span>

该部分子网的域名


Value: Must be an array of any type
subnet[dhcp_id]
Optional , <span class="translation_missing" title="translation missing: zh-CN.apipie.nil_allowed">Nil Allowed</span>

本子网使用的DHCP代理


Value: Must be a number.
subnet[tftp_id]
Optional , <span class="translation_missing" title="translation missing: zh-CN.apipie.nil_allowed">Nil Allowed</span>

TFTP Proxy to use within this subnet


Value: Must be a number.
subnet[dns_id]
Optional , <span class="translation_missing" title="translation missing: zh-CN.apipie.nil_allowed">Nil Allowed</span>

本子网使用的域名代理


Value: Must be a number.

DELETE /api/subnets/:id
Delete a subnet

Params

Param Name Description
id
Required

Subnet numeric identifier


Value: Must be a number.