PUT
/
api
/
v1
/
atb
/
{id}
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": "ATBXXXXXXX",
  "email": "jsmith@example.com",
  "type": "series",
  "services": [
    "OneFirewall IPv4 Protection"
  ]
}'
{
  "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

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