Edit Aegister Threat Blocker configuration

Edit an Aegister Threat Blocker configuration in the Web Application.

You can edit only Aegister Threat Blocker configurations for organizations you can manage.

Authorizations

X-Aegister-Token

string

header

required

Path Parameters

id

integer

required

Body

device_id

string

Unique identifier associated with the installed device.

Example:

"ATBXXXXXXX"

email

string

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.

Available options:

series,

parallel

services

enum<string>[]

Enabled services for this ATB

The enabled service.

Available options:

OneFirewall IPv4 Protection,

OneFirewall Domain Protection

Response

200

application/json

error

integer

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

Required range: 0 <= x <= 0

Example:

0

messages

any[]

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

Example:

[]

data

object

Show child attributes

data.id

number

ATB unique identifier.

Required range: x >= 1

data.organization

object

Show child attributes

data.organization.id

number

Unique identifier for the Organization.

Example:

5

data.organization.name

string

Organization common name.

Example:

"Sample Organization"

data.organization.logo

string

Organization logo URL.

Example:

"https://sample.com/logo.svg"

data.atb_key

string

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.

Available options:

series,

parallel

data.email

string

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.

data.check

object

Show child attributes

data.check.stat

object

Show child attributes

data.check.stat.vpn

number

If 1 indicates VPN service is Active.

Required range: 0 <= x <= 1

Example:

1

data.check.stat.dnsbl

number

If 1 indicates Agent Logs service is Active.

Required range: 0 <= x <= 1

Example:

1

data.check.stat.iplist

number

If 1 indicates IP List service is Active.

Required range: 0 <= x <= 1

Example:

1

data.check.stat.datetime

string

Latest timestamp this stat object has been updated.

data.check.status

number

Indicates if all services are up and running.

Required range: 0 <= x <= 1

Example:

1

data.check.web_stat

object[]

Contains historic data about ATB.
Resolution is one Hour.

Show child attributes

data.check.web_stat.datetime

string

data.check.web_stat.waf_protection

number

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

Required range: x >= 0

Example:

50

data.check.web_stat.total_managed_requests

number

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

Required range: x >= 0

Example:

200

data.plugin

object

Specific extra configuration for the ATB.

Show child attributes

data.plugin.name

enum<string>

Configuration type.

Available options:

checkpoint,

fortigate,

sophos,

cisco_asa,

pfsense

data.plugin.config

object

JSON specific configuration for the ATB.

data.endpoint

string

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

Example:

"11.22.33.44"

data.privateIP

string

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

Example:

"192.168.1.2"

data.services

enum<string>[]

Enabled services for this ATB

The enabled service.

Available options:

OneFirewall IPv4 Protection,

OneFirewall Domain Protection

data.device_id

string

Unique identifier associated with the installed device.

Example:

"ATBXXXXXXX"