mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-05-15 15:39:09 +00:00
1aca7b08cf
* e.g. to e.g., and proper case for Home Assistant * Instructions how to -> Instructions on how to
49 lines
1.0 KiB
Markdown
49 lines
1.0 KiB
Markdown
---
|
|
layout: page
|
|
title: "Shodan Sensor"
|
|
description: "Instructions on how to integrate Shodan sensors into Home Assistant."
|
|
date: 2017-08-09 10:30
|
|
sidebar: true
|
|
comments: false
|
|
sharing: true
|
|
footer: true
|
|
ha_category: Sensor
|
|
ha_iot_class: "Cloud Polling"
|
|
logo: shodan.png
|
|
ha_release: 0.51
|
|
---
|
|
|
|
|
|
The `shodan` sensor platform is displaying the total of result of a
|
|
[Shodan](https://www.shodan.io/) query.
|
|
|
|
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.
|
|
|
|
To enable this sensor, add the following lines to your `configuration.yaml`
|
|
file:
|
|
|
|
```yaml
|
|
# Example configuration.yaml entry
|
|
sensor:
|
|
- platform: shodan
|
|
api_key: SHODAN_API_KEY
|
|
query: 'home-assistant'
|
|
```
|
|
|
|
{% configuration %}
|
|
api_key:
|
|
description: The API key for Shodan.io.
|
|
required: true
|
|
type: string
|
|
query:
|
|
description: The search string.
|
|
required: true
|
|
type: string
|
|
name:
|
|
description: Name of the Shodan sensor.
|
|
required: false
|
|
type: string
|
|
{% endconfiguration %}
|
|
|