Skip to content
PUT/api/v1/firewall/rules

Test rules against input

Evaluates the supplied rule set against an input string (and optional model/metadata field-routing context) and returns per-rule test results plus a summary action (block/allow/alert/pass).

Authentication

Send Authorization: Bearer YOUR_API_KEY on every request. Generate API keys at /dashboard/api-keys.

Request body required

Example

{
  "rules": [
    {
      "id": "string",
      "name": "string",
      "type": "string",
      "condition": {},
      "action": {},
      "priority": 0,
      "enabled": false,
      "description": "string",
      "tags": [
        "string"
      ],
      "regions": [
        "string"
      ]
    }
  ],
  "input": "string",
  "model": "<Optional — routes 'model' rules against >",
  "metadata": {}
}
Schema
{
  "application/json": {
    "schema": {
      "type": "object",
      "properties": {
        "rules": {
          "maxItems": 500,
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "maxLength": 200
              },
              "name": {
                "type": "string",
                "minLength": 1,
                "maxLength": 200
              },
              "type": {
                "type": "string",
                "minLength": 1,
                "maxLength": 60
              },
              "condition": {
                "type": "object",
                "additionalProperties": {}
              },
              "action": {
                "type": "object",
                "additionalProperties": {}
              },
              "priority": {
                "type": "integer",
                "minimum": 0,
                "maximum": 10000
              },
              "enabled": {
                "type": "boolean"
              },
              "description": {
                "type": "string",
                "maxLength": 2000
              },
              "tags": {
                "maxItems": 50,
                "type": "array",
                "items": {
                  "type": "string",
                  "maxLength": 60
                }
              },
              "regions": {
                "maxItems": 50,
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            },
            "required": [
              "name",
              "type",
              "condition",
              "action"
            ],
            "additionalProperties": false
          }
        },
        "input": {
          "type": "string",
          "minLength": 1,
          "maxLength": 1000000
        },
        "model": {
          "type": "string",
          "maxLength": 200,
          "description": "Optional — routes 'model' rules against this model id."
        },
        "metadata": {
          "type": "object",
          "additionalProperties": {
            "type": "string",
            "maxLength": 2000
          },
          "description": "Optional — routes 'metadata' rules against this bag."
        }
      },
      "required": [
        "rules",
        "input"
      ],
      "additionalProperties": false
    }
  }
}

Response

All status codes

200Test results with summary action (block/allow/alert/pass).

Code samples

cURL

curl -X PUT \
  https://evalguard.ai/api/v1/firewall/rules \
  -H "Authorization: Bearer $EVALGUARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "rules": [ { "id": "string", "name": "string", "type": "string", "condition": {}, "action": {}, "priority": 0, "enabled": false, "description": "string", "tags": [ "string" ], "regions": [ "string" ] } ], "input": "string", "model": "<Optional — routes 'model' rules against >", "metadata": {} }'

TypeScript

import { EvalGuard } from "@evalguard/sdk";

const client = new EvalGuard({ apiKey: process.env.EVALGUARD_API_KEY });

const response = await client.request({
  method: "PUT",
  path: "/api/v1/firewall/rules",
  body: {
    "rules": [
      {
        "id": "string",
        "name": "string",
        "type": "string",
        "condition": {},
        "action": {},
        "priority": 0,
        "enabled": false,
        "description": "string",
        "tags": [
          "string"
        ],
        "regions": [
          "string"
        ]
      }
    ],
    "input": "string",
    "model": "<Optional — routes 'model' rules against >",
    "metadata": {}
  },
});
console.log(response);

Python

from evalguard import EvalGuard
import os

client = EvalGuard(api_key=os.environ["EVALGUARD_API_KEY"])

response = client.request(
    method="PUT",
    path="/api/v1/firewall/rules",
    body={
    "rules": [
        {
            "id": "string",
            "name": "string",
            "type": "string",
            "condition": {},
            "action": {},
            "priority": 0,
            "enabled": False,
            "description": "string",
            "tags": [
                "string"
            ],
            "regions": [
                "string"
            ]
        }
    ],
    "input": "string",
    "model": "<Optional — routes 'model' rules against >",
    "metadata": {}
},
)
print(response)

Go

package main

import (
	"context"
	"fmt"
	"net/http"
	"os"
	"strings"
)

func main() {
	body := strings.NewReader(`{"rules":[{"id":"string","name":"string","type":"string","condition":{},"action":{},"priority":0,"enabled":false,"description":"string","tags":["string"],"regions":["string"]}],"input":"string","model":"<Optional — routes 'model' rules against >","metadata":{}}`)
	req, _ := http.NewRequestWithContext(context.Background(), "PUT", "https://evalguard.ai/api/v1/firewall/rules", 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)
}

Other Firewall endpoints