Skip to content

Retrieve or reset address-translation rule hit counts

Request

Returns hit counts for address translation (NAT) rules, or resets counters for specific rules. Filter by tracker ID, network name, interface, or CIDR ranges.


Requires nodes::service:nat-hits or nodes::remote-execute permission.

Security
JWTAuthorizer
Path
nodeIDstringrequired

Node ID

Query
waitinteger

Pass 1 to block until the node responds and return its output.

Value:1
Bodyapplication/jsonrequired
actionstringrequired
  • GET — return hit counts
  • RESET — reset counters for matching rules
  • RESET_ALL — reset all counters
Enum:"GET""RESET""RESET_ALL"
trackerIDstring

Filter by specific tracker ID

networkNamestring

Filter by virtual network name

interfaceNamestring

Filter by interface name

insideCIDRstring

Filter by inside (local) CIDR

Example:"10.0.0.0/24"
outsideCIDRstring

Filter by outside (translated) CIDR

Example:"172.16.0.0/16"
networkGroupstring

Filter by network group name

curl -i -X POST \
  'https://apidocs.trustgrid.io/_mock/node/{nodeID}/trigger/nat-hits?wait=1' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "action": "GET",
    "trackerID": "string",
    "networkName": "string",
    "interfaceName": "string",
    "insideCIDR": "10.0.0.0/24",
    "outsideCIDR": "172.16.0.0/16",
    "networkGroup": "string"
  }'

Responses

OK

Bodyapplication/json
property name*anyadditional property
Response
{}