GET /api/hosts/:host_id/interfaces
List all interfaces for host

GET /api/domains/:domain_id/interfaces
List all interfaces for domain

GET /api/subnets/:subnet_id/interfaces
List all interfaces for subnet

Examples

GET /api/hosts/host652/interfaces
200
{
  "total": 3,
  "subtotal": 3,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "subnet_id": null,
      "subnet_name": null,
      "subnet6_id": null,
      "subnet6_name": null,
      "domain_id": null,
      "domain_name": null,
      "created_at": "2021-09-01 11:39:17 UTC",
      "updated_at": "2021-09-01 11:39:17 UTC",
      "managed": true,
      "identifier": null,
      "id": 3,
      "name": "host652",
      "ip": null,
      "ip6": null,
      "mac": null,
      "mtu": null,
      "fqdn": "host652",
      "primary": true,
      "provision": true,
      "type": "interface",
      "virtual": false
    },
    {
      "subnet_id": null,
      "subnet_name": null,
      "subnet6_id": null,
      "subnet6_name": null,
      "domain_id": null,
      "domain_name": null,
      "created_at": "2021-09-01 11:39:17 UTC",
      "updated_at": "2021-09-01 11:39:17 UTC",
      "managed": true,
      "identifier": "eth271",
      "id": 4,
      "name": null,
      "ip": "0.0.0.29",
      "ip6": null,
      "mac": "00:33:45:ab:00:46",
      "mtu": null,
      "fqdn": null,
      "primary": false,
      "provision": false,
      "type": "interface",
      "virtual": false
    },
    {
      "subnet_id": null,
      "subnet_name": null,
      "subnet6_id": null,
      "subnet6_name": null,
      "domain_id": null,
      "domain_name": null,
      "created_at": "2021-09-01 11:39:18 UTC",
      "updated_at": "2021-09-01 11:39:18 UTC",
      "managed": true,
      "identifier": "eth272",
      "id": 5,
      "name": null,
      "ip": "0.0.0.30",
      "ip6": null,
      "mac": "00:33:45:ab:00:47",
      "mtu": null,
      "fqdn": null,
      "primary": false,
      "provision": false,
      "type": "bond",
      "mode": "balance-rr",
      "attached_devices": "",
      "bond_options": "",
      "virtual": true
    }
  ]
}

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

ID or name of host

Validations:

  • Must be a String
domain_id
optional

ID or name of domain

Validations:

  • Must be a String
subnet_id
optional

ID or name of subnet

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$/.