API Reference

Extend an ephemeral rule from now

Enabled per organisation

This endpoint answers 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.
POST
/rules/{ref}/bump

Resets the expiry to now + ttl. Without a body the lease's own ttl is used; with one, that ttl also becomes the new default for later bumps.

Authorization

BearerAuth firewall.manage
AuthorizationBearer <token>

Your organisation API key: Authorization: Bearer tbk_...

In: header

Scope: firewall.manage

Path Parameters

ref*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/rules/filter:mcje:207.174.40.5:25565/bump" \  -H "Content-Type: application/json" \  -d '{}'
{  "data": {    "ref": "string",    "tenant": "string",    "ttl": 0,    "expires_at": "string",    "created_at": "string",    "rule": {      "kind": "ip",      "destination": {        "ip": "207.174.40.5",        "port": 27015      },      "source": {        "ip": "0.0.0.0",        "port": 0      },      "protocol": "any",      "action": "deny",      "ref": "string",      "id": 0,      "expires_at": "string"    }  }}