Skip to main content

Retrieves a list of all network devices.

GET 
/network/devices

This endpoint returns all registered network devices in the system.

Responses​

  • 200 OK: Successfully retrieved the list of network devices.
  • 500 Internal Server Error: Unexpected server error.

Request​

Responses​

Successfully retrieved the list of network devices.

Schema

  • Array [

    • bandwidth

    object

    nullable

    Represents bandwidth details for a network device

    downloadMbps int32nullable

    Download bandwidth in Mbps.

    uploadMbps int32nullable

    Upload bandwidth in Mbps.

    id int32required

    The unique identifier of the network device.

    ip stringrequired

    The IP address of the network device.

    latencyMs int32nullable

    The latency in milliseconds (optional).

    name stringrequired

    The name of the network device.

    packetLossPercentage int32nullable

    The packet loss percentage (optional).

    status NetDeviceStatusrequired

    Possible values: [online, offline, degraded, maintenance, error, unspecified]

    Represents the status of a network device

    This enum describes the current operational state of a network device. The status can indicate whether the device is operational, undergoing maintenance, or experiencing issues.

    type NetDeviceTyperequired

    Possible values: [router, switch, accessPoint, firewall]

    Represents the type of a network device

    This enum describes the different types of network devices that can exist in a network. Each type has its own role and functionality within the network infrastructure.

  • ]

Loading...