Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/turbot/flowpipe-mod-abuseipdb

AbuseIPDB pipeline library for the Flowpipe cloud scripting engine. Automation and workflows to connect AbuseIPDB to the people, systems and data that matters.
https://github.com/turbot/flowpipe-mod-abuseipdb

abuseipdb abuseipdb-api automation cloud devops flowpipe flowpipe-mod integrations low-code orchestration pipelines security workflow workflow-automation workflow-engine

Last synced: about 1 month ago
JSON representation

AbuseIPDB pipeline library for the Flowpipe cloud scripting engine. Automation and workflows to connect AbuseIPDB to the people, systems and data that matters.

Awesome Lists containing this project

README

        

# AbuseIPDB Library Mod for Flowpipe

AbuseIPDB pipeline library for [Flowpipe](https://flowpipe.io) enabling seamless integration of AbuseIPDB services into your workflows.

## Documentation

- **[Pipelines →](https://hub.flowpipe.io/mods/turbot/abuseipdb/pipelines)**

## Getting started

### Installation

Download and install Flowpipe (https://flowpipe.io/downloads). Or use Brew:

```sh
brew tap turbot/tap
brew install flowpipe
```

### Credentials

By default, the following environment variables will be used for authentication:

- `ABUSEIPDB_API_KEY`

You can also create `credential` resources in configuration files:

```sh
vi ~/.flowpipe/config/abuseipdb.fpc
```

```hcl
credential "abuseipdb" "abuseipdb_api_key" {
api_key = "bfc6f1c42dsfsdfdxxxx26977977b2xxxsfsdda98f313c3d389126de0d"
}
```

For more information on credentials in Flowpipe, please see [Managing Credentials](https://flowpipe.io/docs/run/credentials).

### Usage

[Initialize a mod](https://flowpipe.io/docs/build/index#initializing-a-mod):

```sh
mkdir my_mod
cd my_mod
flowpipe mod init
```

[Install the AbuseIPDB mod](https://flowpipe.io/docs/build/mod-dependencies#mod-dependencies) as a dependency:

```sh
flowpipe mod install github.com/turbot/flowpipe-mod-abuseipdb
```

[Use the dependency](https://flowpipe.io/docs/build/write-pipelines/index) in a pipeline step:

```sh
vi my_pipeline.fp
```

```hcl
pipeline "my_pipeline" {

step "pipeline" "check_ip_address" {
pipeline = abuseipdb.pipeline.check_ip_address
args = {
ip_address = "76.76.21.21"
}
}
}
```

[Run the pipeline](https://flowpipe.io/docs/run/pipelines):

```sh
flowpipe pipeline run my_pipeline
```

### Developing

Clone:

```sh
git clone https://github.com/turbot/flowpipe-mod-abuseipdb.git
cd flowpipe-mod-abuseipdb
```

List pipelines:

```sh
flowpipe pipeline list
```

Run a pipeline:

```sh
flowpipe pipeline run check_ip_address --arg ip_address='76.76.21.21'
```

To use a specific `credential`, specify the `cred` pipeline argument:

```sh
flowpipe pipeline run check_ip_address --arg ip_address='76.76.21.21' --arg cred=abuseipdb_profile
```

## Open Source & Contributing

This repository is published under the [Apache 2.0 license](https://www.apache.org/licenses/LICENSE-2.0). Please see our [code of conduct](https://github.com/turbot/.github/blob/main/CODE_OF_CONDUCT.md). We look forward to collaborating with you!

[Flowpipe](https://flowpipe.io) is a product produced from this open source software, exclusively by [Turbot HQ, Inc](https://turbot.com). It is distributed under our commercial terms. Others are allowed to make their own distribution of the software, but cannot use any of the Turbot trademarks, cloud services, etc. You can learn more in our [Open Source FAQ](https://turbot.com/open-source).

## Get Involved

**[Join #flowpipe on Slack →](https://flowpipe.io/community/join)**

Want to help but not sure where to start? Pick up one of the `help wanted` issues:

- [Flowpipe](https://github.com/turbot/flowpipe/labels/help%20wanted)
- [AbuseIPDB Mod](https://github.com/turbot/flowpipe-mod-abuseipdb/labels/help%20wanted)