POST
/api/v1/firewall/simulateSimulate a firewall policy change (impact preview)
Policy Impact Simulator: before changing a firewall policy / sensitivity dial, dry-run the change against a set of sample (or recent) traffic and report what WOULD change — which inputs become newly-blocked, which become newly-allowed, verdict deltas, and the aggregate net block delta. Pure compute over the firewall engine (no DB write); each sample is scanned under both the current and proposed policy. Caps: <=200 samples, each <=1 MiB.
Authentication
Send Authorization: Bearer YOUR_API_KEY on every request. Generate API keys at /dashboard/api-keys.
Request body required
Example
{
"samples": [],
"current": {
"forceBlockCategories": [
"string"
],
"rules": [
"string"
]
},
"proposed": {
"forceBlockCategories": [
"string"
],
"rules": [
"string"
]
},
"projectId": "00000000-0000-0000-0000-000000000000"
}Schema
{
"application/json": {
"schema": {
"type": "object",
"properties": {
"samples": {
"minItems": 1,
"maxItems": 200,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 1000000
},
{
"type": "object",
"properties": {
"input": {
"type": "string",
"minLength": 1,
"maxLength": 1000000
}
},
"required": [
"input"
],
"additionalProperties": false
}
]
},
"description": "Sample or recent traffic to evaluate (string or { input })."
},
"current": {
"type": "object",
"properties": {
"sensitivity": {
"anyOf": [
{
"type": "string",
"enum": [
"monitor",
"balanced",
"strict",
"lockdown"
]
},
{
"type": "integer",
"minimum": 1,
"maximum": 4
}
]
},
"forceBlockCategories": {
"maxItems": 20,
"type": "array",
"items": {
"type": "string",
"maxLength": 60
}
},
"rules": {
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"maxLength": 120
}
}
},
"additionalProperties": false
},
"proposed": {
"type": "object",
"properties": {
"sensitivity": {
"anyOf": [
{
"type": "string",
"enum": [
"monitor",
"balanced",
"strict",
"lockdown"
]
},
{
"type": "integer",
"minimum": 1,
"maximum": 4
}
]
},
"forceBlockCategories": {
"maxItems": 20,
"type": "array",
"items": {
"type": "string",
"maxLength": 60
}
},
"rules": {
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"maxLength": 120
}
}
},
"additionalProperties": false
},
"projectId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Optional — used for org-scope resolution and telemetry only."
}
},
"required": [
"samples",
"proposed"
],
"additionalProperties": false
}
}
}Response
200 example
{
"success": true
}All status codes
200Per-sample verdict diff + aggregate impact summary.
400(no description)
401(no description)
429(no description)
Code samples
cURL
curl -X POST \
https://evalguard.ai/api/v1/firewall/simulate \
-H "Authorization: Bearer $EVALGUARD_API_KEY" \
-H "Content-Type: application/json" \
-d '{ "samples": [], "current": { "forceBlockCategories": [ "string" ], "rules": [ "string" ] }, "proposed": { "forceBlockCategories": [ "string" ], "rules": [ "string" ] }, "projectId": "00000000-0000-0000-0000-000000000000" }'TypeScript
import { EvalGuard } from "@evalguard/sdk";
const client = new EvalGuard({ apiKey: process.env.EVALGUARD_API_KEY });
const response = await client.request({
method: "POST",
path: "/api/v1/firewall/simulate",
body: {
"samples": [],
"current": {
"forceBlockCategories": [
"string"
],
"rules": [
"string"
]
},
"proposed": {
"forceBlockCategories": [
"string"
],
"rules": [
"string"
]
},
"projectId": "00000000-0000-0000-0000-000000000000"
},
});
console.log(response);Python
from evalguard import EvalGuard
import os
client = EvalGuard(api_key=os.environ["EVALGUARD_API_KEY"])
response = client.request(
method="POST",
path="/api/v1/firewall/simulate",
body={
"samples": [],
"current": {
"forceBlockCategories": [
"string"
],
"rules": [
"string"
]
},
"proposed": {
"forceBlockCategories": [
"string"
],
"rules": [
"string"
]
},
"projectId": "00000000-0000-0000-0000-000000000000"
},
)
print(response)Go
package main
import (
"context"
"fmt"
"net/http"
"os"
"strings"
)
func main() {
body := strings.NewReader(`{"samples":[],"current":{"forceBlockCategories":["string"],"rules":["string"]},"proposed":{"forceBlockCategories":["string"],"rules":["string"]},"projectId":"00000000-0000-0000-0000-000000000000"}`)
req, _ := http.NewRequestWithContext(context.Background(), "POST", "https://evalguard.ai/api/v1/firewall/simulate", body)
req.Header.Set("Authorization", "Bearer "+os.Getenv("EVALGUARD_API_KEY"))
req.Header.Set("Content-Type", "application/json")
resp, err := http.DefaultClient.Do(req)
if err != nil { panic(err) }
defer resp.Body.Close()
fmt.Println(resp.Status)
}Errors
400401429