Skip to main content
POST
Update DDoS filtering settings for an IP address

Authorizations

Authorization
string
header
required

Your API key, sent as a bearer token. Create one in the control panel under API Keys, give it only the permissions the integration needs, and copy it when it is created. It cannot be shown again. Each key is restricted to one owned team. The key determines the team for every request.

Path Parameters

server
string
required

The server UUID

Example:

"ecc6f4f1"

ip
string
required

The ip ID.

Example:

"203.0.113.24"

Body

application/json

Send a JSON object containing the fields below. Required fields are marked in the schema.

symmetrical
boolean | null

The value of symmetrical.

symmetricalBasic
boolean | null

The value of symmetrical_basic.

allowEgress
boolean | null

The value of allow_egress.

attackDuration
integer | null

The value of attack_duration.

defaultAction
enum<string> | null

The value of default_action.

Available options:
FILTER,
DROP,
ACCEPT,
null
discovery
boolean | null

The value of discovery.

Response

The record, as a JSON object. There is no envelope.

How one address is filtered when no rule matches.

symmetrical
boolean
required

The value of symmetrical.

Example:

true

symmetricalBasic
boolean
required

The value of symmetrical_basic.

Example:

false

allowEgress
boolean
required

The value of allow_egress.

Example:

true

attackDuration
integer
required

How long, in minutes, an attack is considered ongoing.

Example:

30

defaultAction
string
required

What happens to traffic no rule matched, FILTER or DROP.

Example:

"FILTER"

discovery
boolean
required

The value of discovery.

Example:

true

autoMitigation
boolean | null
required

The value of auto_mitigation.

Example:

true