API Documentation
Endpoints
- Aegister Threat Blocker
- Cloud Defender
- Cyber Assurance
- Documents
- Notifications
- Organizations
- Perimeter Protection
- Search
- Assessments
- Log Analysis
- VPN
Delete Aegister Threat Blocker configuration
Soft delete an Aegister Threat Blocker configuration from the Web Application.
You can delete only Aegister Threat Blocker configurations for organizations you can manage.
curl --request DELETE \
--url https://app.aegister.com/api/v1/atb/{id} \
--header 'X-Aegister-Token: <api-key>'
{
"error": 0,
"messages": [],
"data": {
"id": 2,
"organization": {
"id": 5,
"name": "Sample Organization",
"logo": "https://sample.com/logo.svg"
},
"atb_key": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "series",
"email": "jsmith@example.com",
"check": {
"stat": {
"vpn": 1,
"dnsbl": 1,
"iplist": 1,
"datetime": "2023-11-07T05:31:56Z"
},
"status": 1,
"web_stat": [
{
"datetime": "2023-11-07T05:31:56Z",
"waf_protection": 50,
"total_managed_requests": 200
}
]
},
"plugin": {
"name": "checkpoint",
"config": {}
},
"endpoint": "11.22.33.44",
"privateIP": "192.168.1.2",
"services": [
"OneFirewall IPv4 Protection"
],
"device_id": "ATBXXXXXXX"
}
}
Authorizations
Path Parameters
Response
Any value different from 0 indicates an error.
More details can be found in messages
.
0 <= x <= 0
0
If error
is 1
, contains zero or more details on the error.
[]
ATB unique identifier.
x >= 1
ATB generated uuid key. This key can be used for all Aegister Threat Blocker API calls interchangeably with id
.
The configuration of the deployment of your threat blocker.
series
, parallel
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.
If 1
indicates VPN service is Active.
0 <= x <= 1
1
If 1
indicates Agent Logs service is Active.
0 <= x <= 1
1
If 1
indicates IP List service is Active.
0 <= x <= 1
1
Latest timestamp this stat
object has been updated.
Indicates if all services are up and running.
0 <= x <= 1
1
Contains historic data about ATB.
Resolution is one Hour.
Total blocked requests in the time elapsed from this object datetime and the one immediately before.
x >= 0
50
Total requests in the time elapsed from this object datetime and the one immediately before.
x >= 0
200
Endpoint for the ATB. This is set automatically at every scheduled update from the ATB.
"11.22.33.44"
Private network IP for the ATB. This is set automatically at every scheduled update from the ATB.
"192.168.1.2"
Enabled services for this ATB
The enabled service.
OneFirewall IPv4 Protection
, OneFirewall Domain Protection
Unique identifier associated with the installed device.
"ATBXXXXXXX"
curl --request DELETE \
--url https://app.aegister.com/api/v1/atb/{id} \
--header 'X-Aegister-Token: <api-key>'
{
"error": 0,
"messages": [],
"data": {
"id": 2,
"organization": {
"id": 5,
"name": "Sample Organization",
"logo": "https://sample.com/logo.svg"
},
"atb_key": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "series",
"email": "jsmith@example.com",
"check": {
"stat": {
"vpn": 1,
"dnsbl": 1,
"iplist": 1,
"datetime": "2023-11-07T05:31:56Z"
},
"status": 1,
"web_stat": [
{
"datetime": "2023-11-07T05:31:56Z",
"waf_protection": 50,
"total_managed_requests": 200
}
]
},
"plugin": {
"name": "checkpoint",
"config": {}
},
"endpoint": "11.22.33.44",
"privateIP": "192.168.1.2",
"services": [
"OneFirewall IPv4 Protection"
],
"device_id": "ATBXXXXXXX"
}
}