Skip to content
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

Refresh automation library documentation #1611

Merged
merged 1 commit into from
Feb 5, 2024
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
38 changes: 38 additions & 0 deletions _shared_content/automate/library/ipinfo.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# IPInfo

![IPInfo](/assets/playbooks/library/ipinfo.png){ align=right width=150 }

[IPINFO.IO](https://ipinfo.io//) is a database that gives access to daily updates for IP to country and IP to ASN

## Configuration

| Name | Type | Description |
| --------- | ------- | --------------------------- |
| `api_token` | `string` | ipinfo.io token |

## Triggers

### Fetch ipinfo.io database

Upload the ipinfo.io database regularly in json format

**Arguments**

| Name | Type | Description |
| --------- | ------- | --------------------------- |
| `interval` | `integer` | Interval in hours to wait between each trigger call. Defaults to 24. |
| `chunk_size` | `integer` | Number of items to include in each chunk. Defaults to 10 000. |


**Outputs**

| Name | Type | Description |
| --------- | ------- | --------------------------- |
| `file_path` | `string` | File path of the generated observables |
| `chunk_offset` | `integer` | Offset of the chunk in the full database |
| `chunk_size` | `integer` | Size of the chunk |


## Extra

Module **`IPInfo` v1.0**
Binary file added docs/assets/playbooks/library/ipinfo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -293,6 +293,7 @@ nav:
- HTTP: xdr/features/automate/library/http.md
- HarfangLab: xdr/features/automate/library/harfanglab.md
- IKnowWhatYouDownload: xdr/features/automate/library/iknowwhatyoudownload.md
- IPInfo: xdr/features/automate/library/ipinfo.md
- IPtoASN: xdr/features/automate/library/iptoasn.md
- Imperva: xdr/features/automate/library/imperva.md
- Jumpcloud Directory Insights: xdr/features/automate/library/jumpcloud-directory-insights.md
Expand Down Expand Up @@ -482,6 +483,7 @@ nav:
- HTTP: tip/features/automate/library/http.md
- HarfangLab: tip/features/automate/library/harfanglab.md
- IKnowWhatYouDownload: tip/features/automate/library/iknowwhatyoudownload.md
- IPInfo: tip/features/automate/library/ipinfo.md
- IPtoASN: tip/features/automate/library/iptoasn.md
- Imperva: tip/features/automate/library/imperva.md
- Jumpcloud Directory Insights: tip/features/automate/library/jumpcloud-directory-insights.md
Expand Down
Loading