Subnets

>>>

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

Examples

GET /api/locations/447626440/subnets
200
{
  "total": 1,
  "subtotal": 1,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "network": "127.173.177.0",
      "network_type": "IPv4",
      "cidr": 24,
      "mask": "255.255.255.0",
      "priority": null,
      "vlanid": null,
      "mtu": 1500,
      "gateway": null,
      "dns_primary": null,
      "dns_secondary": null,
      "from": null,
      "to": null,
      "created_at": "2021-05-19 07:52:14 UTC",
      "updated_at": "2021-05-19 07:52:14 UTC",
      "ipam": "None",
      "boot_mode": "DHCP",
      "nic_delay": null,
      "id": 1018350801,
      "name": "subnet534",
      "description": null,
      "network_address": "127.173.177.0/24",
      "dhcp_id": null,
      "dhcp_name": null,
      "tftp_id": null,
      "tftp_name": null,
      "httpboot_id": null,
      "httpboot_name": null,
      "externalipam_id": null,
      "externalipam_name": null,
      "dns_id": null,
      "template_id": null,
      "template_name": null,
      "bmc_id": null,
      "bmc_name": null,
      "dhcp": null,
      "tftp": null,
      "httpboot": null,
      "externalipam": null,
      "dns": null,
      "template": null,
      "bmc": null
    }
  ]
}

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 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, ‘all’ to return all results

Validations:

  • Must match regular expression /\A([1-9]\d|all)\Z$/.

Search fields

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

GET /api/subnets/:id
Show a subnet

Examples

GET /api/subnets/1018350796-subnet532
200
{
  "network": "103.205.217.0",
  "network_type": "IPv4",
  "cidr": 24,
  "mask": "255.255.255.0",
  "priority": null,
  "vlanid": null,
  "mtu": 1500,
  "gateway": null,
  "dns_primary": null,
  "dns_secondary": null,
  "from": null,
  "to": null,
  "created_at": "2021-05-19 07:52:13 UTC",
  "updated_at": "2021-05-19 07:52:13 UTC",
  "ipam": "None",
  "boot_mode": "DHCP",
  "nic_delay": null,
  "id": 1018350796,
  "name": "subnet532",
  "description": null,
  "network_address": "103.205.217.0/24",
  "dhcp_id": null,
  "dhcp_name": null,
  "tftp_id": null,
  "tftp_name": null,
  "httpboot_id": null,
  "httpboot_name": null,
  "externalipam_id": null,
  "externalipam_name": null,
  "dns_id": null,
  "template_id": null,
  "template_name": null,
  "bmc_id": null,
  "bmc_name": null,
  "dhcp": null,
  "tftp": null,
  "httpboot": null,
  "externalipam": null,
  "dns": null,
  "template": null,
  "bmc": null,
  "domains": [],
  "interfaces": [],
  "parameters": [],
  "locations": [
    {
      "id": 255093256,
      "name": "Location 1",
      "title": "Location 1",
      "description": null
    }
  ],
  "organizations": [
    {
      "id": 447626438,
      "name": "Organization 1",
      "title": "Organization 1",
      "description": null
    }
  ]
}

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
Create a subnet

Examples

POST /api/subnets
{
  "subnet": {
    "name": "QA2",
    "network": "10.35.2.27",
    "mask": "255.255.255.0"
  }
}
201
{
  "network": "10.35.2.27",
  "network_type": "IPv4",
  "cidr": 24,
  "mask": "255.255.255.0",
  "priority": null,
  "vlanid": null,
  "mtu": 1500,
  "gateway": null,
  "dns_primary": null,
  "dns_secondary": null,
  "from": null,
  "to": null,
  "created_at": "2021-05-19 07:52:13 UTC",
  "updated_at": "2021-05-19 07:52:13 UTC",
  "ipam": "None",
  "boot_mode": "DHCP",
  "nic_delay": null,
  "id": 1018350797,
  "name": "QA2",
  "description": null,
  "network_address": "10.35.2.27/24",
  "dhcp_id": null,
  "dhcp_name": null,
  "tftp_id": null,
  "tftp_name": null,
  "httpboot_id": null,
  "httpboot_name": null,
  "externalipam_id": null,
  "externalipam_name": null,
  "dns_id": null,
  "template_id": null,
  "template_name": null,
  "bmc_id": null,
  "bmc_name": null,
  "dhcp": null,
  "tftp": null,
  "httpboot": null,
  "externalipam": null,
  "dns": null,
  "template": null,
  "bmc": null,
  "domains": [],
  "interfaces": [],
  "parameters": [],
  "locations": [],
  "organizations": []
}

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 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[cidr]
optional , nil allowed

Network prefix in CIDR notation

Validations:

  • Must be a String
subnet[mask]
optional , nil allowed

Netmask for this subnet

Validations:

  • Must be a String
subnet[gateway]
optional , nil allowed

Subnet gateway

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.

Validations:

  • Must be one of: DHCP, Internal DB, Random DB, EUI-64, External IPAM, None.
