Subnets

>>>

GET /api/subnets
Lijst van subnets

GET /api/domains/:domain_id/subnets
Lijst van subnets voor een domein

GET /api/locations/:location_id/subnets
Lijst van subnets voor een lokatie

GET /api/organizations/:organization_id/subnets
Lijst van subnets voor een organisatie

Params

Param Name Description
domain_id
Optional

ID van het domein

Validations:

  • Must be a String
location_id
Optional

Scope met locaties

Validations:

  • Must be a Integer
organization_id
Optional

Scope met organisaties

Validations:

  • Must be a Integer
search
Optional

filter resultaten

Validations:

  • Must be a String
order
Optional

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String
page
Optional

Page number, starting at 1

Validations:

  • Must be a number.
per_page
Optional

Number of results per page to return

Validations:

  • Must be a number.

Search fields

Field name Type Possible values
boot_mode
dns_primary
dns_secondary
domain
gateway
ipam
location
location_id
mask
mtu
name
network
nic_delay
organization
organization_id
params string
type
vlanid
>>>

GET /api/subnets/:id
Toon een subnet

Params

Param Name Description
location_id
Optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
Optional

Set the current organization context for the request

Validations:

  • Must be a Integer
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
Maak een subnet

Params

Param Name Description
location_id
Optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
Optional

Set the current organization context for the request

Validations:

  • Must be a Integer
subnet
Required

Validations:

  • Must be a Hash
subnet[name]
Required

Subnet naam

Validations:

  • Must be a String
subnet[description]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Subnet beschrijving

Validations:

  • Must be a String
subnet[network_type]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Type of protocol, IPv4 of IPV6, standaard is IPv4

Validations:

  • Must be one of: IPv4, IPv6.
subnet[network]
Required

Subnet netwerk

Validations:

  • Must be a String
subnet[cidr]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Network prefix in CIDR notation

Validations:

  • Must be a String
subnet[mask]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Netmask voor dit subnet

Validations:

  • Must be a String
subnet[gateway]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Subnet gateway

Validations:

  • Must be a String
subnet[dns_primary]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Primaire DNS voor dit subnet

Validations:

  • Must be a String
subnet[dns_secondary]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Secundaire DNS voor dit subnet

Validations:

  • Must be a String
subnet[ipam]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

IP Address auto suggestion mode for this subnet.

Validations:

  • Must be one of: DHCP, Internal DB, Random DB, EUI-64, External IPAM, None.
subnet[from]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Eerste IP adres voor IP auto voorstel

Validations:

  • Must be a String
subnet[to]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Laatste IP adres voor IP auto voorstel

Validations:

  • Must be a String
subnet[vlanid]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

VLAN ID voor dit subnet

Validations:

  • Must be a String
subnet[mtu]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

MTU for this subnet

Validations:

  • Must be a Integer
subnet[domain_ids]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Domeinen waar dit dubnet deel van uitmaakt

Validations:

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

DHCP Proxy ID to use within this subnet

Validations:

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

TFTP Proxy ID to use within this subnet

Validations:

  • Must be a number.
subnet[httpboot_id]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

HTTPBoot Proxy ID to use within this subnet

Validations:

  • Must be a number.
subnet[externalipam_id]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

External IPAM Proxy ID to use within this subnet

Validations:

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

DNS Proxy ID to use within this subnet

Validations:

  • Must be a number.
subnet[template_id]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Template HTTP(S) Proxy ID to use within this subnet

Validations:

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

Default boot mode for interfaces assigned to this subnet.

Validations:

  • Must be one of: Static, DHCP.
subnet[subnet_parameters_attributes]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Array van parameters (naam, waarde)

Validations:

  • Must be an array of any type
subnet[location_ids]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Vervang locaties met de opgegeven ids

Validations:

  • Must be an array of any type
subnet[organization_ids]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Vervang organisaties met de opgegeven ids.

Validations:

  • Must be an array of any type
subnet[remote_execution_proxy_ids]
Optional

List of proxy IDs to be used for remote execution

Validations:

  • Must be an array of any type
>>>

PUT /api/subnets/:id
Wijzig een subnet

Params

Param Name Description
location_id
Optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
Optional

Set the current organization context for the request

Validations:

  • Must be a Integer
id
Required

Subnet numerieke identifier

Validations:

  • Must be a number.
subnet
Required

Validations:

  • Must be a Hash
subnet[name]
Optional

Subnet naam

Validations:

  • Must be a String
subnet[description]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Subnet beschrijving

Validations:

  • Must be a String
subnet[network_type]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Type of protocol, IPv4 of IPV6, standaard is IPv4

Validations:

  • Must be one of: IPv4, IPv6.
subnet[network]
Optional

Subnet netwerk

Validations:

  • Must be a String
subnet[cidr]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Network prefix in CIDR notation

Validations:

  • Must be a String
subnet[mask]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Netmask voor dit subnet

Validations:

  • Must be a String
subnet[gateway]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Subnet gateway

Validations:

  • Must be a String
subnet[dns_primary]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Primaire DNS voor dit subnet

Validations:

  • Must be a String
subnet[dns_secondary]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Secundaire DNS voor dit subnet

Validations:

  • Must be a String
subnet[ipam]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

IP Address auto suggestion mode for this subnet.

Validations:

  • Must be one of: DHCP, Internal DB, Random DB, EUI-64, External IPAM, None.
subnet[from]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Eerste IP adres voor IP auto voorstel

Validations:

  • Must be a String
subnet[to]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Laatste IP adres voor IP auto voorstel

Validations:

  • Must be a String
subnet[vlanid]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

VLAN ID voor dit subnet

Validations:

  • Must be a String
subnet[mtu]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

MTU for this subnet

Validations:

  • Must be a Integer
subnet[domain_ids]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Domeinen waar dit dubnet deel van uitmaakt

Validations:

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

DHCP Proxy ID to use within this subnet

Validations:

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

TFTP Proxy ID to use within this subnet

Validations:

  • Must be a number.
subnet[httpboot_id]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

HTTPBoot Proxy ID to use within this subnet

Validations:

  • Must be a number.
subnet[externalipam_id]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

External IPAM Proxy ID to use within this subnet

Validations:

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

DNS Proxy ID to use within this subnet

Validations:

  • Must be a number.
subnet[template_id]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Template HTTP(S) Proxy ID to use within this subnet

Validations:

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

Default boot mode for interfaces assigned to this subnet.

Validations:

  • Must be one of: Static, DHCP.
subnet[subnet_parameters_attributes]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Array van parameters (naam, waarde)

Validations:

  • Must be an array of any type
subnet[location_ids]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Vervang locaties met de opgegeven ids

Validations:

  • Must be an array of any type
subnet[organization_ids]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Vervang organisaties met de opgegeven ids.

Validations:

  • Must be an array of any type
subnet[remote_execution_proxy_ids]
Optional

List of proxy IDs to be used for remote execution

Validations:

  • Must be an array of any type
>>>

DELETE /api/subnets/:id
Verwijder een subnet

Params

Param Name Description
location_id
Optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
Optional

Set the current organization context for the request

Validations:

  • Must be a Integer
id
Required

Subnet numerieke identifier

Validations:

  • Must be a number.
>>>

GET /api/subnets/:id/freeip
Maakt een ongebruikt IP adres in dit subnet

Params

Param Name Description
location_id
Optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
Optional

Set the current organization context for the request

Validations:

  • Must be a Integer
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 adres om het IP voor deze host te herbruiken

Validations:

  • Must be a String
excluded_ips
Optional

IP adressen die uitgesloten zijn van voorstellen

Validations:

  • Must be an array of any type