Get Device WiFi SSID

deviceWifiSSID returns the current WiFi SSID to which a specific Bolt device is connected.
Useful for troubleshooting network issues, verifying device setup, or confirming whether a device is connected to the correct WiFi network.


Endpoint

https://cloud.boltiot.com/remote/{API_KEY}/deviceWifiSSID?deviceID={DEVICE_ID}

Replace {API_KEY} with your Bolt Cloud API key and {DEVICE_ID} with the unique ID of your Bolt device.

IMPORTANT : BOLT prefix is compulsory to be added

Response Format

The response is a JSON object with the following fields:

Field

Type

Description

value

object

Contains device ID and WiFi SSID

success

number

1 on success. 0 if request fails

Example:

Request

https://cloud.boltiot.com/remote/44b2de6b-7e68-40e7-a27f-814b58afe008/deviceWifiSSID?deviceID=BOLT12345

Response

{
"success": 1,
"value": {
"device_id": "BOLT12345",
"ssid": "OfficeWifi-2G"
}
}

Notes for Developers and Agents

  • Use this API to quickly confirm whether a device is online on the expected network.

  • This is particularly useful in:

    • Troubleshooting device offline issues

    • Checking customer device setup

    • Auditing devices in enterprise deployments

    • Always check success before reading the value.


Error Handling

If the API key is invalid or the request fails, success will be 0.

Example:

{
"success": 0
}

Recommendation: Check success before evaluating value.


Was this article helpful?
© 2025 Bolt IoT Documentation