Skip to main content
POST
Add a DDoS filtering rule to 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.

protocol
enum<string>
required

The value of protocol.

Available options:
TCP,
UDP,
ICMP,
IPIP,
GRE,
ESP,
AH
presetId
string
required

The preset id ID.

minDstPort
integer | null

The value of min_dst_port.

Required range: 1 <= x <= 65535
maxDstPort
integer | null

The value of max_dst_port.

Required range: 1 <= x <= 65535
notes
string | null

Optional notes about the request.

Maximum string length: 255

Response

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

One filtering rule standing on an address.

id
string
required

The id ID.

Example:

"a45afea6-a83e-4685-b7d5-029d0a91e81e"

protocol
string
required

The value of protocol.

Example:

"TCP"

minDstPort
integer | null
required

The value of min_dst_port.

Example:

443

maxDstPort
integer | null
required

The value of max_dst_port.

Example:

443

preset
DdosProfilePresetData · object | null
required

The value of preset.

Example:
notes
string | null
required

Optional notes about the request.

Example:

"Black Mesa announcement system"

createdAt
string | null
required

The provider's own timestamps, in the provider's own format. Kept as strings and parsed where they are rendered: the provider does not promise anything this side could safely read as a date.

Example:

"2026-03-04T10:22:51Z"

updatedAt
string | null
required

The date and time for updated at, in UTC.

Example:

"2026-03-04T10:22:51Z"