GET /api/subnets/:id
Show a subnet

Examples

GET /api/subnets/980190962-one
200
{
  "network": "2.3.4.0",
  "network_type": "IPv4",
  "cidr": 24,
  "mask": "255.255.255.0",
  "priority": null,
  "vlanid": 41,
  "mtu": 1500,
  "gateway": null,
  "dns_primary": null,
  "dns_secondary": null,
  "from": null,
  "to": null,
  "created_at": "2019-11-07 08:37:37 UTC",
  "updated_at": "2019-11-07 08:37:37 UTC",
  "ipam": "None",
  "boot_mode": "DHCP",
  "id": 980190962,
  "name": "one",
  "description": null,
  "network_address": "2.3.4.0/24",
  "dhcp_id": 980190962,
  "dhcp_name": "DHCP Proxy",
  "tftp_id": 298486374,
  "tftp_name": "TFTP Proxy",
  "httpboot_id": null,
  "httpboot_name": null,
  "dns_id": 113629430,
  "template_id": null,
  "template_name": null,
  "dhcp": {
    "name": "DHCP Proxy",
    "id": 980190962,
    "url": "https://somewhere.net:8443"
  },
  "tftp": {
    "name": "TFTP Proxy",
    "id": 298486374,
    "url": "http://somewhere.else"
  },
  "httpboot": null,
  "dns": {
    "name": "DNS Proxy",
    "id": 113629430,
    "url": "http://else.where:45671"
  },
  "template": null,
  "domains": [
    {
      "id": 22495316,
      "name": "mydomain.net"
    }
  ],
  "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.