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

Validations:

  • Must be a String

location_id
optional

Scope by locations

Validations:

  • Must be a Integer

organization_id
optional

Scope by organizations

Validations:

  • Must be a Integer

search
optional

filter results

Validations:

  • Must be a String

order
optional

sort results

Validations:

  • Must be a String

page
optional

paginate results

Validations:

  • Must be a String

per_page
optional

number of entries per request

Validations:

  • Must be a 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.

show_hidden_parameters
optional

Display hidden parameter values

Validations:

  • Must be one of: true, false, 1, 0


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 a String

subnet[description]
optional , nil allowed

Subnet description

Validations:

  • Must be a String

subnet[network_type]
optional , nil allowed

Type or protocol, IPv4 or IPv6, defaults to IPv4

Validations:

  • Must be one of: IPv4, IPv6.

subnet[network]
required

Subnet network

Validations:

  • Must be a String

subnet[mask]
required

Máscara para esta subrede

Validations:

  • Must be a String

subnet[gateway]
optional , nil allowed

Primary DNS for this subnet

Validations:

  • Must be a String

subnet[dns_primary]
optional , nil allowed

Primary DNS for this subnet

Validations:

  • Must be a String

subnet[dns_secondary]
optional , nil allowed

Secondary DNS for this subnet

Validations:

  • Must be a String

subnet[ipam]
optional , nil allowed

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

Validations:

  • Must be a String

subnet[from]
optional , nil allowed

Starting IP Address for IP auto suggestion

Validations:

  • Must be a String

subnet[to]
optional , nil allowed

Ending IP Address for IP auto suggestion

Validations:

  • Must be a String

subnet[vlanid]
optional , nil allowed

VLAN ID for this subnet

Validations:

  • Must be a String

subnet[domain_ids]
optional , nil allowed

Dominios aos que pertence esta subrede

Validations:

  • Must be an array of any type

subnet[dhcp_id]
optional , nil allowed

DHCP Proxy ID to use within this subnet

Validations:

  • Must be a number.

subnet[tftp_id]
optional , nil allowed

TFTP Proxy ID to use within this subnet

Validations:

  • Must be a number.

subnet[dns_id]
optional , nil allowed

DNS Proxy ID to use within this subnet

Validations:

  • Must be a number.

subnet[boot_mode]
optional , nil allowed

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

Validations:

  • Must be a String

subnet[subnet_parameters_attributes]
optional , nil allowed

Array of parameters (name, value)

Validations:

  • Must be an array of any type

subnet[location_ids]
optional , nil allowed

REPLACE locations with given ids

Validations:

  • Must be an array of any type

subnet[organization_ids]
optional , nil allowed

REPLACE organizations with given ids.

Validations:

  • Must be an array of any type


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 a String

subnet[description]
optional , nil allowed

Subnet description

Validations:

  • Must be a String

subnet[network_type]
optional , nil allowed

Type or protocol, IPv4 or IPv6, defaults to IPv4

Validations:

  • Must be one of: IPv4, IPv6.

subnet[network]
optional

Subnet network

Validations:

  • Must be a String

subnet[mask]
optional

Máscara para esta subrede

Validations:

  • Must be a String

subnet[gateway]
optional , nil allowed

Primary DNS for this subnet

Validations:

  • Must be a String

subnet[dns_primary]
optional , nil allowed

Primary DNS for this subnet

Validations:

  • Must be a String

subnet[dns_secondary]
optional , nil allowed

Secondary DNS for this subnet

Validations:

  • Must be a String

subnet[ipam]
optional , nil allowed

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

Validations:

  • Must be a String

subnet[from]
optional , nil allowed

Starting IP Address for IP auto suggestion

Validations:

  • Must be a String

subnet[to]
optional , nil allowed

Ending IP Address for IP auto suggestion

Validations:

  • Must be a String

subnet[vlanid]
optional , nil allowed

VLAN ID for this subnet

Validations:

  • Must be a String

subnet[domain_ids]
optional , nil allowed

Dominios aos que pertence esta subrede

Validations:

  • Must be an array of any type

subnet[dhcp_id]
optional , nil allowed

DHCP Proxy ID to use within this subnet

Validations:

  • Must be a number.

subnet[tftp_id]
optional , nil allowed

TFTP Proxy ID to use within this subnet

Validations:

  • Must be a number.

subnet[dns_id]
optional , nil allowed

DNS Proxy ID to use within this subnet

Validations:

  • Must be a number.

subnet[boot_mode]
optional , nil allowed

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

Validations:

  • Must be a String

subnet[subnet_parameters_attributes]
optional , nil allowed

Array of parameters (name, value)

Validations:

  • Must be an array of any type

subnet[location_ids]
optional , nil allowed

REPLACE locations with given ids

Validations:

  • Must be an array of any type

subnet[organization_ids]
optional , nil allowed

REPLACE organizations with given ids.

Validations:

  • Must be an array of any type


DELETE /api/subnets/:id
Delete a subnet

Params

Param name Description
id
required

Subnet numeric identifier

Validations:

  • Must be a number.


GET /api/subnets/:id/freeip
Provides an unused IP address in this 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.

mac
optional

MAC address to reuse the IP for this host

Validations:

  • Must be a String

excluded_ips
optional

IP addresses that should be excluded from suggestion

Validations:

  • Must be an array of any type