Get Computer Endpoints

This endpoint retrieves detailed endpoint usage information for the USB controllers associated with the connected computer.

The response includes key data for each controller, such as its description, location ID, and usage statistics for USB 2.0 and USB 3.0 separately, as well as a combined total.

Syntax: see Call Structure

Type = 'GET'

'http://localhost:43424/api/v1/endpoints'

Returns:

[ { "info": { "description": "description)", "locationId": location-id }, "usage": { "usb2": { "endpoints": endpoints, "memory": endpoint-memory }, "usb3": { "endpoints": endpoints, "memory": endpoint-memory }, "total": { "endpoints": endpoints, "memory": endpoint-memory } } } ]

Output	Description
description	This the name of hardware
location-id	This is the id of the location as a unique 128-bit number
endpoint-memory	This is the amount of endpoint memory consumed in bytes
endpoints	This the the amount of endpoints

Example

curl -X 'GET' \
  'http://localhost:43424/api/v1/endpoints' \
  -H 'accept: application/json'
                                                    

Returns

{
  "result": [
    {
      "info": {
        "description": "NVIDIA USB 3.10 eXtensible Host Controller - 1.10 (Microsoft)",
        "locationId": 553648128
      },
      "usage": {
        "usb2": {
          "endpoints": 0,
          "memory": 0
        },
        "usb3": {
          "endpoints": 0,
          "memory": 0
        },
        "total": {
          "endpoints": 0,
          "memory": 0
        }
      }
    },
    {
      "info": {
        "description": "Intel(R) USB 3.10 eXtensible Host Controller - 1.10 (Microsoft)",
        "locationId": 570425344,
        "endpoint-memory": {
          "peak-usage": 40960
        }
      },
      "usage": {
        "usb2": {
          "endpoints": 0,
          "memory": 0
        },
        "usb3": {
          "endpoints": 0,
          "memory": 0
        },
        "total": {
          "endpoints": 0,
          "memory": 0
        }
      }
    },
    {
      "info": {
        "description": "Intel(R) USB 3.20 eXtensible Host Controller - 1.20 (Microsoft)",
        "locationId": 587202560,
        "endpoint-memory": {
          "peak-usage": 720896
        }
      },
      "usage": {
        "usb2": {
          "endpoints": 77,
          "memory": 409600
        },
        "usb3": {
          "endpoints": 23,
          "memory": 188416
        },
        "total": {
          "endpoints": 100,
          "memory": 598016
        }
      }
    }
  ]
}
                                                    

Errors

If there is an error in the API method then JSON-RPC Error Object a will be returned