List network interfaces

GET 
/api/node/:hostname/network/interface

List all network interfaces on the target node.

Request

Path Parameters

hostname stringrequired

Possible values: non-empty

Target agent hostname, reserved routing value (_any, _all), or label selector (key:value).

Responses

200

List of network interfaces.

application/json

Schema

Schema

job_id uuid

The job ID used to process this request.

results

object[]

required

Array [

hostname stringrequired

Hostname of the agent that reported this entry.

status stringrequired

Possible values: [ok, failed, skipped]

The status of the operation for this host.

interfaces

object[]

List of network interfaces on this host.

Array [

name string

Interface name.

ipv4 string

Primary IPv4 address.

ipv6 string

Primary IPv6 address.

mac string

Hardware MAC address.

family string

Address family (inet, inet6, dual).

addresses string[]

IP addresses assigned to the interface (CIDR).

mac_address string

Configured MAC address override.

mtu integer

Maximum transmission unit.

state string

Operational state of the interface.

dhcp4 boolean

Whether DHCPv4 is enabled.

dhcp6 boolean

Whether DHCPv6 is enabled.

gateway4 string

IPv4 gateway address.

gateway6 string

IPv6 gateway address.

wakeonlan boolean

Whether Wake-on-LAN is enabled.

primary boolean

Whether this is the primary (default route) interface.

]

error string

Error message if the agent failed.

]

Example (from schema)

{
  "job_id": "550e8400-e29b-41d4-a716-446655440000",
  "results": [
    {
      "hostname": "string",
      "status": "ok",
      "interfaces": [
        {
          "name": "eth0",
          "ipv4": "192.168.1.10",
          "ipv6": "fd00::5",
          "mac": "00:1a:2b:3c:4d:5e",
          "family": "dual",
          "addresses": [
            "192.168.1.10/24"
          ],
          "mac_address": "02:42:ac:11:00:02",
          "mtu": 1500,
          "state": "up",
          "dhcp4": true,
          "dhcp6": true,
          "gateway4": "192.168.1.1",
          "gateway6": "string",
          "wakeonlan": true,
          "primary": true
        }
      ],
      "error": "string"
    }
  ]
}

400

Bad request - validation error.

application/json

Schema

Schema

error string

A description of the error that occurred.

details string

Additional details about the error.

code integer

The error code.

Example (from schema)

{
  "error": "Failed to retrieve status.",
  "details": "Failed due to network timeout.",
  "code": 500
}

401

Unauthorized - API key required

application/json

Schema

Schema

error string

A description of the error that occurred.

details string

Additional details about the error.

code integer

The error code.

Example (from schema)

{
  "error": "Failed to retrieve status.",
  "details": "Failed due to network timeout.",
  "code": 500
}

403

Forbidden - Insufficient permissions

application/json

Schema

Schema

error string

A description of the error that occurred.

details string

Additional details about the error.

code integer

The error code.

Example (from schema)

{
  "error": "Failed to retrieve status.",
  "details": "Failed due to network timeout.",
  "code": 500
}

500

Error listing network interfaces.

application/json

Schema

Schema

error string

A description of the error that occurred.

details string

Additional details about the error.

code integer

The error code.

Example (from schema)

{
  "error": "Failed to retrieve status.",
  "details": "Failed due to network timeout.",
  "code": 500
}

Loading...