Skip to main content

Get the current state of agent interfaces

GET
/agents/{id}/interfaces

Reads the current negotiated Ethernet speed in Mbit/s, the link state, and the duplex mode from the agent. It does not use the speed saved at registration and does not change NIC settings. A missing speed means the value is unknown; linkUp is omitted if the driver cannot report it.

Contract

Parameter
Value
Sectionagents
AuthenticationCookieAuth
Consumesnot required
Producesapplication/json

Parameters

1 parameter

Name
Location
Required
Type
Description
idpathyesintegerAgent ID

Responses

6 responses

Status
Description
Type
200
Current interface stateobject[]
400
Invalid IDobject
401
Unauthorizedobject
404
Agent not foundobject
500
Database errorobject
502
Agent unavailable or does not support reading port stateobject
  • [
      {
        "address": "<string>",
        "deviceId": "<string>",
        "driver": "<string>",
        "linkDuplex": "<string>",
        "linkSpeedMbps": 0,
        "linkUp": true,
        "name": "<string>",
        "vendor": "<string>"
      }
    ]
  • {
      "data": {},
      "error": "<string>"
    }
  • {
      "data": {},
      "error": "<string>"
    }
  • {
      "data": {},
      "error": "<string>"
    }
  • {
      "data": {},
      "error": "<string>"
    }
  • {
      "data": {},
      "error": "<string>"
    }