subnet[externalipam_group]
optional , nil allowed

External IPAM group - only relevant when IPAM is set to external

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[mtu]
optional , nil allowed

MTU for this subnet

Validations:

  • Must be a Integer
subnet[domain_ids]
optional , nil allowed

Domains in which this subnet is part

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[httpboot_id]
optional , nil allowed

HTTPBoot Proxy ID to use within this subnet

Validations:

  • Must be a number.
subnet[externalipam_id]
optional , nil allowed

External IPAM 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[template_id]
optional , nil allowed

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

Validations:

  • Must be a number.
subnet[bmc_id]
optional , nil allowed

BMC 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.

Validations:

  • Must be one of: Static, DHCP.
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

Examples

PUT /api/subnets/1018350798
{
  "subnet": {
    "subnet_parameters_attributes": [
      {
        "name": "foo",
        "value": "new_value"
      }
    ]
  }
}
200
{
  "network": "227.195.76.0",
  "network_type": "IPv4",
  "cidr": 24,
  "mask": "255.255.255.0",
  "priority": null,
  "vlanid": null,
  "mtu": 1500,
  "gateway": null,
  "dns_primary": null,
  "dns_secondary": null,
  "from": null,
  "to": null,
  "created_at": "2021-05-19 07:52:13 UTC",
  "updated_at": "2021-05-19 07:52:13 UTC",
  "ipam": "None",
  "boot_mode": "DHCP",
  "nic_delay": null,
  "id": 1018350798,
  "name": "subnet533",
  "description": null,
  "network_address": "227.195.76.0/24",
  "dhcp_id": null,
  "dhcp_name": null,
  "tftp_id": null,
  "tftp_name": null,
  "httpboot_id": null,
  "httpboot_name": null,
  "externalipam_id": null,
  "externalipam_name": null,
  "dns_id": null,
  "template_id": null,
  "template_name": null,
  "bmc_id": null,
  "bmc_name": null,
  "dhcp": null,
  "tftp": null,
  "httpboot": null,
  "externalipam": null,
  "dns": null,
  "template": null,
  "bmc": null,
  "domains": [],
  "interfaces": [],
  "parameters": [
    {
      "priority": 40,
      "created_at": "2021-05-19 07:52:13 UTC",
      "updated_at": "2021-05-19 07:52:14 UTC",
      "id": 767575240,
      "name": "foo",
      "parameter_type": "string",
      "value": "new_value"
    }
  ],
  "locations": [
    {
      "id": 255093256,
      "name": "Location 1",
      "title": "Location 1",
      "description": null
    }
  ],
  "organizations": [
    {
      "id": 447626438,
      "name": "Organization 1",
      "title": "Organization 1",
      "description": null
    }
  ]
}

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 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[cidr]
optional , nil allowed

Network prefix in CIDR notation

Validations:

  • Must be a String
subnet[mask]
optional , nil allowed

Netmask for this subnet

Validations:

  • Must be a String
subnet[gateway]
optional , nil allowed

Subnet gateway

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.

Validations:

  • Must be one of: DHCP, Internal DB, Random DB, EUI-64, External IPAM, None.
subnet[externalipam_group]
optional , nil allowed

External IPAM group - only relevant when IPAM is set to external

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[mtu]
optional , nil allowed

MTU for this subnet

Validations:

  • Must be a Integer
subnet[domain_ids]
optional , nil allowed

Domains in which this subnet is part

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[httpboot_id]
optional , nil allowed

HTTPBoot Proxy ID to use within this subnet

Validations:

  • Must be a number.
subnet[externalipam_id]
optional , nil allowed

External IPAM 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[template_id]
optional , nil allowed

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

Validations:

  • Must be a number.
subnet[bmc_id]
optional , nil allowed

BMC 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.

Validations:

  • Must be one of: Static, DHCP.
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

Examples

DELETE /api/subnets/281110143-four
{
  "subnet": {}
}
200
{
  "id": 281110143,
  "network": "3.3.5.0",
  "mask": "255.255.255.0",
  "priority": null,
  "name": "four",
  "vlanid": 44,
  "created_at": "2021-05-19T07:52:09.699Z",
  "updated_at": "2021-05-19T07:52:09.699Z",
  "dhcp_id": null,
  "tftp_id": 298486374,
  "gateway": null,
  "dns_primary": null,
  "dns_secondary": null,
  "from": null,
  "to": null,
  "dns_id": null,
  "boot_mode": "DHCP",
  "ipam": "None",
  "description": null,
  "mtu": 9000,
  "template_id": null,
  "httpboot_id": null,
  "nic_delay": null,
  "externalipam_id": null,
  "externalipam_group": null,
  "bmc_id": null,
  "to_label": "four (3.3.5.0/24)",
  "type": "Subnet::Ipv4"
}

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 numeric identifier

Validations:

  • Must be a number.
>>>

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

Examples

GET /api/subnets/1018350796-subnet353/freeip
200
{
  "freeip": null,
  "errors": {}
}

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