Get a list of available Wi-Fi networks

Get a list of available Wi-Fi networks

Responses

• 200
• 401
• 404

---

OK

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• ssids object[]

  Array of objects that describe Wi-Fi connection

  ssid string

  Name of Wi-Fi network

  dbi integer

  Password of Wi-Fi network

{
  "ssids": [
    {
      "ssid": "My access point",
      "dbi": -64
    }
  ]
}

{
  "ssids": [
    {
      "ssid": "wifi0",
      "dbi": -60
    },
    {
      "ssid": "wifi1",
      "dbi": -50
    }
  ]
}

Please log in

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• error object

  Describes the base error user might get

  code string

  Possible values: [invalid_authentication, permission_denied, not_valid, system_error]

  Error code

  message string

  Error message

  data object

  Did not pass validation parameters. Can be represented as an object, which can include field names, arrays, query parameters etc.

  param string

  Describes the parameter that did not pass a validation

{
  "error": {
    "code": "not_valid",
    "message": "Data validation error",
    "data": {
      "param": "must be an string"
    }
  }
}

{
  "error": {
    "code": "invalid_authentication",
    "message": "Log In"
  }
}

This function is only available with Wi-Fi module

Loading...