Edit Aegister Threat Blocker configuration

cURL

curl --request PUT \
  --url https://app.aegister.com/api/v1/atb/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-Aegister-Token: <api-key>' \
  --data '
{
  "device_id": "<string>",
  "email": "[email protected]",
  "type": "series",
  "services": [
    "OneFirewall IPv4 Protection"
  ]
}
'

{
  "error": 0,
  "messages": "<array>",
  "data": {
    "id": 2,
    "organization": {
      "id": 123,
      "name": "<string>",
      "logo": "<string>"
    },
    "atb_key": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "series",
    "email": "[email protected]",
    "check": {
      "stat": {
        "vpn": 0.5,
        "dnsbl": 0.5,
        "iplist": 0.5,
        "datetime": "2023-11-07T05:31:56Z"
      },
      "status": 0.5,
      "web_stat": [
        {
          "datetime": "2023-11-07T05:31:56Z",
          "waf_protection": 1,
          "total_managed_requests": 1
        }
      ],
      "chart_stat": [
        {
          "bucket_start": 1,
          "bucket_end": 1,
          "total_requests": 1,
          "malicious_requests": 1
        }
      ]
    },
    "plugin": {
      "name": "checkpoint",
      "config": {}
    },
    "endpoint": "127.0.0.1",
    "privateIP": "127.0.0.1",
    "services": [
      "OneFirewall IPv4 Protection"
    ],
    "device_id": "<string>"
  }
}

PUT

api

atb

{id}

cURL

curl --request PUT \
  --url https://app.aegister.com/api/v1/atb/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-Aegister-Token: <api-key>' \
  --data '
{
  "device_id": "<string>",
  "email": "[email protected]",
  "type": "series",
  "services": [
    "OneFirewall IPv4 Protection"
  ]
}
'

{
  "error": 0,
  "messages": "<array>",
  "data": {
    "id": 2,
    "organization": {
      "id": 123,
      "name": "<string>",
      "logo": "<string>"
    },
    "atb_key": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "series",
    "email": "[email protected]",
    "check": {
      "stat": {
        "vpn": 0.5,
        "dnsbl": 0.5,
        "iplist": 0.5,
        "datetime": "2023-11-07T05:31:56Z"
      },
      "status": 0.5,
      "web_stat": [
        {
          "datetime": "2023-11-07T05:31:56Z",
          "waf_protection": 1,
          "total_managed_requests": 1
        }
      ],
      "chart_stat": [
        {
          "bucket_start": 1,
          "bucket_end": 1,
          "total_requests": 1,
          "malicious_requests": 1
        }
      ]
    },
    "plugin": {
      "name": "checkpoint",
      "config": {}
    },
    "endpoint": "127.0.0.1",
    "privateIP": "127.0.0.1",
    "services": [
      "OneFirewall IPv4 Protection"
    ],
    "device_id": "<string>"
  }
}

Authorizations

X-Aegister-Token

string

header

required

Path Parameters

integer

required

Body

device_id

string

Unique identifier associated with the installed device.

string<email>

Email address of the technical point of contact responsible for managing and overseeing the security aspects of your organization's devices. This email will be used for communication related to security alerts, updates, and important notifications.

type

enum<string>

The configuration of the deployment of your threat blocker.

Opzioni disponibili:

series,

parallel

services

enum<string>[]

Enabled services for this ATB

The enabled service.

Opzioni disponibili:

OneFirewall IPv4 Protection,

OneFirewall Domain Protection

Response

error

integer

Any value different from 0 indicates an error.
More details can be found in messages.

Intervallo richiesto: 0 <= x <= 0

messages

array

If error is 1, contains zero or more details on the error.

data

object

Mostra attributi figli

data.id

number

ATB unique identifier.

Intervallo richiesto: x >= 1

data.organization

object

Mostra attributi figli

data.organization.id

number

Unique identifier for the Organization.

data.organization.name

string

Organization common name.

data.organization.logo

string<uri>

Organization logo URL.

data.atb_key

string<uuid>

ATB generated uuid key. This key can be used for all Aegister Threat Blocker API calls interchangeably with id.

data.type

enum<string>

The configuration of the deployment of your threat blocker.

Opzioni disponibili:

series,

parallel

data.email

string<email>

data.check

object

Mostra attributi figli

data.check.stat

object

Mostra attributi figli

data.check.stat.vpn

number

If 1 indicates VPN service is Active.

Intervallo richiesto: 0 <= x <= 1

data.check.stat.dnsbl

number

If 1 indicates Agent Logs service is Active.

Intervallo richiesto: 0 <= x <= 1

data.check.stat.iplist

number

If 1 indicates IP List service is Active.

Intervallo richiesto: 0 <= x <= 1

data.check.stat.datetime

string<date-time>

Latest timestamp this stat object has been updated.

data.check.status

number

Indicates if all services are up and running.

Intervallo richiesto: 0 <= x <= 1

data.check.web_stat

object[]

Contains historic data about ATB.
Resolution is one Hour.

Mostra attributi figli

data.check.web_stat.datetime

string<date-time>

data.check.web_stat.waf_protection

number

Total blocked requests in the time elapsed from this object datetime and the one immediately before.

Intervallo richiesto: x >= 0

data.check.web_stat.total_managed_requests

number

Total requests in the time elapsed from this object datetime and the one immediately before.

Intervallo richiesto: x >= 0

data.check.chart_stat

object[]

Aggregated live traffic stats grouped into a maximum of 10 time buckets.

Maximum array length: 11

Mostra attributi figli

data.check.chart_stat.bucket_start

number

required

UNIX timestamp for the beginning of the bucket interval.

Intervallo richiesto: x >= 0

data.check.chart_stat.bucket_end

number

required

UNIX timestamp for the end of the bucket interval.

Intervallo richiesto: x >= 0

data.check.chart_stat.total_requests

number

required

Total number of log messages in this interval.

Intervallo richiesto: x >= 0

data.check.chart_stat.malicious_requests

number

required

Number of malicious log messages in this interval.

Intervallo richiesto: x >= 0

data.plugin

object

Specific extra configuration for the ATB.

Mostra attributi figli

data.plugin.name

enum<string>

Configuration type.

Opzioni disponibili:

checkpoint,

fortigate,

sophos,

cisco_asa,

pfsense,

sonicwall

data.plugin.config

object

JSON specific configuration for the ATB.

data.endpoint

string<ipv4>

Endpoint for the ATB. This is set automatically at every scheduled update from the ATB.

data.privateIP

string<ipv4>

Private network IP for the ATB. This is set automatically at every scheduled update from the ATB.

data.services

enum<string>[]

Enabled services for this ATB

The enabled service.

Opzioni disponibili:

OneFirewall IPv4 Protection,

OneFirewall Domain Protection

data.device_id

string

Unique identifier associated with the installed device.

Create ATB Delete ATB

⌘I

API Documentation

Endpoints

Edit Aegister Threat Blocker configuration

Authorizations

Path Parameters

Body

Response