Skip to main content
GET
/
api
/
v1
/
atb
cURL
curl --request GET \
  --url https://app.aegister.com/api/v1/atb \
  --header 'X-Aegister-Token: <api-key>'
{
  "error": 0,
  "messages": "<array>",
  "total": 1,
  "data": [
    {
      "id": 2,
      "organization": {
        "id": 123,
        "name": "<string>",
        "logo": "<string>"
      },
      "atb_key": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "series",
      "email": "jsmith@example.com",
      "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

Query Parameters

​
limit
number
default:50

Max number of reponse items.

​
offset
number
default:0

Offset response items.

​
order
string

Order results by item field

​
organization
number

Filter by Organization ID

​
services
string[]

Filter by Service

Response

​
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
array

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

Example:
[]
​
total
number

Total number of items that meet the list filter.
This doesn't represent the number of items inside the data array.

Required range: x >= 0
Examples:

20

30

40

​
data
object[]