Skip to content
Dusty Greif edited this page Jan 17, 2020 · 1 revision

Ring is constantly releasing new products, and it is difficult to get a hold of each and every device that they now support. In order to make it easier to add new devices, I have created a cli tool which users can run against their Ring account to get a glimpse of the data structure for all of their devices. This tool automatically strips out sensitive data, such as the users email, location, and device ids. While I have tried to remove all sensitive fields, I can't guarantee that new fields won't be added later, so I strongly suggest you double check the output from the tool before posting it publiclically on the internet. And please do not upload your email/password which are in the command line above the output.

If you have homebridge-ring or ring-client-api installed globally

  • Simply run ring-device-data-cli from a terminal. It should be available globally via your npm bin directory.

If you do not have homebridge-ring or ring-client-api installed globally

  • npx -p ring-client-api ring-device-data-cli

After running the cli and entering your login information, you will see a large chunk of json printed to your console. Please copy this whole block and paste it in the related GitHub issue or other discussion channel. Before posting, you are encouraged to double check the data for any personal information. You can run the data through a json prettifier online to make it easier to read if you like, but please post the original data (non-prettified) to keep the post as small as possible. Again, please do not upload your email/password which are in the command line above the output.