Advanced API

Rescan Devices

GET /equipment/switch/rescan

Rescans for new devices, and returns a list of all available devices

Responses

  • 200 application/json

    Successful response

    Hide response attributes Show response attributes object
    • Response array[object]
      Hide Response attributes Show Response attributes object
      • HasSetupDialog boolean
      • Id string
      • Name string
      • DisplayName string
      • Category string
      • Connected boolean
      • Description string
      • DriverInfo string
      • DriverVersion string
      • SupportedActions array
    • Error string
    • StatusCode integer
    • Success boolean
    • Type string
  • 500 application/json

    Internal server error, Unknown error

    Hide response attributes Show response attributes object
    • Response string
    • Error string
    • StatusCode integer
    • Success boolean
    • Type string
GET /equipment/switch/rescan 
curl \
 --request GET 'http://localhost:1888/v2/api/equipment/switch/rescan'
Response examples (200) 
{
  "Response": [
    {
      "HasSetupDialog": true,
      "Id": "string",
      "Name": "string",
      "DisplayName": "string",
      "Category": "string",
      "Connected": true,
      "Description": "string",
      "DriverInfo": "string",
      "DriverVersion": "string",
      "SupportedActions": []
    }
  ],
  "Error": "string",
  "StatusCode": 200,
  "Success": true,
  "Type": "API"
}
Response examples (500) 
{
  "Response": "string",
  "Error": "Unknown error",
  "StatusCode": 500,
  "Success": false,
  "Type": "API"
}