# Documentation

## Retrieve your server whitelisted or Blacklisted IPs amount

<mark style="color:blue;">`GET`</mark> `https://cyberdevelopment.es/BotSentry/publicapi/?apikey={key}&ip={ipport}&action={action}`

This endpoint retrieves you your whitelisted or Blacklisted IPs amount. Read Setup in case you don't know how to get some parameters.

#### Path Parameters

| Name   | Type   | Description                                                             |
| ------ | ------ | ----------------------------------------------------------------------- |
| action | string | The action you want to do, in this case, "getwlnumber" or "getblnumber" |
| ip     | string | Your server IP Port                                                     |
| apikey | string | Your server API Key                                                     |

{% tabs %}
{% tab title="200 The answer you will get when doing the request:" %}

```
{ 
    "amount" : "3729" 
}
```

{% endtab %}
{% endtabs %}

## Retrieve global whitelisted or Blacklisted IPs amount

<mark style="color:blue;">`GET`</mark> `https://cyberdevelopment.es/BotSentry/publicapi/?apikey={key}&ip={ipport}&action={action}`

This endpoint retrieves you the global whitelisted or Blacklisted IPs amount. Read Setup in case you dont know how to get some parameters.

#### Path Parameters

| Name   | Type   | Description                                                                |
| ------ | ------ | -------------------------------------------------------------------------- |
| action | string | The action you want to do, in this case "getglwlnumber" or "getglblnumber" |
| ip     | string | Your server IP Port                                                        |
| apikey | string | Your server API Key                                                        |

{% tabs %}
{% tab title="200 The answer you get when doing the request:" %}

```
{ 
    "amount" : "5688214" 
}
```

{% endtab %}
{% endtabs %}

## Retrieve the total Prevented Bots number in all servers

<mark style="color:blue;">`GET`</mark> `https://cyberdevelopment.es/BotSentry/publicapi/?apikey={key}&ip={ipport}&action={action}`

This endpoint retrieves you the global Prevented Bots number. Read Setup in case you dont know how to get some parameters

#### Path Parameters

| Name   | Type   | Description                                           |
| ------ | ------ | ----------------------------------------------------- |
| action | string | The action you want to do, in this case "getpbnumber" |
| ip     | string | Your server IP Port                                   |
| apikey | string | Your server API Key                                   |

{% tabs %}
{% tab title="200 The answer you get when doing the request:" %}

```
{
    "amount":"6499882"
}
```

{% endtab %}
{% endtabs %}

## Retrieve all attacks that your server received and their stats&#x20;

<mark style="color:blue;">`GET`</mark> `https://cyberdevelopment.es/BotSentry/publicapi/?apikey={key}&ip={ipport}&action={action}`

This endpoint retrieves you all the attacks you received in your server with the stats of each of them.

#### Path Parameters

| Name   | Type   | Description                                             |
| ------ | ------ | ------------------------------------------------------- |
| action | string | The action you want to do, in this case "getattackslog" |
| ip     | string | Your server IP Port                                     |
| apikey | string | Your server API Key                                     |

{% tabs %}
{% tab title="200 The answer you get when doing the request:" %}

```
[
    {
        "datetime":"2020-12-19 17:57:50",
        "blacklistedips":"118"
    },
    {
        "datetime":"2020-12-18 20:19:21",
        "blacklistedips":"193"
    },
    {
        "datetime":"2020-12-17 19:28:52",
        "blacklistedips":"585"
    }
]
```

{% endtab %}
{% endtabs %}

## Get an image with your server BotSentry statistics

<mark style="color:blue;">`GET`</mark> `https://cyberdevelopment.es/BotSentry/publicapi/?apikey={key}&ip={ipport}&action={action}`

This endpoint retrieves you an image with nearly all the stats about your server mentioned above.

#### Path Parameters

| Name   | Type   | Description                                        |
| ------ | ------ | -------------------------------------------------- |
| action | string | The action you want to do, in this case "getimage" |
| ip     | string | Your server IP Port                                |
| apikey | string | Your server API Key                                |

{% tabs %}
{% tab title="200 This endpoint returns you an image as .jpg format, you can see an example in the url: (It returns the  Image, not an Url!!)" %}

```
https://i.imgur.com/tAAPgIW.png
```

{% endtab %}
{% endtabs %}