Skip to main content

Updates an existing network device.

PATCH 
/network/devices/:id

This endpoint allows updating specific fields of a network device.

Path Parameters​

  • id (integer): The unique identifier of the network device.

Request Body​

  • NetDevicePatchDto: Contains the fields to be updated.

Responses​

  • 200 OK: Successfully updated the network device.
  • 400 Bad Request: Invalid update data.
  • 404 Not Found: The network device does not exist.
  • 500 Internal Server Error: Unexpected server error.

Request​

Path Parameters

    id int32required

    Unique identifier of the network device

Body

required

    bandwidth

    object

    nullable

    Represents bandwidth details for a network device

    downloadMbps int32nullable

    Download bandwidth in Mbps.

    uploadMbps int32nullable

    Upload bandwidth in Mbps.

    ip stringnullable

    The IP address of the network device.

    latencyMs int32nullable

    The latency in milliseconds.

    name stringnullable

    The name of the network device.

    packetLossPercentage int32nullable

    The packet loss percentage.

    status object

    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 object

    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.

Responses​

Successfully updated the network device.

Schema

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