From 7b58205a38f2e726211301f3727edf1ad2e071d5 Mon Sep 17 00:00:00 2001 From: Robbie Trencheny Date: Mon, 9 May 2016 14:50:04 -0700 Subject: [PATCH] Add /api/discovery_info REST API docs --- source/developers/rest_api.markdown | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/source/developers/rest_api.markdown b/source/developers/rest_api.markdown index 3f2c4107953..91a99baa770 100644 --- a/source/developers/rest_api.markdown +++ b/source/developers/rest_api.markdown @@ -99,6 +99,24 @@ Sample `curl` command: $ curl -X GET -H "x-ha-access: YOUR_PASSWORD" http://localhost:8123/api/config ``` +#### {% linkable_title GET /api/discovery_info %} +Returns basic information about the Home Assistant instance as JSON. + +```json +{ + "base_url": "http://127.0.0.1:8123", + "location_name": "Home", + "requires_api_password": true, + "version": "0.20.0.dev0" +} +``` + +Sample `curl` command: + +```bash +$ curl -X GET -H "x-ha-access: YOUR_PASSWORD" http://localhost:8123/api/discovery_info +``` + #### {% linkable_title GET /api/bootstrap %} Returns all data needed to bootstrap Home Assistant.