GET /api/subnets
Список подсетей

GET /api/domains/:domain_id/subnets
Список подсетей домена

GET /api/locations/:location_id/subnets
Список подсетей местоположения

GET /api/organizations/:organization_id/subnets
Список подсетей организации

Параметры

Имя параметра Описание
domain_id
необязательно

Код домена

Validations:

  • Must be a String

location_id
необязательно

Ограничить местоположением

Validations:

  • Must be a Integer

organization_id
необязательно

Ограничить организацией

Validations:

  • Must be a Integer

search
необязательно

отфильтровать результаты

Validations:

  • Must be a String

order
необязательно

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String

page
необязательно

Номер страницы, начиная с 1

Validations:

  • Must be a number.

per_page
необязательно

Число элементов на странице

Validations:

  • Must be a number.

Search fields

Field name Тип Possible values
boot_mode
dns_primary
dns_secondary
domain
gateway
ipam
location
location_id
mask
mtu
name
network
nic_delay
organization
organization_id
params
type
vlanid

GET /api/subnets/:id
Показать подсеть

Параметры

Имя параметра Описание
location_id
необязательно

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
необязательно

Set the current organization context for the request

Validations:

  • Must be a Integer

id
обязательно

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
необязательно

Display hidden parameter values

Validations:

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


POST /api/subnets
Создать подсеть

Параметры

Имя параметра Описание
location_id
необязательно

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
необязательно

Set the current organization context for the request

Validations:

  • Must be a Integer

subnet
обязательно

Validations:

  • Must be a Hash

subnet[name]
обязательно

Имя подсети

Validations:

  • Must be a String

subnet[description]
необязательно , nil разрешен

Subnet description

Validations:

  • Must be a String

subnet[network_type]
необязательно , nil разрешен

Type or protocol, IPv4 or IPv6, defaults to IPv4

Validations:

  • Must be one of: IPv4, IPv6.

subnet[network]
обязательно

Подсети

Validations:

  • Must be a String

subnet[cidr]
необязательно , nil разрешен

Network prefix in CIDR notation

Validations:

  • Must be a String

subnet[mask]
необязательно , nil разрешен

Маска этой подсети

Validations:

  • Must be a String

subnet[gateway]
необязательно , nil разрешен

Subnet gateway

Validations:

  • Must be a String

subnet[dns_primary]
необязательно , nil разрешен

Первичный DNS для этой подсети

Validations:

  • Must be a String

subnet[dns_secondary]
необязательно , nil разрешен

Вторичный DNS для этой подсети

Validations:

  • Must be a String

subnet[ipam]
необязательно , nil разрешен

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]
необязательно , nil разрешен

Начальный IP-адрес для автоматического предложения адресов

Validations:

  • Must be a String

subnet[to]
необязательно , nil разрешен

Заключительный IP-адрес для автоматического предложения адресов

Validations:

  • Must be a String

subnet[vlanid]
необязательно , nil разрешен

Идентификатор VLAN для этой подсети

Validations:

  • Must be a String

subnet[mtu]
необязательно , nil разрешен

MTU for this subnet

Validations:

  • Must be a Integer

subnet[domain_ids]
необязательно , nil разрешен

Домены, в которые входит подсеть

Validations:

  • Must be an array of any type

subnet[dhcp_id]
необязательно , nil разрешен

DHCP Proxy ID to use within this subnet

Validations:

  • Must be a number.

subnet[tftp_id]
необязательно , nil разрешен

TFTP Proxy ID to use within this subnet

Validations:

  • Must be a number.

subnet[httpboot_id]
необязательно , nil разрешен

HTTPBoot Proxy ID to use within this subnet

Validations:

  • Must be a number.

subnet[externalipam_id]
необязательно , nil разрешен

External IPAM Proxy ID to use within this subnet

Validations:

  • Must be a number.

subnet[dns_id]
необязательно , nil разрешен

DNS Proxy ID to use within this subnet

Validations:

  • Must be a number.

subnet[template_id]
необязательно , nil разрешен

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

Validations:

  • Must be a number.

subnet[boot_mode]
необязательно , nil разрешен

Default boot mode for interfaces assigned to this subnet.

Validations:

  • Must be one of: Static, DHCP.

subnet[subnet_parameters_attributes]
необязательно , nil разрешен

Массив параметров (имя, значение)

Validations:

  • Must be an array of any type

subnet[location_ids]
необязательно , nil разрешен

