Skip to content

Commit e11544d

Browse files
authored
Add Shodan sensor docs (home-assistant#3156)
1 parent 5461867 commit e11544d

File tree

2 files changed

+36
-0
lines changed

2 files changed

+36
-0
lines changed
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
layout: page
3+
title: "Shodan Sensor"
4+
description: "Instructions how to integrate Shodan sensors into Home Assistant."
5+
date: 2017-08-09 10:30
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
ha_category: Sensor
11+
ha_iot_class: "Cloud Polling"
12+
logo: shodan.png
13+
ha_release: 0.51
14+
---
15+
16+
17+
The `shodan` sensor platform is displaying the total of result of a [Shodan](https://pi-hole.net/) query.
18+
19+
Use "Show API Key" in the upper right corner when you are logged in or got to your "My Account" page to retrieve your API key.
20+
21+
To enable this sensor, add the following lines to your `configuration.yaml` file for a GET request:
22+
23+
```yaml
24+
# Example configuration.yaml entry
25+
sensor:
26+
- platform: shodan
27+
api_key: SHODAN_API_KEY
28+
query: 'home-assistant'
29+
```
30+
31+
Configuration variables:
32+
33+
- **api_key** (*Required*): The API key for Shodan.io.
34+
- **query** (*Required*): The search string.
35+
- **name** (*Optional*): Name of the Shodan sensor.
36+
11.7 KB
Loading

0 commit comments

Comments
 (0)