Apply a stateful filter
Enabled per organisation
403 until our staff enable the Firewall API flag on your organisation, and its ability cannot be granted to a key before then. Open a ticket saying what you intend to build — see Activation.Applies one filter to every port in the expression.
A stateful filter re-handshakes every connection through it, so applying one may disconnect active clients until they reconnect. Prefer a maintenance window on a live game address.
An unknown slug and one that exists but is out of scope for this address are answered identically, so the response does not disclose which filters exist but are withheld. Discover valid slugs from the available-filters endpoint.
Authorization
orgApiKey firewall.manageAn organisation API key, prefixed tbk_. Create one under
Organisation to API keys; the plaintext is shown once.
The scopes listed on each operation are the abilities the key must carry. They are not OAuth scopes and are not negotiated per request.
In: header
Scope: firewall.manage
Path Parameters
An address inside a prefix you announce, or one assigned to one of your
services. Anything else is a 404.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/firewall/ips/192.0.2.10/filters" \ -H "Content-Type: application/json" \ -d '{ "type": "string", "port": "25565" }'{ "data": { "type": "string", "created": 0 }, "message": "string"}