ЗАМЕСТИТЬ местоположения с заданным кодом

Validations:

  • Must be an array of any type

subnet[organization_ids]
необязательно , nil разрешен

ЗАМЕСТИТЬ организации с заданным кодом

Validations:

  • Must be an array of any type


PUT /api/subnets/:id
Изменить подсеть

Параметры

Имя параметра Описание
location_id
необязательно

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
необязательно

Set the current organization context for the request

Validations:

  • Must be a Integer

id
обязательно

Числовой идентификатор подсети

Validations:

  • Must be a number.

subnet
обязательно

Validations:

  • Must be a Hash

subnet[name]
необязательно

Имя подсети

Validations:

  • Must be a String

subnet[description]
необязательно , nil разрешен

Subnet description

Validations:

  • Must be a String

subnet[network_type]
необязательно , nil разрешен

Type or protocol, IPv4 or IPv6, defaults to IPv4

Validations:

  • Must be one of: IPv4, IPv6.

subnet[network]
необязательно

Подсети

Validations:

  • Must be a String

subnet[cidr]
необязательно , nil разрешен

Network prefix in CIDR notation

Validations:

  • Must be a String

subnet[mask]
необязательно , nil разрешен

Маска этой подсети

Validations:

  • Must be a String

subnet[gateway]
необязательно , nil разрешен

Subnet gateway

Validations:

  • Must be a String

subnet[dns_primary]
необязательно , nil разрешен

Первичный DNS для этой подсети

Validations:

  • Must be a String

subnet[dns_secondary]
необязательно , nil разрешен

Вторичный DNS для этой подсети

Validations:

  • Must be a String

subnet[ipam]
необязательно , nil разрешен

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]
необязательно , nil разрешен

Начальный IP-адрес для автоматического предложения адресов

Validations:

  • Must be a String

subnet[to]
необязательно , nil разрешен

Заключительный IP-адрес для автоматического предложения адресов

Validations:

  • Must be a String

subnet[vlanid]
необязательно , nil разрешен

Идентификатор VLAN для этой подсети

Validations:

  • Must be a String

subnet[mtu]
необязательно , nil разрешен

MTU for this subnet

Validations:

  • Must be a Integer

subnet[domain_ids]
необязательно , nil разрешен

Домены, в которые входит подсеть

Validations:

  • Must be an array of any type

subnet[dhcp_id]
необязательно , nil разрешен

DHCP Proxy ID to use within this subnet

Validations:

  • Must be a number.

subnet[tftp_id]
необязательно , nil разрешен

TFTP Proxy ID to use within this subnet

Validations:

  • Must be a number.

subnet[httpboot_id]
необязательно , nil разрешен

HTTPBoot Proxy ID to use within this subnet

Validations:

  • Must be a number.

subnet[externalipam_id]
необязательно , nil разрешен

External IPAM Proxy ID to use within this subnet

Validations:

  • Must be a number.

subnet[dns_id]
необязательно , nil разрешен

DNS Proxy ID to use within this subnet

Validations:

  • Must be a number.

subnet[template_id]
необязательно , nil разрешен

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

Validations:

  • Must be a number.

subnet[boot_mode]
необязательно , nil разрешен

Default boot mode for interfaces assigned to this subnet.

Validations:

  • Must be one of: Static, DHCP.

subnet[subnet_parameters_attributes]
необязательно , nil разрешен

Массив параметров (имя, значение)

Validations:

  • Must be an array of any type

subnet[location_ids]
необязательно , nil разрешен

ЗАМЕСТИТЬ местоположения с заданным кодом

Validations:

  • Must be an array of any type

subnet[organization_ids]
необязательно , nil разрешен

ЗАМЕСТИТЬ организации с заданным кодом

Validations:

  • Must be an array of any type


DELETE /api/subnets/:id
Удалить подсеть

Параметры

Имя параметра Описание
location_id
необязательно

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
необязательно

Set the current organization context for the request

Validations:

  • Must be a Integer

id
обязательно

Числовой идентификатор подсети

Validations:

  • Must be a number.


GET /api/subnets/:id/freeip
Provides an unused IP address in this subnet

Параметры

Имя параметра Описание
location_id
необязательно

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
необязательно

Set the current organization context for the request

Validations:

  • Must be a Integer

id
обязательно

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
необязательно

MAC address to reuse the IP for this host

Validations:

  • Must be a String

excluded_ips
необязательно

IP addresses that should be excluded from suggestion

Validations:

  • Must be an array of any type