Examples

GET /api/locations/447626472/subnets
200
{
  "total": 1,
  "subtotal": 1,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "network": "217.171.192.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": "2022-09-06 14:32:38 UTC",
      "updated_at": "2022-09-06 14:32:38 UTC",
      "ipam": "None",
      "boot_mode": "DHCP",
      "nic_delay": null,
      "id": 1018350844,
      "name": "subnet123",
      "description": null,
      "network_address": "217.171.192.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 and order by a searchable field, e.g. '<field> 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
id integer
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