GET /api/subnets/:id
Show a subnet

Examples

GET /api/subnets/1018350796
200
{
  "network": "24.66.103.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-09-01 12:55:50 UTC",
  "updated_at": "2021-09-01 12:55:50 UTC",
  "ipam": "None",
  "boot_mode": "DHCP",
  "nic_delay": null,
  "id": 1018350796,
  "name": "subnet453",
  "description": null,
  "network_address": "24.66.103.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-09-01 12:55:50 UTC",
      "updated_at": "2021-09-01 12:55:50 UTC",
      "id": 767575239,
      "name": "foo",
      "parameter_type": "string",
      "value": "bar"
    }
  ],
  "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.