Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Add Shodan sensor docs #3156

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 10, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions source/_components/sensor.shodan.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
layout: page
title: "Shodan Sensor"
description: "Instructions 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://pi-hole.net/) 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 for a GET request:

```yaml
# Example configuration.yaml entry
sensor:
- platform: shodan
api_key: SHODAN_API_KEY
query: 'home-assistant'
```

Configuration variables:

- **api_key** (*Required*): The API key for Shodan.io.
- **query** (*Required*): The search string.
- **name** (*Optional*): Name of the Shodan sensor.

Binary file added source/images/supported_brands/shodan.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.