GET /api/subnets
List of subnets

Params

Param name Description
search
optional

Filter results

Validations:

  • Must be String

order
optional

Sort results

Validations:

  • Must be String

page
optional

paginate results

Validations:

  • Must be String

per_page
optional

number of entries per request

Validations:

  • Must be String


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

Params

Param name Description
id
required

Validations:

  • 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

Validations:

  • Must be a Hash

subnet[name]
required

Subnet name

Validations:

  • Must be String

subnet[network_type]
optional

Type or protocol, IPv4 or IPv6, defaults to IPv4

Validations:

  • Must be one of: IPv4, IPv6.

subnet[network]
required

Subnet network

Validations:

  • Must be String

subnet[mask]
required

Netmask for this subnet

Validations:

  • Must be String

subnet[gateway]
optional

Primary DNS for this subnet

Validations:

  • Must be String

subnet[dns_primary]
optional

Primary DNS for this subnet

Validations:

  • Must be String

subnet[dns_secondary]
optional

Secondary DNS for this subnet

Validations:

  • Must be String

subnet[ipam]
optional

Enable IP Address auto suggestion for this subnet

Validations:

  • Must be 'true' or 'false' or '1' or '0'

subnet[from]
optional

Starting IP Address for IP auto suggestion

Validations:

  • Must be String

subnet[to]
optional

Ending IP Address for IP auto suggestion

Validations:

  • Must be String

subnet[vlanid]
optional

VLAN ID for this subnet

Validations:

  • Must be String

subnet[domain_ids]
optional

Domains in which this subnet is part

Validations:

  • Must be an array of any type

subnet[dhcp_id]
optional

DHCP Proxy to use within this subnet

Validations:

  • Must be a number.

subnet[tftp_id]
optional

TFTP Proxy to use within this subnet

Validations:

  • Must be a number.

subnet[dns_id]
optional

DNS Proxy to use within this subnet

Validations:

  • Must be a number.


PUT /api/subnets/:id
Update a subnet

Params

Param name Description
id
required

Subnet numeric identifier

Validations:

  • Must be a number.

subnet
required

Validations:

  • Must be a Hash

subnet[name]
optional

Subnet name

Validations:

  • Must be String

subnet[network]
optional

Subnet network

Validations:

  • Must be String

subnet[mask]
optional

Netmask for this subnet

Validations:

  • Must be String

subnet[gateway]
optional , nil allowed

Primary DNS for this subnet

Validations:

  • Must be String

subnet[dns_primary]
optional , nil allowed

Primary DNS for this subnet

Validations:

  • Must be String

subnet[dns_secondary]
optional , nil allowed

Secondary DNS for this subnet

Validations:

  • Must be String

subnet[from]
optional , nil allowed

Starting IP Address for IP auto suggestion

Validations:

  • Must be String

subnet[to]
optional , nil allowed

Ending IP Address for IP auto suggestion

Validations:

  • Must be String

subnet[vlanid]
optional , nil allowed

VLAN ID for this subnet

Validations:

  • Must be String

subnet[domain_ids]
optional , nil allowed

Domains in which this subnet is part

Validations:

  • Must be an array of any type

subnet[dhcp_id]
optional , nil allowed

DHCP Proxy to use within this subnet

Validations:

  • Must be a number.

subnet[tftp_id]
optional , nil allowed

TFTP Proxy to use within this subnet

Validations:

  • Must be a number.

subnet[dns_id]
optional , nil allowed

DNS Proxy to use within this subnet

Validations:

  • Must be a number.


DELETE /api/subnets/:id
Delete a subnet

Params

Param name Description
id
required

Subnet numeric identifier

Validations:

  • Must be a number.