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. del domini


Value:

Must be String

search
Optional

filtra els resultats


Value:

Must be String

order
Optional

ordena els resultats


Value:

Must be String

page
Optional

pagina els resultats


Value:

Must be String

per_page
Optional

Nombre d'entrades per petició


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

Nom de la subxarxa


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 , <span class="translation_missing" title="translation missing: ca.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: ca.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: ca.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: ca.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: ca.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: ca.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: ca.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: ca.apipie.nil_allowed">Nil Allowed</span>

Domains in which this subnet is part


Value:

Must be an array of any type

subnet[dhcp_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

DHCP Proxy to use within this subnet


Value:

Must be a number.

subnet[tftp_id]
Optional , <span class="translation_missing" title="translation missing: ca.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: ca.apipie.nil_allowed">Nil Allowed</span>

DNS Proxy to use within this subnet


Value:

Must be a number.

subnet[boot_mode]
Optional , <span class="translation_missing" title="translation missing: ca.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

Identificador numèric de subxarxa


Value:

Must be a number.

subnet
Required

Value:

Must be a Hash

subnet[name]
Optional

Nom de la subxarxa


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 , <span class="translation_missing" title="translation missing: ca.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: ca.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: ca.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: ca.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: ca.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: ca.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: ca.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: ca.apipie.nil_allowed">Nil Allowed</span>

Domains in which this subnet is part


Value:

Must be an array of any type

subnet[dhcp_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

DHCP Proxy to use within this subnet


Value:

Must be a number.

subnet[tftp_id]
Optional , <span class="translation_missing" title="translation missing: ca.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: ca.apipie.nil_allowed">Nil Allowed</span>

DNS Proxy to use within this subnet


Value:

Must be a number.

subnet[boot_mode]
Optional , <span class="translation_missing" title="translation missing: ca.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
Suprimeix una subxarxa

Params

Param Name Description
id
Required

Identificador numèric de subxarxa


Value:

Must be a number.