GET /api/subnets
List of subnets

GET /api/domains/:domain_id/subnets
List of subnets for a domain

GET /api/locations/:location_id/subnets
List of subnets per location

GET /api/organizations/:organization_id/subnets
List of subnets per organization

Params

Param name Description
domain_id
optional

ID of domain


Value:

Must be String

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

Subnet name


Value:

Must be String

subnet[network]
required

Subnet network


Value:

Must be String

subnet[mask]
required

Netmask for this subnet


Value:

Must be String

subnet[gateway]
optional , nil allowed

Primary DNS for this subnet


Value:

Must be String

subnet[dns_primary]
optional , nil allowed

Primary DNS for this subnet


Value:

Must be String

subnet[dns_secondary]
optional , nil allowed

Secondary DNS for this subnet


Value:

Must be String

subnet[ipam]
optional , nil allowed

IP Address auto suggestion mode for this subnet, valid values are “DHCP”, “Internal DB”, “None”


Value:

Must be String

subnet[from]
optional , nil allowed

Starting IP Address for IP auto suggestion


Value:

Must be String

subnet[to]
optional , nil allowed

Ending IP Address for IP auto suggestion


Value:

Must be String

subnet[vlanid]
optional , nil allowed

VLAN ID for this subnet


Value:

Must be String

subnet[domain_ids]
optional , nil allowed

Domains in which this subnet is part


Value:

Must be an array of any type

subnet[dhcp_id]
optional , nil allowed

DHCP Proxy to use within this subnet


Value:

Must be a number.

subnet[tftp_id]
optional , nil allowed

TFTP Proxy to use within this subnet


Value:

Must be a number.

subnet[dns_id]
optional , nil allowed

DNS Proxy to use within this subnet


Value:

Must be a number.

subnet[boot_mode]
optional , nil allowed

Default boot mode for interfaces assigned to this subnet, valid values are “Static”, “DHCP”


Value:

Must be String


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

Subnet name


Value:

Must be String

subnet[network]
optional

Subnet network


Value:

Must be String

subnet[mask]
optional

Netmask for this subnet


Value:

Must be String

subnet[gateway]
optional , nil allowed

Primary DNS for this subnet


Value:

Must be String

subnet[dns_primary]
optional , nil allowed

Primary DNS for this subnet


Value:

Must be String

subnet[dns_secondary]
optional , nil allowed

Secondary DNS for this subnet


Value:

Must be String

subnet[ipam]
optional , nil allowed

IP Address auto suggestion mode for this subnet, valid values are “DHCP”, “Internal DB”, “None”


Value:

Must be String

subnet[from]
optional , nil allowed

Starting IP Address for IP auto suggestion


Value:

Must be String

subnet[to]
optional , nil allowed

Ending IP Address for IP auto suggestion


Value:

Must be String

subnet[vlanid]
optional , nil allowed

VLAN ID for this subnet


Value:

Must be String

subnet[domain_ids]
optional , nil allowed

Domains in which this subnet is part


Value:

Must be an array of any type

subnet[dhcp_id]
optional , nil allowed

DHCP Proxy to use within this subnet


Value:

Must be a number.

subnet[tftp_id]
optional , nil allowed

TFTP Proxy to use within this subnet


Value:

Must be a number.

subnet[dns_id]
optional , nil allowed

DNS Proxy to use within this subnet


Value:

Must be a number.

subnet[boot_mode]
optional , nil allowed

Default boot mode for interfaces assigned to this subnet, valid values are “Static”, “DHCP”


Value:

Must be String


DELETE /api/subnets/:id
Delete a subnet

Params

Param name Description
id
required

Subnet numeric identifier


Value:

Must be a number.