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

filtrar resultados


Value: Must be String
order
Optional

ordenar resultados


Value: Must be String
page
Optional

paginar resultados


Value: Must be String
per_page
Optional

número de entradas por requisições


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
Criar uma subrete

Params

Param Name Description
subnet
Required

Value: Must be a Hash
subnet[name]
Required

Nome da subnet


Value: Must be String
subnet[network]
Required

Subnet network


Value: Must be String
subnet[mask]
Required

Mascara de rede para esta sub rede


Value: Must be String
subnet[gateway]
Optional , <span class="translation_missing" title="translation missing: pt-BR.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: pt-BR.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: pt-BR.apipie.nil_allowed">Nil Allowed</span>

Secondary DNS for this subnet


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

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


Value: Must be String
subnet[from]
Optional , <span class="translation_missing" title="translation missing: pt-BR.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: pt-BR.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: pt-BR.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: pt-BR.apipie.nil_allowed">Nil Allowed</span>

Domínios em que essa subrede faz parte


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

Proxy DHCP para usar dentro dessa subrede


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

TFTP Proxy para utilizar com esta subrede


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

Proxy DNS para usar dentro dessa subrede


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

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

Nome da subnet


Value: Must be String
subnet[network]
Optional

Subnet network


Value: Must be String
subnet[mask]
Optional

Mascara de rede para esta sub rede


Value: Must be String
subnet[gateway]
Optional , <span class="translation_missing" title="translation missing: pt-BR.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: pt-BR.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: pt-BR.apipie.nil_allowed">Nil Allowed</span>

Secondary DNS for this subnet


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

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


Value: Must be String
subnet[from]
Optional , <span class="translation_missing" title="translation missing: pt-BR.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: pt-BR.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: pt-BR.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: pt-BR.apipie.nil_allowed">Nil Allowed</span>

Domínios em que essa subrede faz parte


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

Proxy DHCP para usar dentro dessa subrede


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

TFTP Proxy para utilizar com esta subrede


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

Proxy DNS para usar dentro dessa subrede


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

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


Value: Must be String

DELETE /api/subnets/:id
Apagar uma subrede

Params

Param Name Description
id
Required

Subnet numeric identifier


Value: Must be a number.