Get Aegister Threat Blocker configuration

Get an Aegister Threat Blocker configuration from the Web Application.

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

Authorizations

X-Aegister-Token

string

header

required

Path Parameters

id

integer

required

Response

200 - application/json

data

object

Show child attributes

data.atb_key

string

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

data.check

object

Show child attributes

data.check.stat

object

Show child attributes

data.check.stat.datetime

string

Latest timestamp this stat object has been updated.

data.check.stat.dnsbl

number

If 1 indicates Agent Logs service is Active.

Required range: 0 < x < 1

data.check.stat.iplist

number

If 1 indicates IP List service is Active.

Required range: 0 < x < 1

data.check.stat.vpn

number

If 1 indicates VPN service is Active.

Required range: 0 < x < 1

data.check.status

number

Indicates if all services are up and running.

Required range: 0 < x < 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.total_managed_requests

number

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

Required range: x > 0

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

data.device_id

string

Unique identifier associated with the installed device.

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.endpoint

string

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

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.

data.organization.logo

string

Organization logo URL.

data.organization.name

string

Organization common name.

data.plugin

object

Specific extra configuration for the ATB.

Show child attributes

data.plugin.config

object

JSON specific configuration for the ATB.

data.plugin.name

enum<string>

Configuration type.

Available options:

checkpoint,

fortigate,

sophos,

cisco_asa,

pfsense

data.privateIP

string

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

Available options:

OneFirewall IPv4 Protection,

OneFirewall Domain Protection

data.type

enum<string>

The configuration of the deployment of your threat blocker.

Available options:

series,

parallel

error

integer

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

Required range: 0 < x < 0

messages

any[]

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